Data::...::Email(3pm)

💌 NAME

Data::ICal::Entry::Alarm::Email — bestie, this is the class that represents an emailed alarm inside an iCalendar file 👑✨

---

🌸 SYNOPSIS

    my $valarm = Data::ICal::Entry::Alarm::Audio->new();
    $valarm->add_properties(
        attach => [ "basic:ftp://host.com/pub/sounds/bell-01.aud", { fmttype => "audio/basic" } ],
        # Dat*e*::ICal is not a typo here
        trigger   => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
    );

    $vevent->add_entry($valarm);

okay so yes, the Dat*e*::ICal thing looks like a crime but it is literally not a typo, that's just how it is 💅

---

🦋 DESCRIPTION

A Data::ICal::Entry::Alarm::Email object is the whole vibe of an emailed alarm — the kind that gets attached to a todo item or an event in an iCalendar file. (Quick lil heads up: the iCalendar RFC calls entries "components", so if you see that word floating around, it's the same thing, no cap.)

It is a subclass of Data::ICal::Entry::Alarm, and it accepts all of its methods. Inheriting everything? Iconic. Periodt.

Now for the mapping, because this part is lowkey the main character:

• the attendee properties are intended as the recipient list of the email 📧
• the summary is its subject
• the description is its body
• the attach is its attachments

---

✨ METHODS

🎀 new

Creates a shiny new Data::ICal::Entry::Alarm::Email object, and sets its ACTION property to EMAIL. That's it, that's the whole job, and it ate. 🫶

💖 mandatory_unique_properties

So beyond action and trigger (peep mandatory_unique_properties in Data::ICal::Entry::Alarm for the deets), emailed alarms must also specify a value for description and summary. Two extra must-haves. No skipping 👑

🌈 mandatory_repeatable_properties

Per the iCalendar standard, the attendee property must be specified at least once for an emailed alarm. One attendee minimum, bestie, you can't email nobody 💀

🧚 optional_repeatable_properties

Per the iCalendar standard, the attach property may be specified any number of times for an emailed alarm. Zero, one, twelve — go off, it's all fine 🌸

---

👑 AUTHOR

Best Practical Solutions, LLC <modules@bestpractical.com>

---

💜 LICENCE AND COPYRIGHT

Copyright (c) 2005 - 2020, Best Practical Solutions, LLC. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

---

and that's the whole page, babe — this was perl v5.36.0, dated 2022-10-14, filed under Data::...::Email(3pm) 💖 bye ily, go forth and alarm people via email 🦋