SESV2 class

Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.

Constructors

SESV2({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

Methods

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 String configurationSetName, DeliveryOptions? deliveryOptions, ReputationOptions? reputationOptions, SendingOptions? sendingOptions, SuppressionOptions? suppressionOptions, List<Tag>? tags, TrackingOptions? trackingOptions}) → Future<void>
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
createConfigurationSetEventDestination({required String configurationSetName, required EventDestinationDefinition eventDestination, required String eventDestinationName}) → Future<void>
Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
createContact({required String contactListName, required String emailAddress, String? attributesData, List<TopicPreference>? topicPreferences, bool? unsubscribeAll}) → Future<void>
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
createContactList({required String contactListName, String? description, List<Tag>? tags, List<Topic>? topics}) → Future<void>
Creates a contact list.
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.
createDedicatedIpPool({required String poolName, List<Tag>? tags}) → Future<void>
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
createDeliverabilityTestReport({required EmailContent content, required String fromEmailAddress, String? reportName, List<Tag>? tags}) → Future<CreateDeliverabilityTestReportResponse>
Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
createEmailIdentity({required String emailIdentity, DkimSigningAttributes? dkimSigningAttributes, List<Tag>? tags}) → Future<CreateEmailIdentityResponse>
Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.
createEmailIdentityPolicy({required String emailIdentity, required String policy, required String policyName}) → Future<void>
Creates the specified sending authorization policy for the given 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.
createEmailTemplate({required EmailTemplateContent templateContent, required String templateName}) → 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.
createImportJob({required ImportDataSource importDataSource, required ImportDestination importDestination}) → Future<CreateImportJobResponse>
Creates an import job for a data destination.
deleteConfigurationSet({required String configurationSetName}) → Future<void>
Delete an existing configuration set.
deleteConfigurationSetEventDestination({required String configurationSetName, required String eventDestinationName}) → Future<void>
Delete an event destination.
deleteContact({required String contactListName, required String emailAddress}) → Future<void>
Removes a contact from a contact list.
deleteContactList({required String contactListName}) → Future<void>
Deletes a contact list and all of the contacts on that list.
deleteCustomVerificationEmailTemplate({required String templateName}) → Future<void>
Deletes an existing custom verification email template.
deleteDedicatedIpPool({required String poolName}) → Future<void>
Delete a dedicated IP pool.
deleteEmailIdentity({required String emailIdentity}) → Future<void>
Deletes an email identity. An identity can be either an email address or a domain name.
deleteEmailIdentityPolicy({required String emailIdentity, 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.
deleteEmailTemplate({required String templateName}) → Future<void>
Deletes an email template.
deleteSuppressedDestination({required String emailAddress}) → Future<void>
Removes an email address from the suppression list for your account.
getAccount() → Future<GetAccountResponse>
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current AWS Region.
getBlacklistReports({required List<String> blacklistItemNames}) → Future<GetBlacklistReportsResponse>
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
getConfigurationSet({required String configurationSetName}) → Future<GetConfigurationSetResponse>
Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
getConfigurationSetEventDestinations({required String configurationSetName}) → Future<GetConfigurationSetEventDestinationsResponse>
Retrieve a list of event destinations that are associated with a configuration set.
getContact({required String contactListName, required String emailAddress}) → Future<GetContactResponse>
Returns a contact from a contact list.
getContactList({required String contactListName}) → Future<GetContactListResponse>
Returns contact list metadata. It does not return any information about the contacts present in the list.
getCustomVerificationEmailTemplate({required String templateName}) → Future<GetCustomVerificationEmailTemplateResponse>
Returns the custom email verification template for the template name you specify.
getDedicatedIp({required String ip}) → Future<GetDedicatedIpResponse>
Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
getDedicatedIps({String? nextToken, int? pageSize, String? poolName}) → Future<GetDedicatedIpsResponse>
List the dedicated IP addresses that are associated with your AWS account.
getDeliverabilityDashboardOptions() → Future<GetDeliverabilityDashboardOptionsResponse>
Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
getDeliverabilityTestReport({required String reportId}) → Future<GetDeliverabilityTestReportResponse>
Retrieve the results of a predictive inbox placement test.
getDomainDeliverabilityCampaign({required String campaignId}) → Future<GetDomainDeliverabilityCampaignResponse>
Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
getDomainStatisticsReport({required String domain, required DateTime endDate, required DateTime startDate}) → Future<GetDomainStatisticsReportResponse>
Retrieve inbox placement and engagement rates for the domains that you use to send email.
getEmailIdentity({required String emailIdentity}) → Future<GetEmailIdentityResponse>
Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.
getEmailIdentityPolicies({required String emailIdentity}) → Future<GetEmailIdentityPoliciesResponse>
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.
getEmailTemplate({required String templateName}) → Future<GetEmailTemplateResponse>
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
getImportJob({required String jobId}) → Future<GetImportJobResponse>
Provides information about an import job.
getSuppressedDestination({required String emailAddress}) → Future<GetSuppressedDestinationResponse>
Retrieves information about a specific email address that's on the suppression list for your account.
listConfigurationSets({String? nextToken, int? pageSize}) → Future<ListConfigurationSetsResponse>
List all of the configuration sets associated with your account in the current region.
listContactLists({String? nextToken, int? pageSize}) → Future<ListContactListsResponse>
Lists all of the contact lists available.
listContacts({required String contactListName, ListContactsFilter? filter, String? nextToken, int? pageSize}) → Future<ListContactsResponse>
Lists the contacts present in a specific contact list.
listCustomVerificationEmailTemplates({String? nextToken, int? pageSize}) → Future<ListCustomVerificationEmailTemplatesResponse>
Lists the existing custom verification email templates for your account in the current AWS Region.
listDedicatedIpPools({String? nextToken, int? pageSize}) → Future<ListDedicatedIpPoolsResponse>
List all of the dedicated IP pools that exist in your AWS account in the current Region.
listDeliverabilityTestReports({String? nextToken, int? pageSize}) → Future<ListDeliverabilityTestReportsResponse>
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.
listDomainDeliverabilityCampaigns({required DateTime endDate, required DateTime startDate, required String subscribedDomain, String? nextToken, int? pageSize}) → Future<ListDomainDeliverabilityCampaignsResponse>
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
listEmailIdentities({String? nextToken, int? pageSize}) → Future<ListEmailIdentitiesResponse>
Returns a list of all of the email identities that are associated with your AWS account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
listEmailTemplates({String? nextToken, int? pageSize}) → Future<ListEmailTemplatesResponse>
Lists the email templates present in your Amazon SES account in the current AWS Region.
listImportJobs({ImportDestinationType? importDestinationType, String? nextToken, int? pageSize}) → Future<ListImportJobsResponse>
Lists all of the import jobs.
listSuppressedDestinations({DateTime? endDate, String? nextToken, int? pageSize, List<SuppressionListReason>? reasons, DateTime? startDate}) → Future<ListSuppressedDestinationsResponse>
Retrieves a list of email addresses that are on the suppression list for your account.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putAccountDedicatedIpWarmupAttributes({bool? autoWarmupEnabled}) → Future<void>
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDetails({required MailType mailType, required String useCaseDescription, required String websiteURL, List<String>? additionalContactEmailAddresses, ContactLanguage? contactLanguage, bool? productionAccessEnabled}) → Future<void>
Update your Amazon SES account details.
putAccountSendingAttributes({bool? sendingEnabled}) → Future<void>
Enable or disable the ability of your account to send email.
putAccountSuppressionAttributes({List<SuppressionListReason>? suppressedReasons}) → Future<void>
Change the settings for the account-level suppression list.
putConfigurationSetDeliveryOptions({required String configurationSetName, String? sendingPoolName, TlsPolicy? tlsPolicy}) → Future<void>
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
putConfigurationSetReputationOptions({required String configurationSetName, bool? reputationMetricsEnabled}) → Future<void>
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptions({required String configurationSetName, bool? sendingEnabled}) → Future<void>
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSuppressionOptions({required String configurationSetName, List<SuppressionListReason>? suppressedReasons}) → Future<void>
Specify the account suppression list preferences for a configuration set.
putConfigurationSetTrackingOptions({required String configurationSetName, String? customRedirectDomain}) → Future<void>
Specify a custom domain to use for open and click tracking elements in email that you send.
putDedicatedIpInPool({required String destinationPoolName, required String ip}) → Future<void>
Move a dedicated IP address to an existing dedicated IP pool.
putDedicatedIpWarmupAttributes({required String ip, required int warmupPercentage}) → Future<void>
putDeliverabilityDashboardOption({required bool dashboardEnabled, List<DomainDeliverabilityTrackingOption>? subscribedDomains}) → Future<void>
Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
putEmailIdentityDkimAttributes({required String emailIdentity, bool? signingEnabled}) → Future<void>
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimSigningAttributes({required String emailIdentity, required DkimSigningAttributesOrigin signingAttributesOrigin, DkimSigningAttributes? signingAttributes}) → Future<PutEmailIdentityDkimSigningAttributesResponse>
Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:
putEmailIdentityFeedbackAttributes({required String emailIdentity, bool? emailForwardingEnabled}) → Future<void>
Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
putEmailIdentityMailFromAttributes({required String emailIdentity, BehaviorOnMxFailure? behaviorOnMxFailure, String? mailFromDomain}) → Future<void>
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putSuppressedDestination({required String emailAddress, required SuppressionListReason reason}) → Future<void>
Adds an email address to the suppression list for your account.
sendBulkEmail({required List<BulkEmailEntry> bulkEmailEntries, required BulkEmailContent defaultContent, String? configurationSetName, List<MessageTag>? defaultEmailTags, String? feedbackForwardingEmailAddress, String? feedbackForwardingEmailAddressIdentityArn, String? fromEmailAddress, String? fromEmailAddressIdentityArn, List<String>? replyToAddresses}) → Future<SendBulkEmailResponse>
Composes an email message to multiple destinations.
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 EmailContent content, String? configurationSetName, Destination? destination, List<MessageTag>? emailTags, String? feedbackForwardingEmailAddress, String? feedbackForwardingEmailAddressIdentityArn, String? fromEmailAddress, String? fromEmailAddressIdentityArn, ListManagementOptions? listManagementOptions, List<String>? replyToAddresses}) → Future<SendEmailResponse>
Sends an email message. You can use the Amazon SES API v2 to send two types of messages:
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
testRenderEmailTemplate({required String templateData, required String templateName}) → Future<TestRenderEmailTemplateResponse>
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
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Remove one or more tags (keys and values) from a specified resource.
updateConfigurationSetEventDestination({required String configurationSetName, required EventDestinationDefinition eventDestination, required String eventDestinationName}) → Future<void>
Update the configuration of an event destination for a configuration set.
updateContact({required String contactListName, required String emailAddress, String? attributesData, List<TopicPreference>? topicPreferences, bool? unsubscribeAll}) → Future<void>
Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.
updateContactList({required String contactListName, String? description, List<Topic>? topics}) → Future<void>
Updates contact list metadata. This operation does a complete replacement.
updateCustomVerificationEmailTemplate({required String failureRedirectionURL, required String fromEmailAddress, required String successRedirectionURL, required String templateContent, required String templateName, required String templateSubject}) → Future<void>
Updates an existing custom verification email template.
updateEmailIdentityPolicy({required String emailIdentity, required String policy, required String policyName}) → Future<void>
Updates 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.
updateEmailTemplate({required EmailTemplateContent templateContent, required String templateName}) → 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.

Operators

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