1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
use warnings;
use strict;
package Data::ICal::Entry::Alarm::Email;
use base qw/Data::ICal::Entry/;
=head1 NAME
Data::ICal::Entry::Alarm::Email - Represents an emailed alarm in an iCalendar file
=head1 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);
=head1 DESCRIPTION
A L<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 L<Data::ICal::Entry>
and accepts all of its methods.
The C<attendee> properties are intended as the recipient list of the email; the C<summary>
as its subject; the C<description> as its body; and the C<attach> as its attachments.
=head1 METHODS
=cut
=head2 new
Creates a new L<Data::ICal::Entry::Alarm::Email> object; sets its C<ACTION> property
to C<EMAIL>.
=cut
sub new {
my $class = shift;
my $self = $class->SUPER::new(@_);
$self->add_property( action => "EMAIL" );
return $self;
}
=head2 ical_entry_type
Returns C<VALARM>, its iCalendar entry name.
=cut
sub ical_entry_type {'VALARM'}
=head2 optional_unique_properties
According to the iCalendar standard, the C<duration> and C<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.
=cut
sub optional_unique_properties {
qw(
duration repeat
);
}
=head2 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 C<action> property must be specified exactly once, but the
module automatically sets it for you.
=cut
sub mandatory_unique_properties {
qw(
action description summary trigger
);
}
=head2 mandatory_repeatable_properties
According to the iCalendar standard, the C<attendee> property must be specified
at least once for an emailed alarm.
=cut
sub mandatory_repeatable_properties {
qw(
attendee
);
}
=head2 optional_repeatable_properties
According to the iCalendar standard, the C<attach> property may be specified
any number of times for an emailed alarm.
=cut
sub optional_repeatable_properties {
qw(
attach
);
}
=head1 AUTHOR
Jesse Vincent C<< <jesse@bestpractical.com> >> with David Glasser and Simon Wistow
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2005, 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 L<perlartistic>.
=head1 DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
=cut
1;
|
