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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Synopsis

data PutEmailIdentityMailFromAttributes = PutEmailIdentityMailFromAttributes' {
- behaviorOnMxFailure :: Maybe BehaviorOnMxFailure
- mailFromDomain :: Maybe Text
- emailIdentity :: Text
}
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

behaviorOnMxFailure :: Maybe 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.
mailFromDomain :: Maybe Text
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.
emailIdentity :: Text
The verified email identity.

Instances

Instances details

ToJSON PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods toJSON :: PutEmailIdentityMailFromAttributes -> Value # toEncoding :: PutEmailIdentityMailFromAttributes -> Encoding # toJSONList :: [PutEmailIdentityMailFromAttributes] -> Value # toEncodingList :: [PutEmailIdentityMailFromAttributes] -> Encoding #
ToHeaders PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods toHeaders :: PutEmailIdentityMailFromAttributes -> [Header] #
ToPath PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods toPath :: PutEmailIdentityMailFromAttributes -> ByteString #
ToQuery PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods toQuery :: PutEmailIdentityMailFromAttributes -> QueryString #
AWSRequest PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Associated Types type AWSResponse PutEmailIdentityMailFromAttributes # Methods request :: (Service -> Service) -> PutEmailIdentityMailFromAttributes -> Request PutEmailIdentityMailFromAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutEmailIdentityMailFromAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEmailIdentityMailFromAttributes))) #
Generic PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Associated Types type Rep PutEmailIdentityMailFromAttributes :: Type -> Type # Methods from :: PutEmailIdentityMailFromAttributes -> Rep PutEmailIdentityMailFromAttributes x # to :: Rep PutEmailIdentityMailFromAttributes x -> PutEmailIdentityMailFromAttributes #
Read PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods readsPrec :: Int -> ReadS PutEmailIdentityMailFromAttributes # readList :: ReadS [PutEmailIdentityMailFromAttributes] # readPrec :: ReadPrec PutEmailIdentityMailFromAttributes # readListPrec :: ReadPrec [PutEmailIdentityMailFromAttributes] #
Show PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods showsPrec :: Int -> PutEmailIdentityMailFromAttributes -> ShowS # show :: PutEmailIdentityMailFromAttributes -> String # showList :: [PutEmailIdentityMailFromAttributes] -> ShowS #
NFData PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods rnf :: PutEmailIdentityMailFromAttributes -> () #
Eq PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods (==) :: PutEmailIdentityMailFromAttributes -> PutEmailIdentityMailFromAttributes -> Bool # (/=) :: PutEmailIdentityMailFromAttributes -> PutEmailIdentityMailFromAttributes -> Bool #
Hashable PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods hashWithSalt :: Int -> PutEmailIdentityMailFromAttributes -> Int # hash :: PutEmailIdentityMailFromAttributes -> Int #
type AWSResponse PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes type AWSResponse PutEmailIdentityMailFromAttributes = PutEmailIdentityMailFromAttributesResponse
type Rep PutEmailIdentityMailFromAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes type Rep PutEmailIdentityMailFromAttributes = D1 ('MetaData "PutEmailIdentityMailFromAttributes" "Amazonka.SESV2.PutEmailIdentityMailFromAttributes" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "PutEmailIdentityMailFromAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "behaviorOnMxFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BehaviorOnMxFailure)) :: (S1 ('MetaSel ('Just "mailFromDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "emailIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutEmailIdentityMailFromAttributes Source #

Arguments

:: Text	`$sel:emailIdentity:PutEmailIdentityMailFromAttributes'`
-> 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 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Associated Types type Rep PutEmailIdentityMailFromAttributesResponse :: Type -> Type # Methods from :: PutEmailIdentityMailFromAttributesResponse -> Rep PutEmailIdentityMailFromAttributesResponse x # to :: Rep PutEmailIdentityMailFromAttributesResponse x -> PutEmailIdentityMailFromAttributesResponse #
Read PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods readsPrec :: Int -> ReadS PutEmailIdentityMailFromAttributesResponse # readList :: ReadS [PutEmailIdentityMailFromAttributesResponse] # readPrec :: ReadPrec PutEmailIdentityMailFromAttributesResponse # readListPrec :: ReadPrec [PutEmailIdentityMailFromAttributesResponse] #
Show PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods showsPrec :: Int -> PutEmailIdentityMailFromAttributesResponse -> ShowS # show :: PutEmailIdentityMailFromAttributesResponse -> String # showList :: [PutEmailIdentityMailFromAttributesResponse] -> ShowS #
NFData PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods rnf :: PutEmailIdentityMailFromAttributesResponse -> () #
Eq PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes Methods (==) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool # (/=) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool #
type Rep PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityMailFromAttributes type Rep PutEmailIdentityMailFromAttributesResponse = D1 ('MetaData "PutEmailIdentityMailFromAttributesResponse" "Amazonka.SESV2.PutEmailIdentityMailFromAttributes" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "PutEmailIdentityMailFromAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutEmailIdentityMailFromAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutEmailIdentityMailFromAttributesResponse'`
-> 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.