---
name: "Data::ICal::Entry::Alarm::Email"
section: "3pm"
platform: "linux"
package: "libdata-ical-perl"
version: "0.24+dfsg-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Data::ICal::Entry::Alarm::Email"
---

# Data::ICal::Entry::Alarm::Email(3pm)

Represents an emailed alarm in an iCalendar file

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