amazonka-sesv2-2.0: Amazon Simple Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SESV2.SendBulkEmail

Description

Composes an email message to multiple destinations.

Synopsis

Creating a Request

data SendBulkEmail Source #

Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

See: newSendBulkEmail smart constructor.

Constructors

SendBulkEmail' 

Fields

  • configurationSetName :: Maybe Text

    The name of the configuration set to use when sending the email.

  • defaultEmailTags :: Maybe [MessageTag]

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • feedbackForwardingEmailAddress :: Maybe Text

    The address that you want bounce and complaint notifications to be sent to.

  • feedbackForwardingEmailAddressIdentityArn :: Maybe Text

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

  • fromEmailAddress :: Maybe Text

    The email address to use as the "From" address for the email. The address that you specify has to be verified.

  • fromEmailAddressIdentityArn :: Maybe Text

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

  • replyToAddresses :: Maybe [Text]

    The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

  • defaultContent :: BulkEmailContent

    An object that contains the body of the message. You can specify a template message.

  • bulkEmailEntries :: [BulkEmailEntry]

    The list of bulk email entry objects.

Instances

Instances details
ToJSON SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

ToHeaders SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

ToPath SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

ToQuery SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

AWSRequest SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Associated Types

type AWSResponse SendBulkEmail #

Generic SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Associated Types

type Rep SendBulkEmail :: Type -> Type #

Read SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Show SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

NFData SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Methods

rnf :: SendBulkEmail -> () #

Eq SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Hashable SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

type AWSResponse SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

type Rep SendBulkEmail Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

type Rep SendBulkEmail = D1 ('MetaData "SendBulkEmail" "Amazonka.SESV2.SendBulkEmail" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "SendBulkEmail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultEmailTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MessageTag]))) :*: (S1 ('MetaSel ('Just "feedbackForwardingEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "feedbackForwardingEmailAddressIdentityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "fromEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fromEmailAddressIdentityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "replyToAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "defaultContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BulkEmailContent) :*: S1 ('MetaSel ('Just "bulkEmailEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BulkEmailEntry]))))))

newSendBulkEmail Source #

Create a value of SendBulkEmail 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:SendBulkEmail', sendBulkEmail_configurationSetName - The name of the configuration set to use when sending the email.

$sel:defaultEmailTags:SendBulkEmail', sendBulkEmail_defaultEmailTags - A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

$sel:feedbackForwardingEmailAddress:SendBulkEmail', sendBulkEmail_feedbackForwardingEmailAddress - The address that you want bounce and complaint notifications to be sent to.

$sel:feedbackForwardingEmailAddressIdentityArn:SendBulkEmail', sendBulkEmail_feedbackForwardingEmailAddressIdentityArn - This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

SendBulkEmail, sendBulkEmail_fromEmailAddress - The email address to use as the "From" address for the email. The address that you specify has to be verified.

$sel:fromEmailAddressIdentityArn:SendBulkEmail', sendBulkEmail_fromEmailAddressIdentityArn - This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

$sel:replyToAddresses:SendBulkEmail', sendBulkEmail_replyToAddresses - The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

$sel:defaultContent:SendBulkEmail', sendBulkEmail_defaultContent - An object that contains the body of the message. You can specify a template message.

$sel:bulkEmailEntries:SendBulkEmail', sendBulkEmail_bulkEmailEntries - The list of bulk email entry objects.

Request Lenses

sendBulkEmail_configurationSetName :: Lens' SendBulkEmail (Maybe Text) Source #

The name of the configuration set to use when sending the email.

sendBulkEmail_defaultEmailTags :: Lens' SendBulkEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendBulkEmail_feedbackForwardingEmailAddress :: Lens' SendBulkEmail (Maybe Text) Source #

The address that you want bounce and complaint notifications to be sent to.

sendBulkEmail_feedbackForwardingEmailAddressIdentityArn :: Lens' SendBulkEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkEmail_fromEmailAddress :: Lens' SendBulkEmail (Maybe Text) Source #

The email address to use as the "From" address for the email. The address that you specify has to be verified.

sendBulkEmail_fromEmailAddressIdentityArn :: Lens' SendBulkEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkEmail_replyToAddresses :: Lens' SendBulkEmail (Maybe [Text]) Source #

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

sendBulkEmail_defaultContent :: Lens' SendBulkEmail BulkEmailContent Source #

An object that contains the body of the message. You can specify a template message.

sendBulkEmail_bulkEmailEntries :: Lens' SendBulkEmail [BulkEmailEntry] Source #

The list of bulk email entry objects.

Destructuring the Response

data SendBulkEmailResponse Source #

The following data is returned in JSON format by the service.

See: newSendBulkEmailResponse smart constructor.

Constructors

SendBulkEmailResponse' 

Fields

Instances

Instances details
Generic SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Associated Types

type Rep SendBulkEmailResponse :: Type -> Type #

Read SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Show SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

NFData SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

Methods

rnf :: SendBulkEmailResponse -> () #

Eq SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

type Rep SendBulkEmailResponse Source # 
Instance details

Defined in Amazonka.SESV2.SendBulkEmail

type Rep SendBulkEmailResponse = D1 ('MetaData "SendBulkEmailResponse" "Amazonka.SESV2.SendBulkEmail" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "SendBulkEmailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "bulkEmailEntryResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BulkEmailEntryResult])))

newSendBulkEmailResponse Source #

Create a value of SendBulkEmailResponse 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:SendBulkEmailResponse', sendBulkEmailResponse_httpStatus - The response's http status code.

$sel:bulkEmailEntryResults:SendBulkEmailResponse', sendBulkEmailResponse_bulkEmailEntryResults - One object per intended recipient. Check each response object and retry any messages with a failure status.

Response Lenses

sendBulkEmailResponse_bulkEmailEntryResults :: Lens' SendBulkEmailResponse [BulkEmailEntryResult] Source #

One object per intended recipient. Check each response object and retry any messages with a failure status.