Data::ICal::Entry::AlaUserEContributed Perl Data::ICal::Entry::Alarm::Email(3)NAMEData::ICal::Entry::Alarm::Email - 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);
DESCRIPTION
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.
AUTHOR
Jesse Vincent "<jesse@bestpractical.com>" with David Glasser, Simon
Wistow, and Alex Vandiver
LICENCE AND COPYRIGHT
Copyright (c) 2005 - 2009, 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.
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.
perl v5.18.22009-07-10Data::ICal::Entry::Alarm::Email(3)