Variable: diary-icalendar-export-alarms

diary-icalendar-export-alarms is a customizable variable defined in diary-icalendar.el.gz.

Value

nil

Documentation

Determine whether and how alarms are included in exported diary events.

If this variable is nil, no alarms are created during export. If it is non-nil, it should be a list of lists like:

((TYPE LEAD-TIME [OPTIONS]) ...)

In each inner list, the first element TYPE should be a symbol indicating an alarm type to generate: one of 'audio, 'display, or 'email. The second element LEAD-TIME should be an integer specifying the amount of time before the event, in minutes, when the alarm should be triggered. For audio alarms, there are currently no other OPTIONS.

For display and email alarms, the next OPTION is a format string for the displayed alarm, or the email subject line. In this string, "%t" will be replaced with LEAD-TIME and "%s" with the event's summary.

If TYPE is 'email, the next OPTION should be a list whose members specify the email addresses to which email alarms should be sent. These can either be email addresses (as strings), or the symbol
'from-entry, meaning that these addresses should be taken from the
exported diary entry (see diary-icalendar-address-regexp).

This variable was added, or its default value changed, in Emacs 31.1.

Source Code

;; Defined in /usr/src/emacs/lisp/calendar/diary-icalendar.el.gz
(defcustom di:export-alarms
  nil
  "Determine whether and how alarms are included in exported diary events.

If this variable is nil, no alarms are created during export.
If it is non-nil, it should be a list of lists like:

\((TYPE LEAD-TIME [OPTIONS]) ...)

In each inner list, the first element TYPE should be a symbol indicating
an alarm type to generate: one of \\='audio, \\='display, or \\='email.
The second element LEAD-TIME should be an integer specifying the amount
of time before the event, in minutes, when the alarm should be
triggered.  For audio alarms, there are currently no other
OPTIONS.

For display and email alarms, the next OPTION is a format string for the
displayed alarm, or the email subject line.  In this string, \"%t\" will
be replaced with LEAD-TIME and \"%s\" with the event's summary.

If TYPE is \\='email, the next OPTION should be a list whose members
specify the email addresses to which email alarms should be sent.  These
can either be email addresses (as strings), or the symbol
\\='from-entry, meaning that these addresses should be taken from the
exported diary entry (see `diary-icalendar-address-regexp')."
  :version "31.1"
  :type
  '(choice (const :tag "Do not include alarms when exporting diary entries" nil)
           (set :tag "Create alarms of these types"
                (list :tag "Audio alarms"
                      (const :tag "Options" audio)
                      (integer :tag "Advance time (in minutes)"
                               :value 10)
                      ;; TODO: specify an audio file to attach?
                      ;; TODO: other options we could have here and below:
                      ;; - whether alarm is before event start or end
                      ;; - repetitions and delays between repetitions
                      )
                (list :tag "Display alarms"
                      (const :tag "Options" display)
                      (integer :tag "Advance time (minutes)"
                               :value 10)
                      (string :tag "Display format"
                              :value "In %t minutes: %s")
                      ;; TODO: other options?
                      )
                (list :tag "Email alarms"
                      (const :tag "Options" email)
                      (integer :tag "Advance time (minutes)"
                               :value 10)
                      ;; TODO: other options?
                      (string :tag "Subject line format"
                              :value "In %t minutes: %s")
                      (set
                       :tag "Attendees"
                       (const :tag "Parse addresses from entry"
                              from-entry)
                       (repeat :tag "Other addresses"
                               (string :tag "Email address")))))))