Log::Dispatch::Email - phpMan

NAME
    Log::Dispatch::Email - Base class for objects that send log messages via
    email

VERSION
    version 2.70

SYNOPSIS
      package Log::Dispatch::Email::MySender;

      use Log::Dispatch::Email;
      use base qw( Log::Dispatch::Email );

      sub send_email {
          my $self = shift;
          my %p    = @_;

          # Send email somehow. Message is in $p{message}
      }

DESCRIPTION
    This module should be used as a base class to implement Log::Dispatch::*
    objects that send their log messages via email. Implementing a subclass
    simply requires the code shown in the "SYNOPSIS" with a real
    implementation of the "send_email()" method.

CONSTRUCTOR
    The constructor takes the following parameters in addition to the
    standard parameters documented in Log::Dispatch::Output:

    *   subject ($)

        The subject of the email messages which are sent. Defaults to "$0:
        log email"

    *   to ($ or \@)

        Either a string or a list reference of strings containing email
        addresses. Required.

    *   from ($)

        A string containing an email address. This is optional and may not
        work with all mail sending methods.

    *   buffered (0 or 1)

        This determines whether the object sends one email per message it is
        given or whether it stores them up and sends them all at once. The
        default is to buffer messages.

METHODS
    This class provides the following methods:

  $email->send_email(%p)
    This is the method that must be subclassed. For now the only parameter
    in the hash is 'message'.

  $email->flush
    If the object is buffered, then this method will call the "send_email()"
    method to send the contents of the buffer and then clear the buffer.

  $email->DESTROY
    On destruction, the object will call "flush()" to send any pending
    email.

SUPPORT
    Bugs may be submitted at
    <https://github.com/houseabsolute/Log-Dispatch/issues>.

    I am also usually active on IRC as 'autarch' on "irc://irc.perl.org".

SOURCE
    The source code repository for Log-Dispatch can be found at
    <https://github.com/houseabsolute/Log-Dispatch>.

AUTHOR
    Dave Rolsky <autarch AT urth.org>

COPYRIGHT AND LICENSE
    This software is Copyright (c) 2020 by Dave Rolsky.

    This is free software, licensed under:

      The Artistic License 2.0 (GPL Compatible)

    The full text of the license can be found in the LICENSE file included
    with this distribution.