.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail 3pm"
.TH Mail 3pm "2023-01-22" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Embperl::Mail \- Sends results from Embperl via E\-Mail
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Embperl::Mail ;
\&    
\& Embperl::Mail::Execute ({inputfile => \*(Aqtemplate.epl\*(Aq,
\&                                subject   => \*(AqTest Embperl::Mail::Execute\*(Aq,
\&                                to        => \*(Aqemail@foo.org\*(Aq}) ;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIEmbperl::Mail\fR uses \fIEmbperl\fR to process a page template and send
the result out via EMail. Currently only plain text mails are supported. A later 
version may add support for \s-1HTML\s0 mails. Because of that fact, normal \fIEmbperl\fR
\&\s-1HTML\s0 processing is disabled per Default (see options below).
.SS "Execute"
.IX Subsection "Execute"
The \f(CW\*(C`Execute\*(C'\fR function can handle all the parameter that \f(CW\*(C`Embperl::Execute\*(C'\fR
does. Addtionaly the following parameters are recognized:
.IP "from" 4
.IX Item "from"
gives the sender e\-mail address
.IP "to" 4
.IX Item "to"
gives the recipient address(es). Multiply addresses can either be separated by semikolon
or given as an array ref.
.IP "cc" 4
.IX Item "cc"
gives the recipient address(es) which should receive a carbon copy. Multiply addresses can
either be separated by semikolon
or given as an array ref.
.IP "bcc" 4
.IX Item "bcc"
gives the recipient address(es) which should receive a blind carbon copy. Multiply addresses can
either be separated by semikolon
or given as an array ref.
.IP "subject" 4
.IX Item "subject"
gives the subject line
.IP "reply-to" 4
.IX Item "reply-to"
the given address is insert as reply address
.IP "mailheaders" 4
.IX Item "mailheaders"
Array ref of additional mail headers
.IP "headerencoding (2.0b9+)" 4
.IX Item "headerencoding (2.0b9+)"
Tells Embperl::Mail which charset definition to include in any header
that contains character code 128\-255 and therefore needs encoding.
Defaults to iso\-8859\-1. Pass
empty string to turn encoding of header fields of.
.IP "mailhost" 4
.IX Item "mailhost"
Specifies which host to use as \s-1SMTP\s0 server.
Default is \fBlocalhost\fR.
.IP "mailhelo" 4
.IX Item "mailhelo"
Specifies which host/domain to use in the \s-1HELO/EHLO\s0 command.
A reasonable default is normally chosen by \fINet::SMTP\fR, but
depending on your installation it may necessary to set it
manualy.
.IP "maildebug" 4
.IX Item "maildebug"
Set to 1 to enable debugging of mail transfer.
.IP "options" 4
.IX Item "options"
If no \f(CW\*(C`options\*(C'\fR are given the following are used per default: 
\&\fBoptDisableHtmlScan\fR, \fBoptRawInput\fR, \fBoptKeepSpaces\fR, \fBoptReturnError\fR
.IP "escmode" 4
.IX Item "escmode"
In contrast to normal \fIEmbperl\fR escmode defaults to zero (no escape)
.IP "errors" 4
.IX Item "errors"
As in \f(CW\*(C`Embperl::Execute\*(C'\fR you can specify an array ref, which returns
all the error messages from template processing. If you don't specify 
this parameter \f(CW\*(C`Execute\*(C'\fR will die when an error occurs.
.SS "Configuration"
.IX Subsection "Configuration"
Some default values could be setup via environment variables.
.PP
\&\fB\s-1IMPORTANT:\s0\fR For now Embperl::Mail does \fBnot\fR honour the Embperl
configuration directives in your httpd.conf. Only values set via the
environment are accepted (e.g. via SetEnv or PerlSetEnv).
.SS "\s-1EMBPERL_MAILHOST\s0"
.IX Subsection "EMBPERL_MAILHOST"
Specifies which host to use as \s-1SMTP\s0 server.
Default is \fBlocalhost\fR.
.SS "\s-1EMBPERL_MAILHELO\s0"
.IX Subsection "EMBPERL_MAILHELO"
Specifies which host/domain to use in the \s-1HELO/EHLO\s0 command.
A reasonable default is normally chosen by \fINet::SMTP\fR, but
depending on your installation it may necessary to set it
manualy.
.SS "\s-1EMBPERL_MAILFROM\s0"
.IX Subsection "EMBPERL_MAILFROM"
Specifies which the email address that is used as sender.
Default is \fBwww\-server@server_name\fR.
.SS "\s-1EMBPERL_MAILDEBUG\s0"
.IX Subsection "EMBPERL_MAILDEBUG"
Debug setting for Net::SMTP. Default is 0.
.SH "Author"
.IX Header "Author"
G. Richter (richter at embperl dot org)
.SH "See Also"
.IX Header "See Also"
\&\fBperl\fR\|(1), Embperl, Net::SMTP