This class is used to hold the results of a pre-processed message. This is used to hold the results of processing a message, for example, rendering a template.

Hierarchy (view full)

Constructors

Properties

BCCRecipients?: string[]

Recipients to send a copy of the message to without revealing their email addresses to the other recipients, typically an email address

Body?: string

The body of the message, used if BodyTemplate is not provided.

BodyTemplate?: TemplateEntityExtended

Optional, when provided, Body is ignored and the template is used to render the message. In addition, if BodyTemplate is provided it will be used to render the Body and if the template has HTML content it will also be used to render the HTMLBody

CCRecipients?: string[]

Recipients to send a copy of the message to, typically an email address

ContextData?: any

Optional, any context data that is needed to render the message template

From: string

The sender of the message, typically an email address but can be anything that is provider-specific for example for a provider that is a social media provider, it might be a user's social media handle

FromName?: string

The name of the sender, typically the display name of the email address

HTMLBody?: string

The HTML body of the message

HTMLBodyTemplate?: TemplateEntityExtended

Optional, when provided, HTMLBody is ignored and the template is used to render the message. This OVERRIDES the BodyTemplate's HTML content even if BodyTemplate is provided. This allows for flexibility in that you can specify a completely different HTMLBodyTemplate and not just relay on the TemplateContent of the BodyTemplate having an HTML option.

Headers?: Record<string, string>

Optional, any headers to add to the message

The type of message to send

ProcessedBody: string

The body of the message after processing

ProcessedHTMLBody: string

The HTML body of the message after processing

ProcessedSubject: string

The subject of the message after processing

SendAt?: Date

The date and time to send the message, if not provided the message will be sent immediately

Subject?: string

The subject line for the message, used if SubjectTemplate is not provided and only supported by some providers

SubjectTemplate?: TemplateEntityExtended

Optional, when provided, Subject is ignored and the template is used to render the message

To: string

The recipient of the message, typically an email address but can be anything that is provider-specific for example for a provider that is a social media provider, it might be a user's social media handle

Methods

  • Parameters

    • Optional forceTemplateRefresh: boolean
    • Optional contextUser: UserInfo

    Returns Promise<{
        Message?: string;
        Success: boolean;
    }>