amazonka-ses-1.3.4: Amazon Simple Email Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SES.Types

Contents

Description

 

Synopsis

Service Configuration

sES :: Service Source

API version '2010-12-01' of the Amazon Simple Email Service SDK configuration.

Errors

_CannotDeleteException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the delete operation could not be completed.

_RuleDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided receipt rule does not exist.

_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

_RuleSetDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided receipt rule set does not exist.

_InvalidLambdaFunctionException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

_InvalidPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

_InvalidS3ConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

_InvalidSNSTopicException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that a resource could not be created due to a naming conflict.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

BounceType

data BounceType Source

Constructors

BTContentRejected 
BTDoesNotExist 
BTExceededQuota 
BTMessageTooLarge 
BTTemporaryFailure 
BTUndefined 

Instances

DsnAction

data DsnAction Source

Constructors

DADelayed 
DADelivered 
DAExpanded 
DAFailed 
DARelayed 

Instances

IdentityType

data IdentityType Source

Constructors

Domain 
EmailAddress 

Instances

InvocationType

data InvocationType Source

Constructors

Event 
RequestResponse 

Instances

NotificationType

data NotificationType Source

Constructors

Bounce 
Complaint 
Delivery 

Instances

ReceiptFilterPolicy

data ReceiptFilterPolicy Source

Constructors

Allow 
Block 

Instances

StopScope

data StopScope Source

Constructors

RuleSet 

Instances

TLSPolicy

data TLSPolicy Source

Constructors

Optional 
Require 

Instances

VerificationStatus

data VerificationStatus Source

Constructors

Failed 
NotStarted 
Pending 
Success 
TemporaryFailure 

Instances

AddHeaderAction

data AddHeaderAction Source

When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

See: addHeaderAction smart constructor.

Instances

addHeaderAction Source

Arguments

:: Text

ahaHeaderName

-> Text

ahaHeaderValue

-> AddHeaderAction 

Creates a value of AddHeaderAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ahaHeaderName :: Lens' AddHeaderAction Text Source

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

ahaHeaderValue :: Lens' AddHeaderAction Text Source

Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

Body

data Body Source

Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.

See: body smart constructor.

Instances

body :: Body Source

Creates a value of Body with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bText :: Lens' Body (Maybe Content) Source

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

bHTML :: Lens' Body (Maybe Content) Source

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

BounceAction

data BounceAction Source

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

See: bounceAction smart constructor.

Instances

bounceAction Source

Arguments

:: Text

baSmtpReplyCode

-> Text

baMessage

-> Text

baSender

-> BounceAction 

Creates a value of BounceAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

baTopicARN :: Lens' BounceAction (Maybe Text) Source

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

baStatusCode :: Lens' BounceAction (Maybe Text) Source

The SMTP enhanced status code, as defined by RFC 3463.

baSmtpReplyCode :: Lens' BounceAction Text Source

The SMTP reply code, as defined by RFC 5321.

baMessage :: Lens' BounceAction Text Source

Human-readable text to include in the bounce message.

baSender :: Lens' BounceAction Text Source

The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

BouncedRecipientInfo

data BouncedRecipientInfo Source

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See: bouncedRecipientInfo smart constructor.

Instances

bouncedRecipientInfo Source

Arguments

:: Text

briRecipient

-> BouncedRecipientInfo 

Creates a value of BouncedRecipientInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

briBounceType :: Lens' BouncedRecipientInfo (Maybe BounceType) Source

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

briRecipientDsnFields :: Lens' BouncedRecipientInfo (Maybe RecipientDsnFields) Source

Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

briRecipientARN :: Lens' BouncedRecipientInfo (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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

briRecipient :: Lens' BouncedRecipientInfo Text Source

The email address of the recipient of the bounced email.

Content

data Content Source

Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

See: content smart constructor.

Instances

content Source

Arguments

:: Text

cData

-> Content 

Creates a value of Content with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cCharset :: Lens' Content (Maybe Text) Source

The character set of the content.

cData :: Lens' Content Text Source

The textual data of the content.

Destination

data Destination Source

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: '=?charset?encoding?encoded-text?='. For more information, see RFC 2047.

See: destination smart constructor.

Instances

destination :: Destination Source

Creates a value of Destination with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dBCCAddresses :: Lens' Destination [Text] Source

The BCC: field(s) of the message.

dCCAddresses :: Lens' Destination [Text] Source

The CC: field(s) of the message.

dToAddresses :: Lens' Destination [Text] Source

The To: field(s) of the message.

ExtensionField

data ExtensionField Source

Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See: extensionField smart constructor.

Instances

extensionField Source

Arguments

:: Text

efName

-> Text

efValue

-> ExtensionField 

Creates a value of ExtensionField with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

efName :: Lens' ExtensionField Text Source

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

efValue :: Lens' ExtensionField Text Source

The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

IdentityDkimAttributes

data IdentityDkimAttributes Source

Represents the DKIM attributes of a verified email address or a domain.

See: identityDkimAttributes smart constructor.

Instances

identityDkimAttributes Source

Arguments

:: Bool

idaDkimEnabled

-> VerificationStatus

idaDkimVerificationStatus

-> IdentityDkimAttributes 

Creates a value of IdentityDkimAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

idaDkimTokens :: Lens' IdentityDkimAttributes [Text] Source

A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

idaDkimEnabled :: Lens' IdentityDkimAttributes Bool Source

True if DKIM signing is enabled for email sent from the identity; false otherwise.

idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus Source

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

IdentityNotificationAttributes

data IdentityNotificationAttributes Source

Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

See: identityNotificationAttributes smart constructor.

Instances

identityNotificationAttributes Source

Arguments

:: Text

inaBounceTopic

-> Text

inaComplaintTopic

-> Text

inaDeliveryTopic

-> Bool

inaForwardingEnabled

-> IdentityNotificationAttributes 

Creates a value of IdentityNotificationAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

inaBounceTopic :: Lens' IdentityNotificationAttributes Text Source

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

inaComplaintTopic :: Lens' IdentityNotificationAttributes Text Source

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text Source

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool Source

Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

IdentityVerificationAttributes

data IdentityVerificationAttributes Source

Represents the verification attributes of a single identity.

See: identityVerificationAttributes smart constructor.

Instances

identityVerificationAttributes Source

Arguments

:: VerificationStatus

ivaVerificationStatus

-> IdentityVerificationAttributes 

Creates a value of IdentityVerificationAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text) Source

The verification token for a domain identity. Null for email address identities.

ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus Source

The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

LambdaAction

data LambdaAction Source

When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.

See: lambdaAction smart constructor.

Instances

lambdaAction Source

Arguments

:: Text

laFunctionARN

-> LambdaAction 

Creates a value of LambdaAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

laInvocationType :: Lens' LambdaAction (Maybe InvocationType) Source

The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

laTopicARN :: Lens' LambdaAction (Maybe Text) Source

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

laFunctionARN :: Lens' LambdaAction Text Source

The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is 'arn:aws:lambda:us-west-2:account-id:function:MyFunction'. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

Message

data Message Source

Represents the message to be sent, composed of a subject and a body.

See: message smart constructor.

Instances

message Source

Arguments

:: Content

mSubject

-> Body

mBody

-> Message 

Creates a value of Message with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mSubject :: Lens' Message Content Source

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

mBody :: Lens' Message Body Source

The message body.

MessageDsn

data MessageDsn Source

Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See: messageDsn smart constructor.

Instances

messageDsn Source

Arguments

:: Text

mdReportingMta

-> MessageDsn 

Creates a value of MessageDsn with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mdArrivalDate :: Lens' MessageDsn (Maybe UTCTime) Source

When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

mdExtensionFields :: Lens' MessageDsn [ExtensionField] Source

Additional X-headers to include in the DSN.

mdReportingMta :: Lens' MessageDsn Text Source

The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 ('mta-name-type; mta-name'). The default value is 'dns; inbound-smtp.[region].amazonaws.com'.

RawMessage

data RawMessage Source

Represents the raw data of the message.

See: rawMessage smart constructor.

Instances

rawMessage Source

Arguments

:: ByteString

rmData

-> RawMessage 

Creates a value of RawMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rmData :: Lens' RawMessage ByteString Source

The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).

The To:, CC:, and BCC: headers in the raw message can contain a group list.

If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail.

Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

For more information, go to the Amazon SES Developer Guide.

Note: This Lens automatically encodes and decodes Base64 data, despite what the AWS documentation might say. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

ReceiptAction

data ReceiptAction Source

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

See: receiptAction smart constructor.

Instances

receiptAction :: ReceiptAction Source

Creates a value of ReceiptAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

raAddHeaderAction :: Lens' ReceiptAction (Maybe AddHeaderAction) Source

Adds a header to the received email.

raSNSAction :: Lens' ReceiptAction (Maybe SNSAction) Source

Publishes the email content within a notification to Amazon SNS.

raWorkmailAction :: Lens' ReceiptAction (Maybe WorkmailAction) Source

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

raBounceAction :: Lens' ReceiptAction (Maybe BounceAction) Source

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

raLambdaAction :: Lens' ReceiptAction (Maybe LambdaAction) Source

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

raStopAction :: Lens' ReceiptAction (Maybe StopAction) Source

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

raS3Action :: Lens' ReceiptAction (Maybe S3Action) Source

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

ReceiptFilter

data ReceiptFilter Source

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

See: receiptFilter smart constructor.

Instances

receiptFilter Source

Arguments

:: Text

rfName

-> ReceiptIPFilter

rfIPFilter

-> ReceiptFilter 

Creates a value of ReceiptFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rfName :: Lens' ReceiptFilter Text Source

The name of the IP address filter. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
  • Start and end with a letter or number.
  • Contain less than 64 characters.

rfIPFilter :: Lens' ReceiptFilter ReceiptIPFilter Source

A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

ReceiptIPFilter

data ReceiptIPFilter Source

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

See: receiptIPFilter smart constructor.

Instances

receiptIPFilter Source

Arguments

:: ReceiptFilterPolicy

rifPolicy

-> Text

rifCIdR

-> ReceiptIPFilter 

Creates a value of ReceiptIPFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rifPolicy :: Lens' ReceiptIPFilter ReceiptFilterPolicy Source

Indicates whether to block or allow incoming mail from the specified IP addresses.

rifCIdR :: Lens' ReceiptIPFilter Text Source

A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

ReceiptRule

data ReceiptRule Source

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains to which it applies. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

See: receiptRule smart constructor.

Instances

receiptRule Source

Arguments

:: Text

rrName

-> ReceiptRule 

Creates a value of ReceiptRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rrScanEnabled :: Lens' ReceiptRule (Maybe Bool) Source

If true, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is true.

rrEnabled :: Lens' ReceiptRule (Maybe Bool) Source

If true, the receipt rule is active. The default value is true.

rrActions :: Lens' ReceiptRule [ReceiptAction] Source

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

rrRecipients :: Lens' ReceiptRule [Text] Source

The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.

rrTLSPolicy :: Lens' ReceiptRule (Maybe TLSPolicy) Source

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

rrName :: Lens' ReceiptRule Text Source

The name of the receipt rule. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
  • Start and end with a letter or number.
  • Contain less than 64 characters.

ReceiptRuleSetMetadata

data ReceiptRuleSetMetadata Source

Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

See: receiptRuleSetMetadata smart constructor.

Instances

receiptRuleSetMetadata :: ReceiptRuleSetMetadata Source

Creates a value of ReceiptRuleSetMetadata with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rrsmName :: Lens' ReceiptRuleSetMetadata (Maybe Text) Source

The name of the receipt rule set. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
  • Start and end with a letter or number.
  • Contain less than 64 characters.

rrsmCreatedTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime) Source

The date and time the receipt rule set was created.

RecipientDsnFields

data RecipientDsnFields Source

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See: recipientDsnFields smart constructor.

Instances

recipientDsnFields Source

Arguments

:: DsnAction

rdfAction

-> Text

rdfStatus

-> RecipientDsnFields 

Creates a value of RecipientDsnFields with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rdfDiagnosticCode :: Lens' RecipientDsnFields (Maybe Text) Source

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

rdfRemoteMta :: Lens' RecipientDsnFields (Maybe Text) Source

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 ('mta-name-type; mta-name'). This parameter typically applies only to propagating synchronous bounces.

rdfFinalRecipient :: Lens' RecipientDsnFields (Maybe Text) Source

The email address to which the message was ultimately delivered. This corresponds to the 'Final-Recipient' in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with 'rfc 822;', as described in RFC 3798.

rdfExtensionFields :: Lens' RecipientDsnFields [ExtensionField] Source

Additional X-headers to include in the DSN.

rdfLastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime) Source

The time the final delivery attempt was made, in RFC 822 date-time format.

rdfAction :: Lens' RecipientDsnFields DsnAction Source

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

rdfStatus :: Lens' RecipientDsnFields Text Source

The status code that indicates what went wrong. This is required by RFC 3464.

S3Action

data S3Action Source

When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

See: s3Action smart constructor.

Instances

s3Action Source

Arguments

:: Text

s3BucketName

-> S3Action 

Creates a value of S3Action with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

s3KMSKeyARN :: Lens' S3Action (Maybe Text) Source

The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

  • To use the default master key, provide an ARN in the form of 'arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias\/aws\/ses'. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be 'arn:aws:kms:us-west-2:123456789012:alias\/aws\/ses'. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.
  • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

s3TopicARN :: Lens' S3Action (Maybe Text) Source

The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

s3ObjectKeyPrefix :: Lens' S3Action (Maybe Text) Source

The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

s3BucketName :: Lens' S3Action Text Source

The name of the Amazon S3 bucket to which to save the received email.

SNSAction

data SNSAction Source

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

See: snsAction smart constructor.

Instances

snsAction Source

Arguments

:: Text

saTopicARN

-> SNSAction 

Creates a value of SNSAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

saTopicARN :: Lens' SNSAction Text Source

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

SendDataPoint

data SendDataPoint Source

Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

See: sendDataPoint smart constructor.

Instances

sendDataPoint :: SendDataPoint Source

Creates a value of SendDataPoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sdpRejects :: Lens' SendDataPoint (Maybe Integer) Source

Number of emails rejected by Amazon SES.

sdpComplaints :: Lens' SendDataPoint (Maybe Integer) Source

Number of unwanted emails that were rejected by recipients.

sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer) Source

Number of emails that have been enqueued for sending.

sdpBounces :: Lens' SendDataPoint (Maybe Integer) Source

Number of emails that have bounced.

sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime) Source

Time of the data point.

StopAction

data StopAction Source

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

See: stopAction smart constructor.

Instances

stopAction Source

Arguments

:: StopScope

sScope

-> StopAction 

Creates a value of StopAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sTopicARN :: Lens' StopAction (Maybe Text) Source

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

sScope :: Lens' StopAction StopScope Source

The scope to which the Stop action applies. That is, what is being stopped.

WorkmailAction

data WorkmailAction Source

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

See: workmailAction smart constructor.

Instances

workmailAction Source

Arguments

:: Text

waOrganizationARN

-> WorkmailAction 

Creates a value of WorkmailAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

waTopicARN :: Lens' WorkmailAction (Maybe Text) Source

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is 'arn:aws:sns:us-west-2:123456789012:MyTopic'. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

waOrganizationARN :: Lens' WorkmailAction Text Source

The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is 'arn:aws:workmail:us-west-2:123456789012:organization\/m-68755160c4cb4e29a2b2f8fb58f359d7'. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.