Class SES

constructor

• new SES(options?: { region?: string }): SES

  Parameters

  • options: { region?: string } = {}

  Returns SES

client

deleteTemplate

• deleteTemplate(templateName: string): Promise<void>

  Parameters

  • templateName: string

  Returns Promise<void>

getTemplate

• getTemplate(templateName: string): Promise<EmailTemplateContent>

  Parameters

  • templateName: string

  Returns Promise<EmailTemplateContent>

sendEmail

• sendEmail(emailData: EmailData, sesParams: SESParams): Promise<any>

  Send an email through AWS Simple Email Service. It supports IDEA's teams custom configuration.

  Parameters

  • emailData: EmailData
  • sesParams: SESParams

  Returns Promise<any>

sendTemplatedEmail

• sendTemplatedEmail(
      emailData: TemplatedEmailData,
      sesParams: SESParams,
  ): Promise<SendEmailCommandOutput>

  Send a templated email through AWS Simple Email Service.

  Parameters

  • emailData: TemplatedEmailData
  • sesParams: SESParams

  Returns Promise<SendEmailCommandOutput>

setTemplate

• setTemplate(
      templateName: string,
      subject: string,
      content: string,
      isHTML?: boolean,
  ): Promise<void>

  Parameters

  • templateName: string
  • subject: string
  • content: string
  • OptionalisHTML: boolean

  Returns Promise<void>

testTemplate

• testTemplate(
      templateName: string,
      data: { [variable: string]: any },
  ): Promise<string>

  Parameters

  • templateName: string
  • data: { [variable: string]: any }

  Returns Promise<string>