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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Synopsis

data SendCustomVerificationEmail = SendCustomVerificationEmail' {
- configurationSetName :: Maybe Text
- emailAddress :: Text
- templateName :: Text
}
newSendCustomVerificationEmail :: Text -> Text -> SendCustomVerificationEmail
sendCustomVerificationEmail_configurationSetName :: Lens' SendCustomVerificationEmail (Maybe Text)
sendCustomVerificationEmail_emailAddress :: Lens' SendCustomVerificationEmail Text
sendCustomVerificationEmail_templateName :: Lens' SendCustomVerificationEmail Text
data SendCustomVerificationEmailResponse = SendCustomVerificationEmailResponse' {
- messageId :: Maybe Text
- httpStatus :: Int
}
newSendCustomVerificationEmailResponse :: Int -> SendCustomVerificationEmailResponse
sendCustomVerificationEmailResponse_messageId :: Lens' SendCustomVerificationEmailResponse (Maybe Text)
sendCustomVerificationEmailResponse_httpStatus :: Lens' SendCustomVerificationEmailResponse Int

Creating a Request

data SendCustomVerificationEmail Source #

Represents a request to send a custom verification email to a specified recipient.

See: newSendCustomVerificationEmail smart constructor.

Constructors

SendCustomVerificationEmail'
Fields configurationSetName :: Maybe Text Name of a configuration set to use when sending the verification email. emailAddress :: Text The email address to verify. templateName :: Text The name of the custom verification email template to use when sending the verification email.

Instances

Instances details

Eq SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods (==) :: SendCustomVerificationEmail -> SendCustomVerificationEmail -> Bool # (/=) :: SendCustomVerificationEmail -> SendCustomVerificationEmail -> Bool #
Read SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods readsPrec :: Int -> ReadS SendCustomVerificationEmail # readList :: ReadS [SendCustomVerificationEmail] # readPrec :: ReadPrec SendCustomVerificationEmail # readListPrec :: ReadPrec [SendCustomVerificationEmail] #
Show SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods showsPrec :: Int -> SendCustomVerificationEmail -> ShowS # show :: SendCustomVerificationEmail -> String # showList :: [SendCustomVerificationEmail] -> ShowS #
Generic SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Associated Types type Rep SendCustomVerificationEmail :: Type -> Type # Methods from :: SendCustomVerificationEmail -> Rep SendCustomVerificationEmail x # to :: Rep SendCustomVerificationEmail x -> SendCustomVerificationEmail #
NFData SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods rnf :: SendCustomVerificationEmail -> () #
Hashable SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods hashWithSalt :: Int -> SendCustomVerificationEmail -> Int # hash :: SendCustomVerificationEmail -> Int #
AWSRequest SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Associated Types type AWSResponse SendCustomVerificationEmail # Methods request :: SendCustomVerificationEmail -> Request SendCustomVerificationEmail # response :: MonadResource m => Logger -> Service -> Proxy SendCustomVerificationEmail -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendCustomVerificationEmail))) #
ToHeaders SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods toHeaders :: SendCustomVerificationEmail -> [Header] #
ToPath SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods toPath :: SendCustomVerificationEmail -> ByteString #
ToQuery SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods toQuery :: SendCustomVerificationEmail -> QueryString #
type Rep SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail type Rep SendCustomVerificationEmail = D1 ('MetaData "SendCustomVerificationEmail" "Amazonka.SES.SendCustomVerificationEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendCustomVerificationEmail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SendCustomVerificationEmail Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail type AWSResponse SendCustomVerificationEmail = SendCustomVerificationEmailResponse

newSendCustomVerificationEmail Source #

Arguments

:: Text	`$sel:emailAddress:SendCustomVerificationEmail'`
-> Text	`$sel:templateName:SendCustomVerificationEmail'`
-> SendCustomVerificationEmail

Create a value of SendCustomVerificationEmail 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:configurationSetName:SendCustomVerificationEmail', sendCustomVerificationEmail_configurationSetName - Name of a configuration set to use when sending the verification email.

$sel:emailAddress:SendCustomVerificationEmail', sendCustomVerificationEmail_emailAddress - The email address to verify.

$sel:templateName:SendCustomVerificationEmail', sendCustomVerificationEmail_templateName - The name of the custom verification email template to use when sending the verification email.

Request Lenses

sendCustomVerificationEmail_configurationSetName :: Lens' SendCustomVerificationEmail (Maybe Text) Source #

Name of a configuration set to use when sending the verification email.

sendCustomVerificationEmail_emailAddress :: Lens' SendCustomVerificationEmail Text Source #

The email address to verify.

sendCustomVerificationEmail_templateName :: Lens' SendCustomVerificationEmail Text Source #

The name of the custom verification email template to use when sending the verification email.

Destructuring the Response

data SendCustomVerificationEmailResponse Source #

The response received when attempting to send the custom verification email.

See: newSendCustomVerificationEmailResponse smart constructor.

Constructors

SendCustomVerificationEmailResponse'
Fields messageId :: Maybe Text The unique message identifier returned from the `SendCustomVerificationEmail` operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods (==) :: SendCustomVerificationEmailResponse -> SendCustomVerificationEmailResponse -> Bool # (/=) :: SendCustomVerificationEmailResponse -> SendCustomVerificationEmailResponse -> Bool #
Read SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods readsPrec :: Int -> ReadS SendCustomVerificationEmailResponse # readList :: ReadS [SendCustomVerificationEmailResponse] # readPrec :: ReadPrec SendCustomVerificationEmailResponse # readListPrec :: ReadPrec [SendCustomVerificationEmailResponse] #
Show SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods showsPrec :: Int -> SendCustomVerificationEmailResponse -> ShowS # show :: SendCustomVerificationEmailResponse -> String # showList :: [SendCustomVerificationEmailResponse] -> ShowS #
Generic SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Associated Types type Rep SendCustomVerificationEmailResponse :: Type -> Type # Methods from :: SendCustomVerificationEmailResponse -> Rep SendCustomVerificationEmailResponse x # to :: Rep SendCustomVerificationEmailResponse x -> SendCustomVerificationEmailResponse #
NFData SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail Methods rnf :: SendCustomVerificationEmailResponse -> () #
type Rep SendCustomVerificationEmailResponse Source #
Instance details Defined in Amazonka.SES.SendCustomVerificationEmail type Rep SendCustomVerificationEmailResponse = D1 ('MetaData "SendCustomVerificationEmailResponse" "Amazonka.SES.SendCustomVerificationEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendCustomVerificationEmailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendCustomVerificationEmailResponse Source #

Arguments

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

Create a value of SendCustomVerificationEmailResponse 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:messageId:SendCustomVerificationEmailResponse', sendCustomVerificationEmailResponse_messageId - The unique message identifier returned from the SendCustomVerificationEmail operation.

$sel:httpStatus:SendCustomVerificationEmailResponse', sendCustomVerificationEmailResponse_httpStatus - The response's http status code.

Response Lenses

sendCustomVerificationEmailResponse_messageId :: Lens' SendCustomVerificationEmailResponse (Maybe Text) Source #

The unique message identifier returned from the SendCustomVerificationEmail operation.

sendCustomVerificationEmailResponse_httpStatus :: Lens' SendCustomVerificationEmailResponse Int Source #

The response's http status code.