| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SESV2.PutEmailIdentityMailFromAttributes
Description
Used to enable or disable the custom Mail-From domain configuration for an email identity.
Synopsis
- data PutEmailIdentityMailFromAttributes = PutEmailIdentityMailFromAttributes' {}
- newPutEmailIdentityMailFromAttributes :: Text -> PutEmailIdentityMailFromAttributes
- putEmailIdentityMailFromAttributes_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (Maybe BehaviorOnMxFailure)
- putEmailIdentityMailFromAttributes_mailFromDomain :: Lens' PutEmailIdentityMailFromAttributes (Maybe Text)
- putEmailIdentityMailFromAttributes_emailIdentity :: Lens' PutEmailIdentityMailFromAttributes Text
- data PutEmailIdentityMailFromAttributesResponse = PutEmailIdentityMailFromAttributesResponse' {
- httpStatus :: Int
- newPutEmailIdentityMailFromAttributesResponse :: Int -> PutEmailIdentityMailFromAttributesResponse
- putEmailIdentityMailFromAttributesResponse_httpStatus :: Lens' PutEmailIdentityMailFromAttributesResponse Int
Creating a Request
data PutEmailIdentityMailFromAttributes Source #
A request to configure the custom MAIL FROM domain for a verified identity.
See: newPutEmailIdentityMailFromAttributes smart constructor.
Constructors
| PutEmailIdentityMailFromAttributes' | |
Fields
| |
Instances
newPutEmailIdentityMailFromAttributes Source #
Arguments
| :: Text | |
| -> PutEmailIdentityMailFromAttributes |
Create a value of PutEmailIdentityMailFromAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEmailIdentityMailFromAttributes, putEmailIdentityMailFromAttributes_behaviorOnMxFailure - The action to take if the required MX record isn't found when you send
an email. When you set this value to UseDefaultValue, the mail is sent
using amazonses.com as the MAIL FROM domain. When you set this value
to RejectMessage, 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.
PutEmailIdentityMailFromAttributes, putEmailIdentityMailFromAttributes_mailFromDomain - The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must meet the following criteria:
- It has to be a subdomain of the verified identity.
- It can't be used to receive email.
- It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
$sel:emailIdentity:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_emailIdentity - The verified email identity.
Request Lenses
putEmailIdentityMailFromAttributes_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (Maybe BehaviorOnMxFailure) Source #
The action to take if the required MX record isn't found when you send
an email. When you set this value to UseDefaultValue, the mail is sent
using amazonses.com as the MAIL FROM domain. When you set this value
to RejectMessage, 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.
putEmailIdentityMailFromAttributes_mailFromDomain :: Lens' PutEmailIdentityMailFromAttributes (Maybe Text) Source #
The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
- It has to be a subdomain of the verified identity.
- It can't be used to receive email.
- It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
putEmailIdentityMailFromAttributes_emailIdentity :: Lens' PutEmailIdentityMailFromAttributes Text Source #
The verified email identity.
Destructuring the Response
data PutEmailIdentityMailFromAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutEmailIdentityMailFromAttributesResponse smart constructor.
Constructors
| PutEmailIdentityMailFromAttributesResponse' | |
Fields
| |
Instances
newPutEmailIdentityMailFromAttributesResponse Source #
Arguments
| :: Int | |
| -> PutEmailIdentityMailFromAttributesResponse |
Create a value of PutEmailIdentityMailFromAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutEmailIdentityMailFromAttributesResponse', putEmailIdentityMailFromAttributesResponse_httpStatus - The response's http status code.
Response Lenses
putEmailIdentityMailFromAttributesResponse_httpStatus :: Lens' PutEmailIdentityMailFromAttributesResponse Int Source #
The response's http status code.