Email::...Sending(3)

💖 NAME 💖

okay so welcome to the Email::Sender::Role::CommonSending page from User Contributed Perl Documentation, bestie ✨

Email::Sender::Role::CommonSending — the common sending tasks most Email::Sender classes will need 🫶

---

🎀 VERSION 🎀

version 2.601 — noted, no cap 💅

---

✨ DESCRIPTION ✨

Email::Sender::Role::CommonSending gives you a bunch of features that should make writing new classes way easier when those classes are doing the Email::Sender role. Instead of writing a send method, implementors write a smaller send_email method, and that method gets passed an Email::Abstract object plus an envelope containing from and to entries. The to entry is guaranteed to be an array reference, periodt 🦋

A success method is also provided as a shortcut for calling:

Email::Sender::Success->new(...);

A few other minor details are handled by CommonSending; for more information, consult the source 👀

The methods documented here may be overridden to alter the behavior of the CommonSending role. So yes, you can customize the vibe 💜

---

🌈 PERL VERSION 🌈

This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. That's the whole tea ☕

---

💅 METHODS 💅

💌 prepare_email

This method is passed a scalar and is expected to return an Email::Abstract object. You probably shouldn't override it in most cases. Like, it's doing its thing, bestie 🧚

🍓 prepare_envelope

This method is passed a hashref and returns a new hashref that should be used as the envelope passed to the send_email method. This method is responsible for ensuring that the to entry is an array. Important little detail, iykyk 💫

👑 success

...
return $self->success;

This method returns a new Email::Sender::Success object. Arguments passed to this method are passed along to the Success's constructor. This is provided as a convenience for returning success from subclasses' send_email methods. It's giving helpful shortcut energy 🔥

---

🌸 AUTHOR 🌸

Ricardo Signes <cpan@semiotic.systems> — iconic behavior, honestly 🎀

---

🦋 COPYRIGHT AND LICENSE 🦋

This software is copyright (c) 2024 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

okay bye bestie 💖 this page came from perl v5.42.0, dated 2024-01-18, and it's the Email::...Sending(3) page — mwah! 🫶✨