Network.AWS.SES

Amazon Simple Email Service

This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

See: AWS API Reference

Service

data SES

Version 2010-12-01 of the Amazon Simple Email Service SDK.

Instances

AWSService SES

type Sg SES = V4

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by SES.

MessageRejected

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

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

InvalidPolicyException

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

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetSendQuota

module Network.AWS.SES.GetSendQuota

DeleteIdentityPolicy

module Network.AWS.SES.DeleteIdentityPolicy

PutIdentityPolicy

module Network.AWS.SES.PutIdentityPolicy

SetIdentityDkimEnabled

module Network.AWS.SES.SetIdentityDkimEnabled

GetIdentityNotificationAttributes

module Network.AWS.SES.GetIdentityNotificationAttributes

ListIdentityPolicies

module Network.AWS.SES.ListIdentityPolicies

SetIdentityFeedbackForwardingEnabled

module Network.AWS.SES.SetIdentityFeedbackForwardingEnabled

GetIdentityVerificationAttributes

module Network.AWS.SES.GetIdentityVerificationAttributes

GetIdentityPolicies

module Network.AWS.SES.GetIdentityPolicies

VerifyDomainIdentity

module Network.AWS.SES.VerifyDomainIdentity

VerifyDomainDkim

module Network.AWS.SES.VerifyDomainDkim

SendRawEmail

module Network.AWS.SES.SendRawEmail

GetIdentityDkimAttributes

module Network.AWS.SES.GetIdentityDkimAttributes

DeleteIdentity

module Network.AWS.SES.DeleteIdentity

GetSendStatistics

module Network.AWS.SES.GetSendStatistics

ListIdentities (Paginated)

module Network.AWS.SES.ListIdentities

DeleteVerifiedEmailAddress

module Network.AWS.SES.DeleteVerifiedEmailAddress

VerifyEmailAddress

module Network.AWS.SES.VerifyEmailAddress

VerifyEmailIdentity

module Network.AWS.SES.VerifyEmailIdentity

SendEmail

module Network.AWS.SES.SendEmail

ListVerifiedEmailAddresses

module Network.AWS.SES.ListVerifiedEmailAddresses

SetIdentityNotificationTopic

module Network.AWS.SES.SetIdentityNotificationTopic

Types

IdentityType

data IdentityType

Constructors

Domain

EmailAddress

Instances

Enum IdentityType

Eq IdentityType

Data IdentityType

Ord IdentityType

Read IdentityType

Show IdentityType

Generic IdentityType

Hashable IdentityType

ToHeader IdentityType

ToQuery IdentityType

ToByteString IdentityType

FromText IdentityType

ToText IdentityType

Typeable * IdentityType

type Rep IdentityType

NotificationType

data NotificationType

Constructors

Bounce

Complaint

Delivery

Instances

Enum NotificationType

Eq NotificationType

Data NotificationType

Ord NotificationType

Read NotificationType

Show NotificationType

Generic NotificationType

Hashable NotificationType

ToHeader NotificationType

ToQuery NotificationType

ToByteString NotificationType

FromText NotificationType

ToText NotificationType

Typeable * NotificationType

type Rep NotificationType

VerificationStatus

data VerificationStatus

Constructors

Failed

NotStarted

Pending

Success

TemporaryFailure

Instances

Enum VerificationStatus

Eq VerificationStatus

Data VerificationStatus

Ord VerificationStatus

Read VerificationStatus

Show VerificationStatus

Generic VerificationStatus

Hashable VerificationStatus

ToHeader VerificationStatus

FromXML VerificationStatus

ToQuery VerificationStatus

ToByteString VerificationStatus

FromText VerificationStatus

ToText VerificationStatus

Typeable * VerificationStatus

type Rep VerificationStatus

Body

data Body

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

Eq Body

Data Body

Read Body

Show Body

Generic Body

ToQuery Body

Typeable * Body

type Rep Body

body :: Body

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
• bHTML

bText :: Lens' Body (Maybe Content)

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)

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.

Content

data Content

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

Eq Content

Data Content

Read Content

Show Content

Generic Content

ToQuery Content

Typeable * Content

type Rep Content

content

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
• cData

cCharset :: Lens' Content (Maybe Text)

The character set of the content.

cData :: Lens' Content Text

The textual data of the content.

Destination

data Destination

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

Eq Destination

Data Destination

Read Destination

Show Destination

Generic Destination

ToQuery Destination

Typeable * Destination

type Rep Destination

destination :: Destination

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
• dCCAddresses
• dToAddresses

dBCCAddresses :: Lens' Destination [Text]

The BCC: field(s) of the message.

dCCAddresses :: Lens' Destination [Text]

The CC: field(s) of the message.

dToAddresses :: Lens' Destination [Text]

The To: field(s) of the message.

IdentityDkimAttributes

data IdentityDkimAttributes

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

See: identityDkimAttributes smart constructor.

Instances

Eq IdentityDkimAttributes

Data IdentityDkimAttributes

Read IdentityDkimAttributes

Show IdentityDkimAttributes

Generic IdentityDkimAttributes

FromXML IdentityDkimAttributes

Typeable * IdentityDkimAttributes

type Rep IdentityDkimAttributes

identityDkimAttributes

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
• idaDkimEnabled
• idaDkimVerificationStatus

idaDkimTokens :: Lens' IdentityDkimAttributes [Text]

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

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

idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus

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

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

Eq IdentityNotificationAttributes

Data IdentityNotificationAttributes

Read IdentityNotificationAttributes

Show IdentityNotificationAttributes

Generic IdentityNotificationAttributes

FromXML IdentityNotificationAttributes

Typeable * IdentityNotificationAttributes

type Rep IdentityNotificationAttributes

identityNotificationAttributes

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
• inaComplaintTopic
• inaDeliveryTopic
• inaForwardingEnabled

inaBounceTopic :: Lens' IdentityNotificationAttributes Text

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

inaComplaintTopic :: Lens' IdentityNotificationAttributes Text

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

inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text

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

inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool

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

Represents the verification attributes of a single identity.

See: identityVerificationAttributes smart constructor.

Instances

Eq IdentityVerificationAttributes

Data IdentityVerificationAttributes

Read IdentityVerificationAttributes

Show IdentityVerificationAttributes

Generic IdentityVerificationAttributes

FromXML IdentityVerificationAttributes

Typeable * IdentityVerificationAttributes

type Rep IdentityVerificationAttributes

identityVerificationAttributes

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
• ivaVerificationStatus

ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text)

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

ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus

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

Message

data Message

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

See: message smart constructor.

Instances

Eq Message

Data Message

Read Message

Show Message

Generic Message

ToQuery Message

Typeable * Message

type Rep Message

message

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
• mBody

mSubject :: Lens' Message Content

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

mBody :: Lens' Message Body

The message body.

RawMessage

data RawMessage

Represents the raw data of the message.

See: rawMessage smart constructor.

Instances

Eq RawMessage

Data RawMessage

Read RawMessage

Show RawMessage

Generic RawMessage

ToQuery RawMessage

Typeable * RawMessage

type Rep RawMessage

rawMessage

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

rmData :: Lens' RawMessage ByteString

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.

SendDataPoint

data SendDataPoint

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

See: sendDataPoint smart constructor.

Instances

Eq SendDataPoint

Data SendDataPoint

Read SendDataPoint

Show SendDataPoint

Generic SendDataPoint

FromXML SendDataPoint

Typeable * SendDataPoint

type Rep SendDataPoint

sendDataPoint :: SendDataPoint

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
• sdpComplaints
• sdpDeliveryAttempts
• sdpBounces
• sdpTimestamp

sdpRejects :: Lens' SendDataPoint (Maybe Integer)

Number of emails rejected by Amazon SES.

sdpComplaints :: Lens' SendDataPoint (Maybe Integer)

Number of unwanted emails that were rejected by recipients.

sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer)

Number of emails that have been enqueued for sending.

sdpBounces :: Lens' SendDataPoint (Maybe Integer)

Number of emails that have bounced.

sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime)

Time of the data point.