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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Synopsis

Creating a Request

data GetEmailIdentity Source #

A request to return details about an email identity.

See: newGetEmailIdentity smart constructor.

Constructors

GetEmailIdentity'
Fields emailIdentity :: Text The email identity that you want to retrieve details for.

Instances

Instances details

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

newGetEmailIdentity Source #

Arguments

:: Text	`$sel:emailIdentity:GetEmailIdentity'`
-> GetEmailIdentity

Create a value of GetEmailIdentity 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:emailIdentity:GetEmailIdentity', getEmailIdentity_emailIdentity - The email identity that you want to retrieve details for.

Request Lenses

getEmailIdentity_emailIdentity :: Lens' GetEmailIdentity Text Source #

The email identity that you want to retrieve details for.

Destructuring the Response

data GetEmailIdentityResponse Source #

Details about an email identity.

See: newGetEmailIdentityResponse smart constructor.

Constructors

GetEmailIdentityResponse'

Fields

dkimAttributes :: Maybe DkimAttributes
An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
feedbackForwardingStatus :: Maybe Bool
The feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
identityType :: Maybe IdentityType
The email identity type.
mailFromAttributes :: Maybe MailFromAttributes
An object that contains information about the Mail-From attributes for the email identity.
tags :: Maybe [Tag]
An array of objects that define the tags (keys and values) that are associated with the email identity.
verifiedForSendingStatus :: Maybe Bool
Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity Associated Types type Rep GetEmailIdentityResponse :: Type -> Type # Methods from :: GetEmailIdentityResponse -> Rep GetEmailIdentityResponse x # to :: Rep GetEmailIdentityResponse x -> GetEmailIdentityResponse #
Read GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity Methods readsPrec :: Int -> ReadS GetEmailIdentityResponse # readList :: ReadS [GetEmailIdentityResponse] # readPrec :: ReadPrec GetEmailIdentityResponse # readListPrec :: ReadPrec [GetEmailIdentityResponse] #
Show GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity Methods showsPrec :: Int -> GetEmailIdentityResponse -> ShowS # show :: GetEmailIdentityResponse -> String # showList :: [GetEmailIdentityResponse] -> ShowS #
NFData GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity Methods rnf :: GetEmailIdentityResponse -> () #
Eq GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity Methods (==) :: GetEmailIdentityResponse -> GetEmailIdentityResponse -> Bool # (/=) :: GetEmailIdentityResponse -> GetEmailIdentityResponse -> Bool #
type Rep GetEmailIdentityResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetEmailIdentity type Rep GetEmailIdentityResponse = D1 ('MetaData "GetEmailIdentityResponse" "Amazonka.PinpointEmail.GetEmailIdentity" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "GetEmailIdentityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dkimAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimAttributes)) :: (S1 ('MetaSel ('Just "feedbackForwardingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityType)))) :: ((S1 ('MetaSel ('Just "mailFromAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MailFromAttributes)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "verifiedForSendingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetEmailIdentityResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetEmailIdentityResponse'`
-> GetEmailIdentityResponse

Create a value of GetEmailIdentityResponse 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:dkimAttributes:GetEmailIdentityResponse', getEmailIdentityResponse_dkimAttributes - An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

$sel:feedbackForwardingStatus:GetEmailIdentityResponse', getEmailIdentityResponse_feedbackForwardingStatus - The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

GetEmailIdentityResponse, getEmailIdentityResponse_identityType - The email identity type.

$sel:mailFromAttributes:GetEmailIdentityResponse', getEmailIdentityResponse_mailFromAttributes - An object that contains information about the Mail-From attributes for the email identity.

$sel:tags:GetEmailIdentityResponse', getEmailIdentityResponse_tags - An array of objects that define the tags (keys and values) that are associated with the email identity.

$sel:verifiedForSendingStatus:GetEmailIdentityResponse', getEmailIdentityResponse_verifiedForSendingStatus - Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

$sel:httpStatus:GetEmailIdentityResponse', getEmailIdentityResponse_httpStatus - The response's http status code.

Response Lenses

getEmailIdentityResponse_dkimAttributes :: Lens' GetEmailIdentityResponse (Maybe DkimAttributes) Source #

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

getEmailIdentityResponse_feedbackForwardingStatus :: Lens' GetEmailIdentityResponse (Maybe Bool) Source #

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

getEmailIdentityResponse_identityType :: Lens' GetEmailIdentityResponse (Maybe IdentityType) Source #

The email identity type.

getEmailIdentityResponse_mailFromAttributes :: Lens' GetEmailIdentityResponse (Maybe MailFromAttributes) Source #

An object that contains information about the Mail-From attributes for the email identity.

getEmailIdentityResponse_tags :: Lens' GetEmailIdentityResponse (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that are associated with the email identity.

getEmailIdentityResponse_verifiedForSendingStatus :: Lens' GetEmailIdentityResponse (Maybe Bool) Source #

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

getEmailIdentityResponse_httpStatus :: Lens' GetEmailIdentityResponse Int Source #

The response's http status code.