IScheduledMailBase
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Warning: This API is now obsolete.
- use IAutomationMetadataObjectBase instead
A scheduled email common properties
export interface IScheduledMailBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Email attachments | |||
string[] | (ALPHA) (Optional) BCC recipients email addresses | ||
string | (ALPHA) Email message body | ||
string | (ALPHA) Scheduled email description | ||
string | (ALPHA) (Optional) Date of the last successful email processing job run | ||
string | (ALPHA) Email subject | ||
string | (ALPHA) Scheduled email title | ||
string[] | (ALPHA) Recipients unique login identifiers - should be equal to login property in IWorkspaceUser / IUser | ||
boolean | (ALPHA) Is unlisted? | ||
string[] | (ALPHA) (Optional) Unsubscribed recipients email addresses | ||
{ startDate: string; endDate?: string; recurrence: string; timeZone: string; } | (ALPHA) Scheduled email job interval |
Property details
IScheduledMailBase.attachmentspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Email attachments
attachments: ScheduledMailAttachment[];
IScheduledMailBase.bccpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
BCC recipients email addresses
bcc?: string[];
IScheduledMailBase.bodypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Email message body
body: string;
IScheduledMailBase.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Scheduled email description
description: string;
IScheduledMailBase.lastSuccessfulpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Date of the last successful email processing job run
lastSuccessful?: string;
IScheduledMailBase.subjectpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Email subject
subject: string;
IScheduledMailBase.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Scheduled email title
title: string;
IScheduledMailBase.topropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Recipients unique login identifiers - should be equal to login property in IWorkspaceUser / IUser
to: string[];
IScheduledMailBase.unlistedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Is unlisted?
unlisted: boolean;
IScheduledMailBase.unsubscribedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Unsubscribed recipients email addresses
unsubscribed?: string[];
IScheduledMailBase.whenpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Scheduled email job interval
when: {
startDate: string;
endDate?: string;
recurrence: string;
timeZone: string;
};