logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Log::Handler::Output::Email - Log messages as email (via Net::SMTP).

Author

       Jonny Schulz <jschulz.cpan(at)bloonix.de>.

Description

       With this output module it's possible to log messages via email and it used Net::SMTP to do it. The date
       for the email is generated with "Email::Date::format_date".

       Net::SMTP is from Graham Barr and it does it's job very well.

Destroy

       "DESTROY" is defined and called "flush()".

Exports

       No exports.

Methods

new()
       Call "new()" to create a new Log::Handler::Output::Email object.

       The following opts are possible:

       host
           With this option you has to define the SMTP host to connect to.

               host => "mx.host.com"

               # or

               host => [ "mx.host.example", "mx.host-backup.example" ]

       hello
           Identify yourself with a HELO. The default is set to "EHLO BELO".

       timeout
           With this option you can set the maximum time in seconds to wait for a response from the SMTP server.
           The default is set to 120 seconds.

       from
           The sender address (MAIL FROM).

       to  The receipient address (RCPT TO).

           Additional options are cc and bcc.

       subject
           The subject of the mail.

           The default subject is "Log message from $progname".

       buffer
           This  opts  exists only for security. The thing is that it would be very bad if something wents wrong
           in your program and hundreds of mails would be send.  For this reason you can set a  buffer  to  take
           care.

           With the buffer you can set the maximum size of the buffer in lines. If you set

               buffer => 10

           then 10 messages would be buffered. Set "buffer" to 0 if you want to disable the buffer.

           The default buffer size is set to 20.

       debug
           With  this  option  it's  possible  to  enable  debugging.  The  information  can be intercepted with
           $SIG{__WARN__}.

   log()
       Call "log()" if you want to log a message as email.

       If you set a buffer size then the message will be pushed into the buffer first.

       Example:

           $email->log(message => "this message will be mailed");

       If you pass the level then its placed into the subject:

           $email->log(message => "foo", level => "INFO");
           $email->log(message => "bar", level => "ERROR");
           $email->log(message => "baz", level => "DEBUG");

       The lowest level is used:

           Subject: ERROR: ...

       You can pass the level with "Log::Handler" by setting

           message_pattern => '%L'

   flush()
       Call "flush()" if you want to flush the buffered lines.

   sendmail()
       Call "sendmail()" if you want to send an email.

       The difference to "log()" is that the message won't be buffered.

   validate()
       Validate a configuration.

   reload()
       Reload with a new configuration.

   errstr()
       This function returns the last error message.

Name

       Log::Handler::Output::Email - Log messages as email (via Net::SMTP).

Prerequisites

           Carp
           Email::Date
           Net::SMTP
           Params::Validate

Report Bugs

       Please report all bugs to <jschulz.cpan(at)bloonix.de>.

       If you send me a mail then add Log::Handler into the subject.

Synopsis

           use Log::Handler::Output::Email;

           my $email = Log::Handler::Output::Email->new(
               host     => "mx.bar.example",
               hello    => "EHLO my.domain.example",
               timeout  => 120,
               debug    => 0,
               from     => 'bar@foo.example',
               to       => 'foo@bar.example',
               subject  => "your subject",
               buffer   => 0
           );

           $email->log(message => $message);

See Also