Package-level declarations

Types

Link copied to clipboard

Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Retrieves batches of metric data collected based on your sending activity.

Link copied to clipboard

Cancels an export job.

Link copied to clipboard

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.

Link copied to clipboard

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 EventBridge and associate a rule to send the event to the specified target.

Link copied to clipboard

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Link copied to clipboard

Creates a contact list.

Link copied to clipboard
Link copied to clipboard

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services 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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Creates the specified sending authorization policy for the given identity (an email address or a domain).

Link copied to clipboard

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.

Link copied to clipboard

Creates an export job for a data source and destination.

Link copied to clipboard

Creates an import job for a data destination.

Link copied to clipboard

Creates a multi-region endpoint (global-endpoint).

Link copied to clipboard

Delete an existing configuration set.

Link copied to clipboard

Removes a contact from a contact list.

Link copied to clipboard

Deletes a contact list and all of the contacts on that list.

Link copied to clipboard

Deletes an existing custom verification email template.

Link copied to clipboard

Delete a dedicated IP pool.

Link copied to clipboard

Deletes an email identity. An identity can be either an email address or a domain name.

Link copied to clipboard

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.

Link copied to clipboard

Deletes an email template.

Link copied to clipboard

Deletes a multi-region endpoint (global-endpoint).

Link copied to clipboard

Removes an email address from the suppression list for your account.

Link copied to clipboard
inline suspend fun SesV2Client.getAccount(crossinline block: GetAccountRequest.Builder.() -> Unit): GetAccountResponse

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Link copied to clipboard

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Link copied to clipboard

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.

Link copied to clipboard

Retrieve a list of event destinations that are associated with a configuration set.

Link copied to clipboard
inline suspend fun SesV2Client.getContact(crossinline block: GetContactRequest.Builder.() -> Unit): GetContactResponse

Returns a contact from a contact list.

Link copied to clipboard

Returns contact list metadata. It does not return any information about the contacts present in the list.

Link copied to clipboard

Returns the custom email verification template for the template name you specify.

Link copied to clipboard

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.

Link copied to clipboard

Retrieve information about the dedicated pool.

Link copied to clipboard

List the dedicated IP addresses that are associated with your Amazon Web Services account.

Link copied to clipboard

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.

Link copied to clipboard

Retrieve the results of a predictive inbox placement test.

Link copied to clipboard

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.

Link copied to clipboard

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.

Link copied to clipboard
inline suspend fun SesV2Client.getExportJob(crossinline block: GetExportJobRequest.Builder.() -> Unit): GetExportJobResponse

Provides information about an export job.

Link copied to clipboard
inline suspend fun SesV2Client.getImportJob(crossinline block: GetImportJobRequest.Builder.() -> Unit): GetImportJobResponse

Provides information about an import job.

Link copied to clipboard

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.

Link copied to clipboard

Displays the multi-region endpoint (global-endpoint) configuration.

Link copied to clipboard

Retrieves information about a specific email address that's on the suppression list for your account.

Link copied to clipboard

List all of the configuration sets associated with your account in the current region.

Link copied to clipboard

Lists all of the contact lists available.

Link copied to clipboard
inline suspend fun SesV2Client.listContacts(crossinline block: ListContactsRequest.Builder.() -> Unit): ListContactsResponse

Lists the contacts present in a specific contact list.

Link copied to clipboard

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

Link copied to clipboard

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of all of the email identities that are associated with your Amazon Web Services 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.

Link copied to clipboard

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

Link copied to clipboard

Lists all of the export jobs.

Link copied to clipboard

Lists all of the import jobs.

Link copied to clipboard

List the multi-region endpoints (global-endpoints).

Link copied to clipboard

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

Link copied to clipboard

Retrieves a list of email addresses that are on the suppression list for your account.

Link copied to clipboard

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.

Link copied to clipboard

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Link copied to clipboard

Update your Amazon SES account details.

Link copied to clipboard

Enable or disable the ability of your account to send email.

Link copied to clipboard

Change the settings for the account-level suppression list.

Link copied to clipboard

Update your Amazon SES account VDM attributes.

Link copied to clipboard

Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.

Link copied to clipboard

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.

Link copied to clipboard

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Link copied to clipboard

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Link copied to clipboard

Specify the account suppression list preferences for a configuration set.

Link copied to clipboard

Specify a custom domain to use for open and click tracking elements in email that you send.

Link copied to clipboard

Specify VDM preferences for email that you send using the configuration set.

Link copied to clipboard

Move a dedicated IP address to an existing dedicated IP pool.

Link copied to clipboard

Used to convert a dedicated IP pool to a different scaling mode.

Link copied to clipboard

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.

Used to associate a configuration set with an email identity.

Link copied to clipboard

Used to enable or disable DKIM authentication for an email identity.

Link copied to clipboard

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:

Link copied to clipboard

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.

Link copied to clipboard

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Link copied to clipboard

Adds an email address to the suppression list for your account.

Link copied to clipboard

Composes an email message to multiple destinations.

Link copied to clipboard

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

Link copied to clipboard
inline suspend fun SesV2Client.sendEmail(crossinline block: SendEmailRequest.Builder.() -> Unit): SendEmailResponse

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

Link copied to clipboard
inline suspend fun SesV2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

Link copied to clipboard

Remove one or more tags (keys and values) from a specified resource.

Link copied to clipboard

Update the configuration of an event destination for a configuration set.

Link copied to clipboard

Updates a contact's preferences for a list.

Link copied to clipboard

Updates contact list metadata. This operation does a complete replacement.

Link copied to clipboard

Updates an existing custom verification email template.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.