.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Data::ICal::Entry::Alarm::Email 3pm"
.TH Data::ICal::Entry::Alarm::Email 3pm "2020-01-06" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Data::ICal::Entry::Alarm::Email \- Represents an emailed alarm in an iCalendar file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    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 => \*(AqDATE\-TIME\*(Aq } ],
\&    );
\&
\&    $vevent\->add_entry($valarm);
.Ve
.SH "DESCRIPTION"
.IX Header "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 \s-1RFC\s0 refers to entries as \*(L"components\*(R".)  It is a
subclass of Data::ICal::Entry::Alarm and accepts all of its methods.
.PP
The \f(CW\*(C`attendee\*(C'\fR properties are intended as the recipient list of the
email; the \f(CW\*(C`summary\*(C'\fR as its subject; the \f(CW\*(C`description\*(C'\fR as its body;
and the \f(CW\*(C`attach\*(C'\fR as its attachments.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Creates a new Data::ICal::Entry::Alarm::Email object; sets its
\&\f(CW\*(C`ACTION\*(C'\fR property to \f(CW\*(C`EMAIL\*(C'\fR.
.SS "mandatory_unique_properties"
.IX Subsection "mandatory_unique_properties"
In addition to \f(CW\*(C`action\*(C'\fR and \f(CW\*(C`trigger\*(C'\fR (see
\&\*(L"mandatory_unique_properties\*(R" in Data::ICal::Entry::Alarm), emailed alarms
must also specify a value for \f(CW\*(C`description\*(C'\fR and \f(CW\*(C`summary\*(C'\fR.
.SS "mandatory_repeatable_properties"
.IX Subsection "mandatory_repeatable_properties"
According to the iCalendar standard, the \f(CW\*(C`attendee\*(C'\fR property must be
specified at least once for an emailed alarm.
.SS "optional_repeatable_properties"
.IX Subsection "optional_repeatable_properties"
According to the iCalendar standard, the \f(CW\*(C`attach\*(C'\fR property may be
specified any number of times for an emailed alarm.
.SH "AUTHOR"
.IX Header "AUTHOR"
Best Practical Solutions, \s-1LLC\s0 <modules@bestpractical.com>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2005 \- 2020, Best Practical Solutions, \s-1LLC.\s0  All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.