Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

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

Creating a Request

data PutEmailIdentityMailFromAttributes

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 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.

• 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 that you want to set up the custom MAIL FROM domain for.

Instances

ToJSON PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

toJSON :: PutEmailIdentityMailFromAttributes -> Value

toEncoding :: PutEmailIdentityMailFromAttributes -> Encoding

toJSONList :: [PutEmailIdentityMailFromAttributes] -> Value

toEncodingList :: [PutEmailIdentityMailFromAttributes] -> Encoding

ToHeaders PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

toHeaders :: PutEmailIdentityMailFromAttributes -> [Header]

ToPath PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

toPath :: PutEmailIdentityMailFromAttributes -> ByteString

ToQuery PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

toQuery :: PutEmailIdentityMailFromAttributes -> QueryString

AWSRequest PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.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

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Associated Types

type Rep PutEmailIdentityMailFromAttributes :: Type -> Type

Methods

from :: PutEmailIdentityMailFromAttributes -> Rep PutEmailIdentityMailFromAttributes x

to :: Rep PutEmailIdentityMailFromAttributes x -> PutEmailIdentityMailFromAttributes

Read PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

readsPrec :: Int -> ReadS PutEmailIdentityMailFromAttributes

readList :: ReadS [PutEmailIdentityMailFromAttributes]

readPrec :: ReadPrec PutEmailIdentityMailFromAttributes

readListPrec :: ReadPrec [PutEmailIdentityMailFromAttributes]

Show PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

showsPrec :: Int -> PutEmailIdentityMailFromAttributes -> ShowS

show :: PutEmailIdentityMailFromAttributes -> String

showList :: [PutEmailIdentityMailFromAttributes] -> ShowS

NFData PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

rnf :: PutEmailIdentityMailFromAttributes -> ()

Eq PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

(==) :: PutEmailIdentityMailFromAttributes -> PutEmailIdentityMailFromAttributes -> Bool

(/=) :: PutEmailIdentityMailFromAttributes -> PutEmailIdentityMailFromAttributes -> Bool

Hashable PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

hashWithSalt :: Int -> PutEmailIdentityMailFromAttributes -> Int

hash :: PutEmailIdentityMailFromAttributes -> Int

type AWSResponse PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

type AWSResponse PutEmailIdentityMailFromAttributes = PutEmailIdentityMailFromAttributesResponse

type Rep PutEmailIdentityMailFromAttributes

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

type Rep PutEmailIdentityMailFromAttributes = D1 ('MetaData "PutEmailIdentityMailFromAttributes" "Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" '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

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 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, 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 that you want to set up the custom MAIL FROM domain for.

Request Lenses

putEmailIdentityMailFromAttributes_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (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.

putEmailIdentityMailFromAttributes_mailFromDomain :: Lens' PutEmailIdentityMailFromAttributes (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.

putEmailIdentityMailFromAttributes_emailIdentity :: Lens' PutEmailIdentityMailFromAttributes Text

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

Destructuring the Response

data PutEmailIdentityMailFromAttributesResponse

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

Generic PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Associated Types

type Rep PutEmailIdentityMailFromAttributesResponse :: Type -> Type

Methods

from :: PutEmailIdentityMailFromAttributesResponse -> Rep PutEmailIdentityMailFromAttributesResponse x

to :: Rep PutEmailIdentityMailFromAttributesResponse x -> PutEmailIdentityMailFromAttributesResponse

Read PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

readsPrec :: Int -> ReadS PutEmailIdentityMailFromAttributesResponse

readList :: ReadS [PutEmailIdentityMailFromAttributesResponse]

readPrec :: ReadPrec PutEmailIdentityMailFromAttributesResponse

readListPrec :: ReadPrec [PutEmailIdentityMailFromAttributesResponse]

Show PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

showsPrec :: Int -> PutEmailIdentityMailFromAttributesResponse -> ShowS

show :: PutEmailIdentityMailFromAttributesResponse -> String

showList :: [PutEmailIdentityMailFromAttributesResponse] -> ShowS

NFData PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

rnf :: PutEmailIdentityMailFromAttributesResponse -> ()

Eq PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

Methods

(==) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool

(/=) :: PutEmailIdentityMailFromAttributesResponse -> PutEmailIdentityMailFromAttributesResponse -> Bool

type Rep PutEmailIdentityMailFromAttributesResponse

Defined in Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes

type Rep PutEmailIdentityMailFromAttributesResponse = D1 ('MetaData "PutEmailIdentityMailFromAttributesResponse" "Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "PutEmailIdentityMailFromAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutEmailIdentityMailFromAttributesResponse

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

The response's http status code.