.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "Agent::Driver::Mail 3pm"
.TH Agent::Driver::Mail 3pm "2016-09-17" "perl v5.22.2" "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"
Log::Agent::Driver::Mail \- email driver for Log::Agent
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Log::Agent;
\& require Log::Agent::Driver::Mail;
\&
\& my $driver = Log::Agent::Driver::Mail\->make(
\&     \-to      => \*(Aqoncall@example.org\*(Aq,
\&     \-cc      => [ qw( noc@example.org admin@example,net ) ],
\&     \-subject => "ALERT! ALERT!",
\&     \-mailer  => [ \*(Aqsmtp\*(Aq, Server => \*(Aqmail.example.net\*(Aq ]
\& );
\& logconfig(\-driver => $driver);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This driver maps the \fIlogxxx()\fR calls to email messages.  Each call generates
a separate email message.  The Mail::Mailer module is required.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "\fBmake \s-1OPTIONS\s0\fP"
.IX Subsection "make OPTIONS"
The \s-1OPTIONS\s0 argument is a hash with the following keys:
.IP "\fB\-prefix\fR" 8
.IX Item "-prefix"
An optional prefix for the message body.
.IP "\fB\-to\fR" 8
.IX Item "-to"
The destination addresses, may be a scalar containing a valid email address
or a reference to an array of addresses.
.IP "\fB\-reply_to\fR" 8
.IX Item "-reply_to"
The reply-to addresses, may be a scalar containing a valid email address
or a reference to an array of addresses.
.IP "\fB\-from\fR" 8
.IX Item "-from"
The source address, must be a scalar containing a valid email address.
.IP "\fB\-subject\fR" 8
.IX Item "-subject"
The subject line of the email message.
.IP "\fB\-cc\fR" 8
.IX Item "-cc"
The carbon copy addresses, may be a scalar containing a valid email address
or a reference to an array of addresses.
.IP "\fB\-bcc\fR" 8
.IX Item "-bcc"
The blind carbon copy addresses, may be a scalar containing a valid email
address or a reference to an array of addresses.
.IP "\fB\-priority\fR" 8
.IX Item "-priority"
The priority level for the email message.  This is \s-1NOT\s0 related to the logging
priority.
.IP "\fB\-mailer\fR" 8
.IX Item "-mailer"
A reference to an array containing the optional arguments to
Mail::Mailer\->\fInew()\fR.  Generally, this can be omitted.
.SH "NOTES"
.IX Header "NOTES"
Thanks to Shirley Wang for the idea for this module.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mark Rogaski <mrogaski@pobox.com>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2002 Mark Rogaski; all rights reserved.
.PP
See \fILog::Agent\fR\|(3) or the \s-1README\s0 file included with the distribution for
license information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Mailer, \fILog::Agent::Driver\fR\|(3), \fILog::Agent\fR\|(3).