Interface AwsSesNodeParameters

Source
interface AwsSesNodeParameters {
    additionalFields?:
        | { configurationSetName?: string }
        | {
            bccAddresses?: string;
            ccAddresses?: string;
            configurationSetName?: string;
            replyToAddresses?: string;
            returnPath?: string;
            returnPathArn?: string;
            sourceArn?: string;
        }
        | { textPart?: string };
    body?: string;
    email?: string;
    failureRedirectionURL?: string;
    fromEmail?: string;
    fromEmailAddress?: string;
    htmlPart?: string;
    isBodyHtml?: boolean;
    limit?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "send"
        | "sendTemplate";
    resource?: | "template"
    | "email"
    | "customVerificationEmail";
    returnAll?: boolean;
    subject?: string;
    subjectPart?: string;
    successRedirectionURL?: string;
    templateContent?: string;
    templateDataUi?: {
        templateDataValues: {
            key?: string;
            value?: string;
        }[];
    };
    templateName?: string;
    templateSubject?: string;
    toAddresses?: string;
    updateFields?: | {
        failureRedirectionURL?: string;
        fromEmailAddress?: string;
        successRedirectionURL?: string;
        templateContent?: string;
        templateSubject?: string;
    }
    | {
        htmlPart?: string;
        subjectPart?: string;
        textPart?: string;
    };
}

Properties§

Source§

readonly additionalFields?:
    | { configurationSetName?: string }
    | {
        bccAddresses?: string;
        ccAddresses?: string;
        configurationSetName?: string;
        replyToAddresses?: string;
        returnPath?: string;
        returnPathArn?: string;
        sourceArn?: string;
    }
    | { textPart?: string }

Default: {}

Source§

readonly body?: string

The message to be sent

Source§

readonly email?: string

The email address to verify

Source§

readonly failureRedirectionURL?: string

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified

Source§

readonly fromEmail?: string

Email address of the sender

Source§

readonly fromEmailAddress?: string

The email address that the custom verification email is sent from

Source§

readonly htmlPart?: string

The HTML body of the email

Source§

readonly isBodyHtml?: boolean

Whether body is HTML or simple text

Source§

readonly limit?: number

Max number of results to return Default: 20 Type options: {"minValue":1}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "send"
    | "sendTemplate"

Default: "create"

Source§

readonly resource?: "template" | "email" | "customVerificationEmail"

Default: "email"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly subject?: string

Source§

readonly subjectPart?: string

The subject line of the email

Source§

readonly successRedirectionURL?: string

The URL that the recipient of the verification email is sent to if his or her address is successfully verified

Source§

readonly templateContent?: string

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML

Source§

readonly templateDataUi?: { templateDataValues: { key?: string; value?: string }[] }

Default: {} Type options: {"multipleValues":true}

Source§

readonly templateName?: string

The name of the custom verification email template

Source§

readonly templateSubject?: string

The subject line of the custom verification email

Source§

readonly toAddresses?: string

Email addresses of the recipients Default: [] Type options: {"multipleValues":true,"multipleValueButtonText":"Add To Email"}

Source§

readonly updateFields?:
    | {
        failureRedirectionURL?: string;
        fromEmailAddress?: string;
        successRedirectionURL?: string;
        templateContent?: string;
        templateSubject?: string;
    }
    | {
        htmlPart?: string;
        subjectPart?: string;
        textPart?: string;
    }

Default: {}