Log::Di...::Email(3)

💌 NAME

okay so bestie, welcome to Log::Di...::Email(3) — the User Contributed Perl Documentation page for Log::Dispatch::Email, aka the base class for objects that send log messages via email. it's giving foundation-class realness 💅

✨ VERSION

this one is version 2.71, slay.

🧚 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. literally the blueprint energy 👑

Implementing a subclass simply requires the code shown in the "SYNOPSIS" with a real implementation of the send_email() method. no cap, that's the whole vibe.

🎀 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, bestie, you gotta say who it's going to 💌
• from ($) — a string containing an email address. this is optional and may not work with all mail sending methods. lowkey conditional 🫶
• 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. batch-and-send energy ✨

💅 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'. so yeah, you're on deck for the real email-sending part 🎯

$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. like emptying the group chat drafts into an actual send button 🔥

$email->DESTROY

On destruction, the object will call flush() to send any pending email. not me making sure the last messages leave the building on the way out 💀

🫶 SUPPORT

Bugs may be submitted at <https://github.com/houseabsolute/Log-Dispatch/issues>. bring receipts, bestie 🐛

🦋 SOURCE

The source code repository for Log-Dispatch can be found at <https://github.com/houseabsolute/Log-Dispatch>. go peek, iykyk 👀

👑 AUTHOR

Dave Rolsky <autarch@urth.org> — iconic author behavior, fr fr.

🌈 COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 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. read it and respect it, periodt 📜

---

and that's the page, bestie! shoutout to perl v5.42.0 and the 2023-04-21 date on this one — mwah 💋💖