.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Log::Handler::Output::Sendmail 3pm" .TH Log::Handler::Output::Sendmail 3pm "2020-07-14" "perl v5.30.3" "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::Handler::Output::Sendmail \- Log messages with sendmail. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Log::Handler::Output::Sendmail; \& \& my $email = Log::Handler::Output::Sendmail\->new( \& from => \*(Aqbar@foo.example\*(Aq, \& to => \*(Aqfoo@bar.example\*(Aq, \& subject => \*(Aqyour subject\*(Aq, \& ); \& \& $email\->log(message => $message); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" With this output module it's possible to log messages via \f(CW\*(C`sendmail\*(C'\fR. .SH "METHODS" .IX Header "METHODS" .SS "\fBnew()\fP" .IX Subsection "new()" Call \f(CW\*(C`new()\*(C'\fR to create a new Log::Handler::Output::Sendmail object. .PP The following options are possible: .IP "\fBfrom\fR" 4 .IX Item "from" The sender address (From). .IP "\fBto\fR" 4 .IX Item "to" The receipient address (To). .IP "\fBcc\fR" 4 .IX Item "cc" Carbon Copy (Cc). .IP "\fBbcc\fR" 4 .IX Item "bcc" Blind Carbon Copy (Bcc) .IP "\fBsubject\fR" 4 .IX Item "subject" The subject of the mail. .IP "\fBsender\fR" 4 .IX Item "sender" This option is identical with \f(CW\*(C`sendmail \-f\*(C'\fR. .IP "\fBheader\fR" 4 .IX Item "header" With this options it's possible to set your own header. .Sp .Vb 5 \& my $email = Log::Handler::Output::Sendmail\->new( \& from => \*(Aqbar@foo.example\*(Aq, \& to => \*(Aqfoo@bar.example\*(Aq, \& header => \*(AqContent\-Type: text/plain; charset= UTF\-8\*(Aq, \& ); .Ve .Sp Or .Sp .Vb 8 \& my $email = Log::Handler::Output::Sendmail\->new( \& header => { \& From => \*(Aqbar@foo.example\*(Aq, \& To => \*(Aqfoo@bar.example\*(Aq, \& Subject => \*(Aqmy subject\*(Aq, \& \*(AqContent\-Type\*(Aq => text/plain; charset= UTF\-8\*(Aq, \& } \& ); .Ve .Sp Or .Sp .Vb 8 \& my $email = Log::Handler::Output::Sendmail\->new( \& header => [ \& \*(AqFrom: bar@foo.example\*(Aq, \& \*(AqTo: foo@bar.example\*(Aq, \& \*(AqSubject: my subject\*(Aq, \& \*(AqContent\-Type: text/plain; charset= UTF\-8\*(Aq, \& ] \& ); .Ve .IP "\fBsendmail\fR" 4 .IX Item "sendmail" The default is set to \f(CW\*(C`/usr/sbin/sendmail\*(C'\fR. .IP "\fBparams\fR" 4 .IX Item "params" Parameters for \f(CW\*(C`sendmail\*(C'\fR. .Sp The default is set to \f(CW\*(C`\-t\*(C'\fR. .IP "\fBmaxsize\fR" 4 .IX Item "maxsize" Set the maximum size of the buffer in bytes. .Sp All messages will be buffered and if \f(CW\*(C`maxsize\*(C'\fR is exceeded the buffer is flushed and the messages will be send as email. .Sp The default is set to 1048576 bytes. .Sp Set 0 if you want no buffering and send a mail for each log message. .IP "\fBdebug\fR" 4 .IX Item "debug" Set 1 if you want to enable debugging. .Sp The messages can be fetched with \f(CW$SIG\fR{_\|_WARN_\|_}. .SS "\fBlog()\fP" .IX Subsection "log()" Call \f(CW\*(C`log()\*(C'\fR if you want to log a message as email. .PP .Vb 1 \& $email\->log(message => "this message will be mailed"); .Ve .PP If you pass the level then its placed into the subject: .PP .Vb 3 \& $email\->log(message => "foo", level => "INFO"); \& $email\->log(message => "bar", level => "ERROR"); \& $email\->log(message => "baz", level => "DEBUG"); .Ve .PP The lowest level is used: .PP .Vb 1 \& Subject: ERROR ... .Ve .PP You can pass the level with \f(CW\*(C`Log::Handler\*(C'\fR by setting .PP .Vb 1 \& message_pattern => \*(Aq%L\*(Aq .Ve .SS "\fBflush()\fP" .IX Subsection "flush()" Call \f(CW\*(C`flush()\*(C'\fR if you want to flush the buffered messages. .SS "\fBvalidate()\fP" .IX Subsection "validate()" Validate a configuration. .SS "\fBreload()\fP" .IX Subsection "reload()" Reload with a new configuration. .SS "\fBerrstr()\fP" .IX Subsection "errstr()" This function returns the last error message. .SH "DESTROY" .IX Header "DESTROY" \&\f(CW\*(C`DESTROY\*(C'\fR is defined and called \f(CW\*(C`flush()\*(C'\fR. .SH "PREREQUISITES" .IX Header "PREREQUISITES" .Vb 2 \& Carp \& Params::Validate .Ve .SH "EXPORTS" .IX Header "EXPORTS" No exports. .SH "REPORT BUGS" .IX Header "REPORT BUGS" Please report all bugs to . .PP If you send me a mail then add Log::Handler into the subject. .SH "AUTHOR" .IX Header "AUTHOR" Jonny Schulz . .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2007\-2009 by Jonny Schulz. All rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.