Name

scheduleEmail — schedule a new alarm which sends an email.

Synopsis

bool scheduleEmail(const QString& fromID,
                   const QString& addresses,
                   const QString& subject,
                   const QString& message,
                   const QString& attachments,
                   const QString& startDateTime,
                   int lateCancel,
                   unsigned flags,
                   const QString& recurrence,
                   int subRepeatInterval, 
                   int subRepeatCount)
bool scheduleEmail(const QString& fromID,
                   const QString& addresses,
                   const QString& subject,
                   const QString& message,
                   const QString& attachments,
                   const QString& startDateTime,
                   int lateCancel,
                   unsigned flags,
                   int recurType,
                   int recurInterval,
                   int recurCount)
bool scheduleEmail(const QString& fromID,
                   const QString& addresses,
                   const QString& subject,
                   const QString& message,
                   const QString& attachments,
                   const QString& startDateTime,
                   int lateCancel, 
                   unsigned flags,
                   int recurType,
                   int recurInterval,
                   const QString& endTime)

Parameters

fromID

The KMail identity to use as the sender of the email. If empty, the sender's email address will be that configured in KAlarm's Email preferences.

addresses

A comma separated list of recipients' email addresses.

subject

Specifies the subject line of the email.

message

Specifies the email message body.

attachments

A comma-separated list of paths or URLs of files to send as email attachments.

startDateTime

Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format YYYY-MM-DD [TZ] (as returned by QDate::toString(Qt::ISODate)). For an alarm with a date and time, the string should be in the format YYYY-MM-DDTHH:MM[:SS] [TZ] (as returned by QDateTime::toString(Qt::ISODate)) or HH:MM[:SS] [Clock] (as returned by QTime::toString(Qt::ISODate)). If no date is specified, today's date is used. Note that any seconds value is ignored.

If no time zone is specified, the local system time zone is assumed. If a time zone specifier TZ is present, it may be the name of a system time zone (e.g. Europe/London), UTC representing the UTC time zone, or Clock to use the local computer clock and ignore time zones.

lateCancel

Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.

flags

Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class KAlarmIface in kalarmiface.h. Note that not all flag bits are applicable to email alarms.

recurrence

Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in RFC2445. For example, FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.

recurType

Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class KAlarmIface in kalarmiface.h. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the startDateTime parameter.

recurInterval

Specifies the number of periods (minutes/days/weeks/months/years as specified by recurType) between recurrences of the alarm.

recurCount

Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.

endDateTime

Specifies the end date, or date and time, for recurrences of the alarm. If startDateTime includes a time, this parameter must also include a time; if startDateTime contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for startDateTime is used to interpret this parameter's value.

subRepeatInterval

Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.

subRepeatCount

Specifies the number of sub-repetitions of the alarm, including the initial occurrence.

Description

scheduleEmail() is a D-Bus call to schedule the specified email for sending at the specified date and time. Apart from specifying the email header and contents and omitting the message color, font and audio file parameters, its usage is identical to scheduleMessage - see the description of that function for further details.