1Data::ICal::Entry::AlarUms:e:rEmCaoinlt(r3i)buted Perl DDoactuam:e:nItCaatli:o:nEntry::Alarm::Email(3)
2
6 Data::ICal::Entry::Alarm::Email - Represents an emailed alarm in an
7 iCalendar file
8
10 my $valarm = Data::ICal::Entry::Alarm::Audio->new();
11 $valarm->add_properties(
12 attach => [ "basic:ftp://host.com/pub/sounds/bell-01.aud", { fmttype => "audio/basic" } ],
13 # Dat*e*::ICal is not a typo here
14 trigger => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
15 );
16 $vevent->add_entry($valarm);
18
20 A Data::ICal::Entry::Alarm::Email object represents an emailed alarm
21 attached to a todo item or event in an iCalendar file. (Note that the
22 iCalendar RFC refers to entries as "components".) It is a subclass of
23 Data::ICal::Entry and accepts all of its methods.
24 The "attendee" properties are intended as the recipient list of the
26 email; the "summary" as its subject; the "description" as its body; and
27 the "attach" as its attachments.
28
30 new
31 Creates a new Data::ICal::Entry::Alarm::Email object; sets its "ACTION"
32 property to "EMAIL".
33 ical_entry_type
35 Returns "VALARM", its iCalendar entry name.
36 optional_unique_properties
38 According to the iCalendar standard, the "duration" and "retreat"
39 properties may be specified at most one time for an emailed alarm, and
40 if one is specified, the other one must be also, though this module
41 does not enforce that restriction.
42 mandatory_unique_properties
44 According to the iCalendar standard, the following properties must be
45 specified exactly once for an emailed alarm:
46 description summary trigger
48 In addition, the "action" property must be specified exactly once, but
50 the module automatically sets it for you.
51 mandatory_repeatable_properties
53 According to the iCalendar standard, the "attendee" property must be
54 specified at least once for an emailed alarm.
55 optional_repeatable_properties
57 According to the iCalendar standard, the "attach" property may be
58 specified any number of times for an emailed alarm.
59
61 Jesse Vincent "<jesse@bestpractical.com>" with David Glasser, Simon
62 Wistow, and Alex Vandiver
63
65 Copyright (c) 2005 - 2009, Best Practical Solutions, LLC. All rights
66 reserved.
67 This module is free software; you can redistribute it and/or modify it
69 under the same terms as Perl itself. See perlartistic.
70
72 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
73 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
74 WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
75 PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
76 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
77 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
78 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
79 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
80 NECESSARY SERVICING, REPAIR, OR CORRECTION.
81 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
83 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
84 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
85 TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
86 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
87 SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
88 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
89 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
90 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
91 DAMAGES.
92perl v5.12.0 2009-07-10Data::ICal::Entry::Alarm::Email(3)