Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Data::ICal::Entry::AlaUserEContributed Perl Data::ICal::Entry::Alarm::Email(3)

NAME
       Data::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::Alarm	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".

   mandatory_unique_properties
       In addition to "action" and "trigger" (see
       "mandatory_unique_properties" in	Data::ICal::Entry::Alarm), emailed
       alarms must also	specify	a value	for "description" and "summary".

   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
       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.

perl v5.32.1			  2020-01-03Data::ICal::Entry::Alarm::Email(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | AUTHOR | LICENCE AND COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Data::ICal::Entry::Alarm::Email&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help