Data::ICal::Entry::Alarm::Email 0.16

Data::ICal::Entry::Alarm::Email is a Perl module that represents an emailed alarm in 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);

A Data::ICal::Entry::Alarm::Email object represents an emailed alarm attached to a todo item or event in an iCalendar file. (Note that the iCalendar RFC refers to entries as "components".) It is a subclass of Data::ICal::Entry and accepts all of its methods.
The attendee properties are intended as the recipient list of the email; the summary as its subject; the description as its body; and the attach as its attachments.

METHODS

new

Creates a new Data::ICal::Entry::Alarm::Email object; sets its ACTION property to EMAIL.

ical_entry_type

Returns VALARM, its iCalendar entry name.

optional_unique_properties

According to the iCalendar standard, the duration and retreat properties may be specified at most one time for an emailed alarm, and if one is specified, the other one must be also, though this module does not enforce that restriction.

mandatory_unique_properties

According to the iCalendar standard, the following properties must be specified exactly once for an emailed alarm:

description summary trigger

In addition, the action property must be specified exactly once, but the module automatically sets it for you.

mandatory_repeatable_properties

According to the iCalendar standard, the attendee property must be specified at least once for an emailed alarm.

optional_repeatable_properties

According to the iCalendar standard, the attach property may be specified any number of times for an emailed alarm.

Product's homepage

Requirements:

· Perl