C# (CSharp) Amazon.SimpleEmail.Model Namespace

Nested Namespaces

Amazon.SimpleEmail.Model.Internal

Сlasses

Name Description
AlreadyExistsException
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.

CannotDeleteException
CloneReceiptRuleSetRequest Container for the parameters to the CloneReceiptRuleSet operation. Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

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

This action is throttled at one request per second.

CloudWatchDestination Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.

Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

CloudWatchDimensionConfiguration Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

ConfigurationSet The name of the configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

ConfigurationSetAlreadyExistsException
ConfigurationSetDoesNotExistException
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.

CreateConfigurationSetEventDestinationRequest Container for the parameters to the CreateConfigurationSetEventDestination operation. Creates a configuration set event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

CreateConfigurationSetRequest Container for the parameters to the CreateConfigurationSet operation. Creates a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

DeleteConfigurationSetEventDestinationRequest Container for the parameters to the DeleteConfigurationSetEventDestination operation. Deletes a configuration set event destination.

Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

DeleteConfigurationSetRequest Container for the parameters to the DeleteConfigurationSet operation. Deletes a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

DeleteIdentityPolicyRequest Container for the parameters to the DeleteIdentityPolicy operation. Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

DeleteIdentityRequest Container for the parameters to the DeleteIdentity operation.

Deletes the specified identity (email address or domain) from the list of verified identities.

DeleteIdentityResponse Returns information about the DeleteIdentity response and response metadata.
DeleteReceiptFilterRequest Container for the parameters to the DeleteReceiptFilter operation. Deletes the specified IP address filter.

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

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

DeleteReceiptRuleSetRequest Container for the parameters to the DeleteReceiptRuleSet operation. Deletes the specified receipt rule set and all of the receipt rules it contains.

The currently active rule set cannot be deleted.

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

This action is throttled at one request per second.

DeleteVerifiedEmailAddressRequest Container for the parameters to the DeleteVerifiedEmailAddress operation.

Deletes the specified email address from the list of verified addresses.

IMPORTANT:The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.

This action is throttled at one request per second.

DescribeActiveReceiptRuleSetResponse Represents the metadata and receipt rules for the receipt rule set that is currently active.
DescribeConfigurationSetRequest Container for the parameters to the DescribeConfigurationSet operation. Returns the details of the specified configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

DescribeConfigurationSetResponse Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
DescribeReceiptRuleResponse Represents the details of a receipt rule.
DescribeReceiptRuleSetResponse Represents the details of the specified receipt rule set.
Destination

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

EventDestination Contains information about the event destination to which the specified email sending events are published.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide.

EventDestinationAlreadyExistsException
EventDestinationDoesNotExistException
FromEmailAddressNotVerifiedException
GetIdentityDkimAttributesRequest Container for the parameters to the GetIdentityDkimAttributes operation. Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This action takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.

  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

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

GetIdentityDkimAttributesResponse Returns information about the GetIdentityDkimAttributes response and response metadata.
GetIdentityDkimAttributesResult Represents a list of all the DKIM attributes for the specified identity.
GetIdentityMailFromDomainAttributesRequest Container for the parameters to the GetIdentityMailFromDomainAttributes operation. Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).

This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

GetIdentityMailFromDomainAttributesResponse Represents the custom MAIL FROM attributes for a list of identities.
GetIdentityNotificationAttributesRequest Container for the parameters to the GetIdentityNotificationAttributes operation.

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second.

For more information about feedback notification, see the Amazon SES Developer Guide .

GetIdentityNotificationAttributesResponse Returns information about the GetIdentityNotificationAttributes response and response metadata.
GetIdentityNotificationAttributesResult

Describes whether an identity has a bounce topic or complaint topic set, or feedback forwarding enabled.

GetIdentityPoliciesRequest Container for the parameters to the GetIdentityPolicies operation. Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

GetIdentityPoliciesResponse Represents the requested sending authorization policies.
GetIdentityVerificationAttributesRequest Container for the parameters to the GetIdentityVerificationAttributes operation.

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

This action is throttled at one request per second.

GetIdentityVerificationAttributesResponse The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.
GetIdentityVerificationAttributesResult Represents the verification attributes for a list of identities.
GetSendQuotaResponse Returns information about the GetSendQuota response and response metadata.
GetSendQuotaResult

Represents the user's current activity limits returned from a successful GetSendQuota request.

GetSendStatisticsResponse Returns information about the GetSendStatisticsResult response and response metadata.
GetSendStatisticsResult Represents a list of SendDataPoint items returned from a successful GetSendStatistics request. This list contains aggregated data from the previous two weeks of sending activity.
IdentityDkimAttributes Represents the DKIM attributes of a verified email address or a domain.
IdentityMailFromDomainAttributes Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
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.
IdentityVerificationAttributes

Represents the verification attributes of a single identity.

InvalidCloudWatchDestinationException
InvalidConfigurationSetException
InvalidFirehoseDestinationException
InvalidLambdaFunctionException
InvalidPolicyException
InvalidS3ConfigurationException
InvalidSnsTopicException
KinesisFirehoseDestination Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

LambdaAction 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.

LimitExceededException
ListConfigurationSetsRequest Container for the parameters to the ListConfigurationSets operation. Lists the configuration sets associated with your AWS account.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second and can return up to 50 configuration sets at a time.

ListConfigurationSetsResponse A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
ListIdentitiesRequest Container for the parameters to the ListIdentities operation. Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

This action is throttled at one request per second.

ListIdentitiesResponse Returns information about the ListIdentitiesResult response and response metadata.
ListIdentitiesResult

Represents a list of all verified identities for the AWS Account.

ListIdentityPoliciesRequest Container for the parameters to the ListIdentityPolicies operation. Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

ListIdentityPoliciesResponse A list of names of sending authorization policies that apply to an identity.
ListReceiptFiltersResponse A list of IP address filters that exist under your AWS account.
ListReceiptRuleSetsResponse A list of receipt rule sets that exist under your AWS account.
ListVerifiedEmailAddressesResponse Returns information about the ListVerifiedEmailAddressesResult response and response metadata.
ListVerifiedEmailAddressesResult

Represents a list of all the email addresses verified for the current user.

MailFromDomainNotVerifiedException
Message

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

MessageRejectedException
MessageTag Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

PutIdentityPolicyRequest Container for the parameters to the PutIdentityPolicy operation. Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

RawMessage

Represents the raw data of the message.

ReceiptFilter 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.

ReceiptRule 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.

ReceiptRuleSetMetadata 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.

RecipientDsnFields 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.

ReorderReceiptRuleSetRequest Container for the parameters to the ReorderReceiptRuleSet operation. Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

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

This action is throttled at one request per second.

RuleDoesNotExistException
RuleSetDoesNotExistException
S3Action 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.

SNSAction 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.

SendBounceRequest Container for the parameters to the SendBounce operation. Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

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

This action is throttled at one request per second.

SendBounceResponse Represents a unique message ID.
SendDataPoint

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

SendEmailRequest Container for the parameters to the SendEmail operation. Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

SendEmailResponse Returns information about the SendEmailResult response and response metadata.
SendEmailResult Represents a unique message ID returned from a successful SendEmail request.
SendRawEmailRequest Container for the parameters to the SendRawEmail operation.

Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails, with attachments or inline content.

The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. For more information, go to the Amazon SES Developer Guide.

SendRawEmailResponse Represents a unique message ID.
SendRawEmailResult

Represents a unique message ID returned from a successful SendRawEmail request.

SetActiveReceiptRuleSetRequest Container for the parameters to the SetActiveReceiptRuleSet operation. Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

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

This action is throttled at one request per second.

SetIdentityDkimEnabledRequest Container for the parameters to the SetIdentityDkimEnabled operation. Enables or disables Easy DKIM signing of email sent from an identity:
  • If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., [email protected]).

  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., [email protected]), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

SetIdentityDkimEnabledResponse Returns information about the SetIdentityDkimEnabled response and response metadata.
SetIdentityFeedbackForwardingEnabledRequest Container for the parameters to the SetIdentityFeedbackForwardingEnabled operation. Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

SetIdentityFeedbackForwardingEnabledResponse Returns information about the SetIdentityFeedbackForwardingEnabledResult response and response metadata.
SetIdentityHeadersInNotificationsEnabledRequest Container for the parameters to the SetIdentityHeadersInNotificationsEnabled operation. Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

SetIdentityMailFromDomainRequest Container for the parameters to the SetIdentityMailFromDomain operation. Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

SetIdentityNotificationTopicRequest Container for the parameters to the SetIdentityNotificationTopic operation.

Given an identity (email address or domain), sets the Amazon SNS topic to which Amazon SES will publish bounce and complaint notifications for emails sent with that identity as the Source . Publishing to topics may only be disabled when feedback forwarding is enabled. For more information about feedback notification, see the Amazon SES Developer Guide.

SetIdentityNotificationTopicResponse Returns information about the SetIdentityNotificationTopic response and response metadata.
UpdateConfigurationSetEventDestinationRequest Container for the parameters to the UpdateConfigurationSetEventDestination operation. Updates the event destination of a configuration set.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

VerifyDomainDkimRequest Container for the parameters to the VerifyDomainDkim operation.

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your 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 action is throttled at one request per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.

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

VerifyDomainDkimResponse Returns information about the VerifyDomainDkim response and response metadata.
VerifyDomainDkimResult Represents the DNS records that must be published in the domain name's DNS to complete DKIM setup.
VerifyDomainIdentityRequest Container for the parameters to the VerifyDomainIdentity operation.

Verifies a domain.

This action is throttled at one request per second.

VerifyDomainIdentityResponse Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.
VerifyDomainIdentityResult Represents a token used for domain ownership verification.
VerifyEmailAddressRequest Container for the parameters to the VerifyEmailAddress operation.

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

IMPORTANT:The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.

This action is throttled at one request per second.

VerifyEmailIdentityRequest Container for the parameters to the VerifyEmailIdentity operation. Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

VerifyEmailIdentityResponse Returns information about the VerifyEmailIdentityResult response and response metadata.