IGetScheduledMailOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Configuration options for getting scheduled mails.
export interface IGetScheduledMailOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) (Optional) List only subset of scheduled mails authored by current user. | ||
boolean | (ALPHA) (Optional) Specify if information about the users that created/modified the scheduled email should be loaded. |
Property details
IGetScheduledMailOptions.createdByCurrentUserpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
List only subset of scheduled mails authored by current user.
createdByCurrentUser?: boolean;
Remarks
Defaults to false.
IGetScheduledMailOptions.loadUserDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify if information about the users that created/modified the scheduled email should be loaded.
loadUserData?: boolean;
Remarks
Defaults to false.
If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.