@aws-sdk/client-sesv2

MailFromAttributes Interface

A list of attributes that are associated with a MAIL FROM domain.

Members

Name
Type
Details
BehaviorOnMxFailure RequiredBehaviorOnMxFailure | undefined

The action to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

MailFromDomain Requiredstring | undefined

The name of a domain that an email identity uses as a custom MAIL FROM domain.

MailFromDomainStatus RequiredMailFromDomainStatus | undefined

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon SES hasn't started searching for the MX record yet.

  • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

Full Signature

export interface MailFromAttributes