SES class

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

Constructors

SES({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shapes → Map<String, Shape>
final

Methods

cloneReceiptRuleSet({required String originalRuleSetName, required String ruleSetName}) → Future<void>
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.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createConfigurationSet({required ConfigurationSet configurationSet}) → Future<void>
Creates a configuration set.
createConfigurationSetEventDestination({required String configurationSetName, required EventDestination eventDestination}) → Future<void>
Creates a configuration set event destination. 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.
createConfigurationSetTrackingOptions({required String configurationSetName, required TrackingOptions trackingOptions}) → Future<void>
Creates an association between a configuration set and a custom domain for open and click event tracking.
createCustomVerificationEmailTemplate({required String failureRedirectionURL, required String fromEmailAddress, required String successRedirectionURL, required String templateContent, required String templateName, required String templateSubject}) → Future<void>
Creates a new custom verification email template.
createReceiptFilter({required ReceiptFilter filter}) → Future<void>
Creates a new IP address filter.
createReceiptRule({required ReceiptRule rule, required String ruleSetName, String? after}) → Future<void>
Creates a receipt rule.
createReceiptRuleSet({required String ruleSetName}) → Future<void>
Creates an empty receipt rule set.
createTemplate({required Template template}) → Future<void>
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
deleteConfigurationSet({required String configurationSetName}) → Future<void>
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.
deleteConfigurationSetEventDestination({required String configurationSetName, required String eventDestinationName}) → Future<void>
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.
deleteConfigurationSetTrackingOptions({required String configurationSetName}) → Future<void>
Deletes an association between a configuration set and a custom domain for open and click event tracking.
deleteCustomVerificationEmailTemplate({required String templateName}) → Future<void>
Deletes an existing custom verification email template.
deleteIdentity({required String identity}) → Future<void>
Deletes the specified identity (an email address or a domain) from the list of verified identities.
deleteIdentityPolicy({required String identity, required String policyName}) → Future<void>
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. 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.
deleteReceiptFilter({required String filterName}) → Future<void>
Deletes the specified IP address filter.
deleteReceiptRule({required String ruleName, required String ruleSetName}) → Future<void>
Deletes the specified receipt rule.
deleteReceiptRuleSet({required String ruleSetName}) → Future<void>
Deletes the specified receipt rule set and all of the receipt rules it contains. For information about managing receipt rule sets, see the Amazon SES Developer Guide.
deleteTemplate({required String templateName}) → Future<void>
Deletes an email template.
deleteVerifiedEmailAddress({required String emailAddress}) → Future<void>
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
describeActiveReceiptRuleSet() → Future<DescribeActiveReceiptRuleSetResponse>
Returns the metadata and receipt rules for the receipt rule set that is currently active.
describeConfigurationSet({required String configurationSetName, List<ConfigurationSetAttribute>? configurationSetAttributeNames}) → Future<DescribeConfigurationSetResponse>
Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
describeReceiptRule({required String ruleName, required String ruleSetName}) → Future<DescribeReceiptRuleResponse>
Returns the details of the specified receipt rule.
describeReceiptRuleSet({required String ruleSetName}) → Future<DescribeReceiptRuleSetResponse>
Returns the details of the specified receipt rule set.
getAccountSendingEnabled() → Future<GetAccountSendingEnabledResponse>
Returns the email sending status of the Amazon SES account for the current region.
getCustomVerificationEmailTemplate({required String templateName}) → Future<GetCustomVerificationEmailTemplateResponse>
Returns the custom email verification template for the template name you specify.
getIdentityDkimAttributes({required List<String> identities}) → Future<GetIdentityDkimAttributesResponse>
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation 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.
getIdentityMailFromDomainAttributes({required List<String> identities}) → Future<GetIdentityMailFromDomainAttributesResponse>
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
getIdentityNotificationAttributes({required List<String> identities}) → Future<GetIdentityNotificationAttributesResponse>
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
getIdentityPolicies({required String identity, required List<String> policyNames}) → Future<GetIdentityPoliciesResponse>
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. 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.
getIdentityVerificationAttributes({required List<String> identities}) → Future<GetIdentityVerificationAttributesResponse>
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
getSendQuota() → Future<GetSendQuotaResponse>
Provides the sending limits for the Amazon SES account.
getSendStatistics() → Future<GetSendStatisticsResponse>
Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
getTemplate({required String templateName}) → Future<GetTemplateResponse>
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
listConfigurationSets({int? maxItems, String? nextToken}) → Future<ListConfigurationSetsResponse>
Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
listCustomVerificationEmailTemplates({int? maxResults, String? nextToken}) → Future<ListCustomVerificationEmailTemplatesResponse>
Lists the existing custom verification email templates for your account in the current AWS Region.
listIdentities({IdentityType? identityType, int? maxItems, String? nextToken}) → Future<ListIdentitiesResponse>
Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
listIdentityPolicies({required String identity}) → Future<ListIdentityPoliciesResponse>
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. 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.
listReceiptFilters() → Future<ListReceiptFiltersResponse>
Lists the IP address filters associated with your AWS account in the current AWS Region.
listReceiptRuleSets({String? nextToken}) → Future<ListReceiptRuleSetsResponse>
Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
listTemplates({int? maxItems, String? nextToken}) → Future<ListTemplatesResponse>
Lists the email templates present in your Amazon SES account in the current AWS Region.
listVerifiedEmailAddresses() → Future<ListVerifiedEmailAddressesResponse>
Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putConfigurationSetDeliveryOptions({required String configurationSetName, DeliveryOptions? deliveryOptions}) → Future<void>
Adds or updates the delivery options for a configuration set.
putIdentityPolicy({required String identity, required String policy, required String policyName}) → Future<void>
Adds or updates a sending authorization policy for the specified identity (an email address or a domain). 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.
reorderReceiptRuleSet({required List<String> ruleNames, required String ruleSetName}) → Future<void>
Reorders the receipt rules within a receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide.
sendBounce({required String bounceSender, required List<BouncedRecipientInfo> bouncedRecipientInfoList, required String originalMessageId, String? bounceSenderArn, String? explanation, MessageDsn? messageDsn}) → Future<SendBounceResponse>
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. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
sendBulkTemplatedEmail({required List<BulkEmailDestination> destinations, required String source, required String template, String? configurationSetName, List<MessageTag>? defaultTags, String? defaultTemplateData, List<String>? replyToAddresses, String? returnPath, String? returnPathArn, String? sourceArn, String? templateArn}) → Future<SendBulkTemplatedEmailResponse>
Composes an email message to multiple destinations. The message body is created using an email template.
sendCustomVerificationEmail({required String emailAddress, required String templateName, String? configurationSetName}) → Future<SendCustomVerificationEmailResponse>
Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
sendEmail({required Destination destination, required Message message, required String source, String? configurationSetName, List<String>? replyToAddresses, String? returnPath, String? returnPathArn, String? sourceArn, List<MessageTag>? tags}) → Future<SendEmailResponse>
Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements:
sendRawEmail({required RawMessage rawMessage, String? configurationSetName, List<String>? destinations, String? fromArn, String? returnPathArn, String? source, String? sourceArn, List<MessageTag>? tags}) → Future<SendRawEmailResponse>
Composes an email message and immediately queues it for sending.
sendTemplatedEmail({required Destination destination, required String source, required String template, required String templateData, String? configurationSetName, List<String>? replyToAddresses, String? returnPath, String? returnPathArn, String? sourceArn, List<MessageTag>? tags, String? templateArn}) → Future<SendTemplatedEmailResponse>
Composes an email message using an email template and immediately queues it for sending.
setActiveReceiptRuleSet({String? ruleSetName}) → Future<void>
Sets the specified receipt rule set as the active receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide.
setIdentityDkimEnabled({required bool dkimEnabled, required String identity}) → Future<void>
Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
setIdentityFeedbackForwardingEnabled({required bool forwardingEnabled, required String identity}) → Future<void>
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. You can execute this operation no more than once per second.
setIdentityHeadersInNotificationsEnabled({required bool enabled, required String identity, required NotificationType notificationType}) → Future<void>
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.
setIdentityMailFromDomain({required String identity, BehaviorOnMXFailure? behaviorOnMXFailure, String? mailFromDomain}) → Future<void>
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). You can execute this operation no more than once per second.
setIdentityNotificationTopic({required String identity, required NotificationType notificationType, String? snsTopic}) → Future<void>
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
setReceiptRulePosition({required String ruleName, required String ruleSetName, String? after}) → Future<void>
Sets the position of the specified receipt rule in the receipt rule set.
testRenderTemplate({required String templateData, required String templateName}) → Future<TestRenderTemplateResponse>
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
toString() → String
A string representation of this object.
inherited
updateAccountSendingEnabled({bool? enabled}) → Future<void>
Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
updateConfigurationSetEventDestination({required String configurationSetName, required EventDestination eventDestination}) → Future<void>
Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
updateConfigurationSetReputationMetricsEnabled({required String configurationSetName, required bool enabled}) → Future<void>
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
updateConfigurationSetSendingEnabled({required String configurationSetName, required bool enabled}) → Future<void>
Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
updateConfigurationSetTrackingOptions({required String configurationSetName, required TrackingOptions trackingOptions}) → Future<void>
Modifies an association between a configuration set and a custom domain for open and click event tracking.
updateCustomVerificationEmailTemplate({required String templateName, String? failureRedirectionURL, String? fromEmailAddress, String? successRedirectionURL, String? templateContent, String? templateSubject}) → Future<void>
Updates an existing custom verification email template.
updateReceiptRule({required ReceiptRule rule, required String ruleSetName}) → Future<void>
Updates a receipt rule.
updateTemplate({required Template template}) → Future<void>
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
verifyDomainDkim({required String domain}) → Future<VerifyDomainDkimResponse>
Returns a set of DKIM tokens for a domain identity. You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
verifyDomainIdentity({required String domain}) → Future<VerifyDomainIdentityResponse>
Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
verifyEmailAddress({required String emailAddress}) → Future<void>
Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
verifyEmailIdentity({required String emailAddress}) → Future<void>
Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

Operators

operator ==(Object other) → bool
The equality operator.
inherited