Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.PinpointEmail.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' {
- mailFromDomain :: Maybe Text
- behaviorOnMxFailure :: Maybe BehaviorOnMxFailure
- emailIdentity :: Text
}
newPutEmailIdentityMailFromAttributes :: Text -> PutEmailIdentityMailFromAttributes
putEmailIdentityMailFromAttributes_mailFromDomain :: Lens' PutEmailIdentityMailFromAttributes (Maybe Text)
putEmailIdentityMailFromAttributes_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (Maybe BehaviorOnMxFailure)
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

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.
behaviorOnMxFailure :: Maybe BehaviorOnMxFailure
The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.
emailIdentity :: Text
The verified email identity that you want to set up the custom MAIL FROM domain for.

Instances

Instances details

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

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:

$sel:mailFromDomain: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:behaviorOnMxFailure:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_behaviorOnMxFailure - The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

$sel:emailIdentity:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_emailIdentity - The verified email identity that you want to set up the custom MAIL FROM domain for.

Request Lenses

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_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (Maybe BehaviorOnMxFailure) Source #

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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_emailIdentity :: Lens' PutEmailIdentityMailFromAttributes Text Source #

The verified email identity that you want to set up the custom MAIL FROM domain for.

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

Eq PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes Methods (==) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool # (/=) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool #
Read PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes Methods readsPrec :: Int -> ReadS PutEmailIdentityMailFromAttributesResponse # readList :: ReadS [PutEmailIdentityMailFromAttributesResponse] # readPrec :: ReadPrec PutEmailIdentityMailFromAttributesResponse # readListPrec :: ReadPrec [PutEmailIdentityMailFromAttributesResponse] #
Show PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes Methods showsPrec :: Int -> PutEmailIdentityMailFromAttributesResponse -> ShowS # show :: PutEmailIdentityMailFromAttributesResponse -> String # showList :: [PutEmailIdentityMailFromAttributesResponse] -> ShowS #
Generic PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes Associated Types type Rep PutEmailIdentityMailFromAttributesResponse :: Type -> Type # Methods from :: PutEmailIdentityMailFromAttributesResponse -> Rep PutEmailIdentityMailFromAttributesResponse x # to :: Rep PutEmailIdentityMailFromAttributesResponse x -> PutEmailIdentityMailFromAttributesResponse #
NFData PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes Methods rnf :: PutEmailIdentityMailFromAttributesResponse -> () #
type Rep PutEmailIdentityMailFromAttributesResponse Source #
Instance details Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes type Rep PutEmailIdentityMailFromAttributesResponse = D1 ('MetaData "PutEmailIdentityMailFromAttributesResponse" "Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" '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.