Member Junction
    Preparing search index...
    Index

    Constructors

    Properties

    Body?: string

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

    BodyTemplate?: TemplateInputType

    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

    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

    HTMLBody?: string

    The HTML body of the message

    HTMLBodyTemplate?: TemplateInputType

    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.

    The type of message to send

    Subject?: string

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

    SubjectTemplate?: TemplateInputType

    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