ISESV2Client
Interface in AWS.SESV2
Interface for SESV2 service client.
Methods
BatchGetMetricData
function BatchGetMetricData( const ARequest: ISESV2BatchGetMetricDataRequest): ISESV2BatchGetMetricDataResponse; overload;
ISESV2BatchGetMetricDataRequest → ISESV2BatchGetMetricDataResponse
Retrieves batches of metric data collected based on your sending activity.
This operation provides access to Virtual Deliverability Manager (VDM) metric data for your Amazon SES account. You can execute this operation no more than 16 times per second, with at most 160 queries from the batches per second (cumulative). Supported metric types include SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, and DELIVERY_COMPLAINT. Metrics can be filtered by dimensions such as email identity, configuration set, or Internet Service Provider (ISP). Each batch request can contain between 1 and 10 metric queries.
Parameters
| Name | Description |
|---|---|
ARequest | The batch metric data request containing one or more metric queries with specified time ranges and optional dimension filters. |
Returns
A response object containing successfully retrieved metric results and any errors encountered during processing.
function BatchGetMetricData( const AQueries: TArray<ISESV2BatchGetMetricDataQuery>): ISESV2BatchGetMetricDataResponse; overload;
ISESV2BatchGetMetricDataQuery → ISESV2BatchGetMetricDataResponse
Retrieves batches of metric data for multiple queries in a single request.
This overload accepts an array of metric queries, allowing you to retrieve different metrics, time ranges, or dimension filters efficiently in one API call. You can execute this operation no more than 16 times per second, with at most 160 queries from the batches per second (cumulative). Each query in the array must have a unique Id within the request. The response will contain results correlated by these identifiers, along with any errors encountered during processing. This is particularly useful for comparing metrics (e.g., sends vs deliveries), retrieving the same metric across different time periods, or gathering metrics for multiple email identities or configuration sets.
Parameters
| Name | Description |
|---|---|
AQueries | An array of metric data queries to execute. Must contain between 1 and 10 queries, each with a unique Id within the batch request. |
Returns
A response object containing successfully retrieved metric results and any errors encountered during processing, correlated by query Id.
CancelExportJob
function CancelExportJob( const ARequest: ISESV2CancelExportJobRequest): ISESV2CancelExportJobResponse; overload;
ISESV2CancelExportJobRequest → ISESV2CancelExportJobResponse
Cancels an export job that is currently in progress.
Export jobs are used to export Virtual Deliverability Manager (VDM) metrics data or Message Insights data to CSV or JSON files. This operation allows you to cancel a job that was created using CreateExportJob but has not yet completed. Once cancelled, the export job cannot be resumed and no output file will be generated. You can create a new export job if needed. The operation returns an HTTP 200 response if successful. Export jobs can contain either VDM metrics data (sends, deliveries, opens, clicks, bounces, complaints) or Message Insights data (individual message delivery and engagement status).
Parameters
| Name | Description |
|---|---|
ARequest | The cancel export job request containing the job ID of the export job to cancel. |
Returns
A response object indicating the success of the cancellation operation.
function CancelExportJob( const AJobId: string): ISESV2CancelExportJobResponse; overload;
Cancels an export job using the specified job identifier.
This is a convenience overload that allows you to cancel an export job by providing only the job ID, without constructing a full request object. The job ID is typically obtained from the response of a CreateExportJob operation or by listing export jobs. The export job must be in progress to be successfully cancelled. Completed or already cancelled jobs cannot be cancelled again.
Parameters
| Name | Description |
|---|---|
AJobId | The unique identifier of the export job to cancel. Must be a valid job ID from a previously created export job. |
Returns
A response object indicating the success of the cancellation operation.
CreateConfigurationSet
function CreateConfigurationSet( const ARequest: ISESV2CreateConfigurationSetRequest): ISESV2CreateConfigurationSetResponse;
ISESV2CreateConfigurationSetRequest → ISESV2CreateConfigurationSetResponse
Creates a new configuration set for managing email sending policies and event tracking.
Configuration sets enable you to apply consistent sending policies, event destinations, and reputation tracking across multiple email sending operations. They provide centralized management of delivery options, suppression lists, and analytics configuration. Once created, the configuration set can be associated with email sending operations, event destinations, and reputation management policies to ensure consistent behavior and comprehensive monitoring of your email campaigns.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and optional delivery options. |
Returns
A response object indicating the successful creation of the configuration set.
CreateConfigurationSetEventDestination
function CreateConfigurationSetEventDestination( const ARequest: ISESV2CreateConfigurationSetEventDestinationRequest): ISESV2CreateConfigurationSetEventDestinationResponse;
ISESV2CreateConfigurationSetEventDestinationRequest → ISESV2CreateConfigurationSetEventDestinationResponse
Creates a new event destination for a configuration set to publish email sending events.
Event destinations enable you to publish email sending events (sends, deliveries, opens, clicks, bounces, and complaints) to external services such as Amazon EventBridge, CloudWatch, Kinesis Data Firehose, SNS, or Pinpoint for analysis and monitoring. The configuration set must exist before event destinations can be created. Multiple event destinations can be associated with a single configuration set to route events to different analytics platforms or monitoring systems.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name, event destination name, and destination settings. |
Returns
A response object indicating the successful creation of the event destination.
CreateContact
function CreateContact( const ARequest: ISESV2CreateContactRequest): ISESV2CreateContactResponse;
ISESV2CreateContactRequest → ISESV2CreateContactResponse
Creates a new contact in a contact list with subscription preferences and attributes.
This operation adds a new subscriber to a contact list with specified topic preferences and custom attributes. The contact can be configured with granular subscription settings for different email topics and categories within the list. The contact list must exist before contacts can be added. Contact attributes enable personalization of email campaigns, while topic preferences provide granular subscription management and compliance with email marketing regulations.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name, email address, topic preferences, and attributes. |
Returns
A response object indicating the successful creation of the contact.
CreateContactList
function CreateContactList( const ARequest: ISESV2CreateContactListRequest): ISESV2CreateContactListResponse;
ISESV2CreateContactListRequest → ISESV2CreateContactListResponse
Creates a new contact list for managing subscriber preferences and email campaigns.
Contact lists enable organized management of email subscribers with support for multiple topics and categories. Each contact list can define various subscription topics that allow granular control over what types of emails subscribers receive. Topics within contact lists improve subscriber engagement by providing choice and control over email preferences, leading to better compliance with email marketing regulations and reduced unsubscribe rates.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name, description, and topic definitions. |
Returns
A response object indicating the successful creation of the contact list.
CreateCustomVerificationEmailTemplate
function CreateCustomVerificationEmailTemplate( const ARequest: ISESV2CreateCustomVerificationEmailTemplateRequest): ISESV2CreateCustomVerificationEmailTemplateResponse;
ISESV2CreateCustomVerificationEmailTemplateRequest → ISESV2CreateCustomVerificationEmailTemplateResponse
Creates a new custom verification email template for branded identity verification.
Custom verification email templates enable you to brand the identity verification process to match your application's look and feel, improving user trust and completion rates during email address verification workflows. The template defines the email content, subject line, sender address, and success/failure redirection URLs for a complete verification experience. Templates must include proper verification links that Amazon SES will process automatically.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name, content, subject, and redirection URLs. |
Returns
A response object indicating the successful creation of the custom verification email template.
CreateDedicatedIpPool
function CreateDedicatedIpPool( const ARequest: ISESV2CreateDedicatedIpPoolRequest): ISESV2CreateDedicatedIpPoolResponse;
ISESV2CreateDedicatedIpPoolRequest → ISESV2CreateDedicatedIpPoolResponse
Creates a new dedicated IP pool for enhanced email delivery control and reputation management.
Dedicated IP pools provide isolated IP addresses for email sending, enabling better reputation management and deliverability control. Each pool can be configured with different scaling modes and associated with specific sending identities. Using dedicated IP pools helps separate different types of email traffic and provides more control over sender reputation by isolating transactional emails from marketing campaigns or different business units.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the pool name and scaling mode configuration. |
Returns
A response object indicating the successful creation of the dedicated IP pool.
CreateDeliverabilityTestReport
function CreateDeliverabilityTestReport( const ARequest: ISESV2CreateDeliverabilityTestReportRequest): ISESV2CreateDeliverabilityTestReportResponse;
ISESV2CreateDeliverabilityTestReportRequest → ISESV2CreateDeliverabilityTestReportResponse
Creates a new deliverability test report to analyze email placement and reputation.
Deliverability test reports provide insights into how your emails are likely to be received by major email providers, including placement in inbox, spam folder, or other categories. This helps optimize email content and sending practices. The test analyzes various factors including sender reputation, content quality, authentication setup, and compliance with email best practices to provide actionable recommendations for improving email deliverability.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the report name, content, and test configuration. |
Returns
A response object containing the test report ID and status information.
CreateEmailIdentity
function CreateEmailIdentity( const ARequest: ISESV2CreateEmailIdentityRequest): ISESV2CreateEmailIdentityResponse;
ISESV2CreateEmailIdentityRequest → ISESV2CreateEmailIdentityResponse
Creates and verifies a new email identity for sending emails through Amazon SES.
Email identities must be verified before they can be used for sending emails through Amazon SES. This operation initiates the verification process and configures the identity with DKIM authentication, feedback forwarding, and other sending options. Both individual email addresses and entire domains can be added as identities. Domain identities provide broader sending capabilities and enable subdomain usage without individual verification.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email address or domain and configuration options. |
Returns
A response object containing verification status and identity configuration details.
CreateEmailIdentityPolicy
function CreateEmailIdentityPolicy( const ARequest: ISESV2CreateEmailIdentityPolicyRequest): ISESV2CreateEmailIdentityPolicyResponse;
ISESV2CreateEmailIdentityPolicyRequest → ISESV2CreateEmailIdentityPolicyResponse
Creates a new sending authorization policy for an email identity.
This operation creates a sending authorization policy that enables other AWS accounts to send emails using your verified email identity. Sending authorization provides controlled delegation of email sending privileges to trusted third parties while maintaining ownership of the identity. The policy document must be valid JSON following AWS IAM policy syntax and defines which AWS accounts or services are authorized to send emails, under what conditions, and with what restrictions. The email identity must be verified before policies can be created. Sending authorization policies enable secure multi-account email architectures, allowing centralized identity management while distributing sending capabilities across different AWS accounts or applications.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity, policy name, and policy document. |
Returns
A response object indicating the successful creation of the email identity policy.
CreateEmailTemplate
function CreateEmailTemplate( const ARequest: ISESV2CreateEmailTemplateRequest): ISESV2CreateEmailTemplateResponse;
ISESV2CreateEmailTemplateRequest → ISESV2CreateEmailTemplateResponse
Creates a new email template for personalized bulk email campaigns.
Email templates enable efficient sending of personalized emails to multiple recipients by defining reusable content with replacement tags for dynamic personalization. Templates support both HTML and text formats for broad email client compatibility. Once created, templates can be used with bulk email operations to send personalized content at scale while maintaining consistent branding and messaging across campaigns.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name and content including subject and body. |
Returns
A response object indicating the successful creation of the email template.
CreateExportJob
function CreateExportJob( const ARequest: ISESV2CreateExportJobRequest): ISESV2CreateExportJobResponse;
ISESV2CreateExportJobRequest → ISESV2CreateExportJobResponse
Creates a new export job to extract data from Amazon SES.
Export jobs allow you to extract various types of data from your SES account, such as suppression list entries, message events, or reputation metrics. The exported data is delivered to an Amazon S3 bucket that you specify. The export process runs asynchronously. You can monitor the job status using GetExportJob or list all export jobs with ListExportJobs.
Parameters
| Name | Description |
|---|---|
ARequest | The export job configuration specifying the data type to export and the S3 destination. Contains the export destination settings and data source specification. |
Returns
A response object containing the unique job identifier for tracking the export operation.
CreateImportJob
function CreateImportJob( const ARequest: ISESV2CreateImportJobRequest): ISESV2CreateImportJobResponse;
ISESV2CreateImportJobRequest → ISESV2CreateImportJobResponse
Creates an import job for a data destination.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateImportJob request object. |
Returns
Response containing CreateImportJob results.
CreateMultiRegionEndpoint
function CreateMultiRegionEndpoint( const ARequest: ISESV2CreateMultiRegionEndpointRequest): ISESV2CreateMultiRegionEndpointResponse; overload;
ISESV2CreateMultiRegionEndpointRequest → ISESV2CreateMultiRegionEndpointResponse
Creates a multi-region endpoint for Amazon SES to enable cross-region email sending capabilities.
Multi-region endpoints allow you to send emails from multiple AWS regions using a single endpoint configuration, providing improved resilience and geographic distribution. This operation requires appropriate IAM permissions for SES multi-region endpoint management. The endpoint becomes available for use once the creation process completes successfully.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the multi-region endpoint configuration details including endpoint name, regions, and routing preferences. |
Returns
A response object containing the created multi-region endpoint details including the endpoint ARN, status, and configuration metadata.
function CreateMultiRegionEndpoint(const AEndpointName: string; const ARegions: TArray<string>): ISESV2CreateMultiRegionEndpointResponse; overload;
ISESV2CreateMultiRegionEndpointResponse
Creates a multi-region endpoint with the specified name and target regions.
Parameters
| Name | Description |
|---|---|
AEndpointName | The name for the multi-region endpoint. |
ARegions | Specify a list of AWS region names where the endpoint should be available. |
Returns
A response object containing the created multi-region endpoint details.
CreateTenant
function CreateTenant( const ARequest: ISESV2CreateTenantRequest): ISESV2CreateTenantResponse; overload;
ISESV2CreateTenantRequest → ISESV2CreateTenantResponse
Creates a new tenant to logically isolate and manage SES resources.
Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This operation helps isolate and manage email sending for different customers or business units within your Amazon SES API account. By default, accounts can create up to 10,000 tenants, with increases available through the AWS Service Quota Console up to 300,000 tenants for qualifying accounts.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing tenant creation parameters including the tenant name. |
Returns
A response object containing the created tenant details including tenant ID and status.
function CreateTenant( const ATenantName: string): ISESV2CreateTenantResponse; overload;
Creates a new tenant with the specified name to logically isolate and manage SES resources.
This is a convenience overload that creates a tenant with just the tenant name parameter. Tenants enable isolation of email sending reputation and resources between different customers or business units, helping maintain deliverability and accountability.
Parameters
| Name | Description |
|---|---|
ATenantName | The name for the new tenant. Must be unique within your AWS account and region. |
Returns
A response object containing the created tenant details including tenant ID and status.
CreateTenantResourceAssociation
function CreateTenantResourceAssociation( const ARequest: ISESV2CreateTenantResourceAssociationRequest): ISESV2CreateTenantResourceAssociationResponse; overload;
ISESV2CreateTenantResourceAssociationRequest → ISESV2CreateTenantResourceAssociationResponse
Associates a resource with a tenant in Amazon SES.
This operation allows you to associate SES resources such as email identities, configuration sets, or email templates with a specific tenant. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant. A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations. Supported resource types include:
- Email identities (verified email addresses or domains)
- Configuration sets
- Email templates
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the tenant name and resource ARN to associate. |
Returns
A response object containing the details of the created tenant resource association.
function CreateTenantResourceAssociation(const ATenantName: string; const AResourceArn: TARN): ISESV2CreateTenantResourceAssociationResponse; overload;
ISESV2CreateTenantResourceAssociationResponse
Associates a resource with a tenant using simplified parameters.
This overload provides a convenient way to associate a resource with a tenant by directly specifying the tenant name and resource ARN without creating a full request object. The resource specified by AResourceArn must be an existing SES resource in the same AWS region as the tenant.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to associate the resource with. The tenant must already exist. |
AResourceArn | The Amazon Resource Name (ARN) of the SES resource to associate with the tenant. This can be an email identity, configuration set, or email template ARN. |
Returns
A response object containing the details of the created tenant resource association.
DeleteConfigurationSet
function DeleteConfigurationSet( const ARequest: ISESV2DeleteConfigurationSetRequest): ISESV2DeleteConfigurationSetResponse; overload;
ISESV2DeleteConfigurationSetRequest → ISESV2DeleteConfigurationSetResponse
Deletes an existing configuration set.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteConfigurationSet request object. |
Returns
Response containing DeleteConfigurationSet results.
function DeleteConfigurationSet( const AConfigurationSetName: string): ISESV2DeleteConfigurationSetResponse; overload;
ISESV2DeleteConfigurationSetResponse
Deletes an existing configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | Specify the name of an existing configuration set to delete. |
Returns
Response containing DeleteConfigurationSet results.
DeleteConfigurationSetEventDestination
function DeleteConfigurationSetEventDestination( const ARequest: ISESV2DeleteConfigurationSetEventDestinationRequest): ISESV2DeleteConfigurationSetEventDestinationResponse; overload;
ISESV2DeleteConfigurationSetEventDestinationRequest → ISESV2DeleteConfigurationSetEventDestinationResponse
Deletes an event destination from a configuration set.
Event destinations are places where you can send information about email sending events such as message sends, deliveries, opens, clicks, bounces, and complaints. Examples of event destinations include Amazon EventBridge, Amazon CloudWatch, Amazon Kinesis Data Firehose, and Amazon SNS.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and event destination name to delete. |
Returns
A response object confirming the successful deletion of the event destination.
function DeleteConfigurationSetEventDestination( const AConfigurationSetName, AEventDestinationName: string): ISESV2DeleteConfigurationSetEventDestinationResponse; overload;
ISESV2DeleteConfigurationSetEventDestinationResponse
Deletes an event destination from a configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set that contains the event destination to delete. |
AEventDestinationName | The name of the event destination to delete. |
Returns
A response object confirming the successful deletion of the event destination.
DeleteContact
function DeleteContact( const ARequest: ISESV2DeleteContactRequest): ISESV2DeleteContactResponse; overload;
ISESV2DeleteContactRequest → ISESV2DeleteContactResponse
Removes a contact from a contact list.
Contact lists are collections of email addresses used for sending bulk email campaigns and managing email subscriptions. This operation permanently removes the specified contact from the target contact list. The contact list and email address must exist for the operation to succeed. Email address matching is case-sensitive.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name and email address of the contact to remove. |
Returns
A response object confirming the successful removal of the contact from the contact list.
function DeleteContact( const AContactListName, AEmailAddress: string): ISESV2DeleteContactResponse; overload;
Removes a contact from a contact list.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list from which the contact should be removed. |
AEmailAddress | The email address of the contact to remove from the contact list. |
Returns
A response object confirming the successful removal of the contact from the contact list.
DeleteContactList
function DeleteContactList( const ARequest: ISESV2DeleteContactListRequest): ISESV2DeleteContactListResponse; overload;
ISESV2DeleteContactListRequest → ISESV2DeleteContactListResponse
Deletes a contact list and all of the contacts on that list.
This operation permanently removes the entire contact list and all email addresses contained within it. Contact lists are collections of email addresses used for bulk email campaigns and subscription management. Once deleted, the contact list and all associated contacts cannot be recovered. Use this operation with extreme caution as it is irreversible. The contact list must exist for the deletion operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the contact list to delete. |
Returns
A response object confirming the successful deletion of the contact list and all its contacts.
function DeleteContactList( const AContactListName: string): ISESV2DeleteContactListResponse; overload;
ISESV2DeleteContactListResponse
Deletes a contact list and all of the contacts on that list.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list to delete. |
Returns
A response object confirming the successful deletion of the contact list and all its contacts.
DeleteCustomVerificationEmailTemplate
function DeleteCustomVerificationEmailTemplate( const ARequest: ISESV2DeleteCustomVerificationEmailTemplateRequest): ISESV2DeleteCustomVerificationEmailTemplateResponse; overload;
ISESV2DeleteCustomVerificationEmailTemplateRequest → ISESV2DeleteCustomVerificationEmailTemplateResponse
Deletes an existing custom verification email template.
Custom verification email templates provide a customized experience for email address verification when adding identities to your SES account. These templates allow you to control the content, styling, and branding of verification emails sent to users. Once deleted, the template cannot be recovered and will no longer be available for use in email verification workflows. You can execute this operation no more than once per second due to AWS rate limiting.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the custom verification email template to delete. |
Returns
A response object confirming the successful deletion of the custom verification email template.
function DeleteCustomVerificationEmailTemplate( const ATemplateName: string): ISESV2DeleteCustomVerificationEmailTemplateResponse; overload;
ISESV2DeleteCustomVerificationEmailTemplateResponse
Deletes an existing custom verification email template.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the custom verification email template to delete. |
Returns
A response object confirming the successful deletion of the custom verification email template.
DeleteDedicatedIpPool
function DeleteDedicatedIpPool( const ARequest: ISESV2DeleteDedicatedIpPoolRequest): ISESV2DeleteDedicatedIpPoolResponse; overload;
ISESV2DeleteDedicatedIpPoolRequest → ISESV2DeleteDedicatedIpPoolResponse
Deletes a dedicated IP pool.
Dedicated IP pools are collections of one or more dedicated IP addresses that are associated with your AWS account. These pools can be associated with configuration sets to control which IP addresses are used when sending emails. Deleting a dedicated IP pool removes the pool entirely but does not affect the dedicated IP addresses themselves. The IP addresses remain in your account and can be assigned to other pools or used individually. The pool must exist and cannot be currently associated with any configuration sets for the deletion operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the dedicated IP pool to delete. |
Returns
A response object confirming the successful deletion of the dedicated IP pool.
function DeleteDedicatedIpPool( const APoolName: string): ISESV2DeleteDedicatedIpPoolResponse; overload;
ISESV2DeleteDedicatedIpPoolResponse
Deletes a dedicated IP pool.
Parameters
| Name | Description |
|---|---|
APoolName | The name of the dedicated IP pool to delete. |
Returns
A response object confirming the successful deletion of the dedicated IP pool.
DeleteEmailIdentity
function DeleteEmailIdentity( const ARequest: ISESV2DeleteEmailIdentityRequest): ISESV2DeleteEmailIdentityResponse; overload;
ISESV2DeleteEmailIdentityRequest → ISESV2DeleteEmailIdentityResponse
Deletes an email identity.
An email identity can be either a specific email address (e.g., user@example.com) or an entire domain name (e.g., example.com). Email identities must be verified before they can be used to send emails through SES. Deleting an email identity permanently removes it from your SES account and revokes your ability to send emails from that address or domain. This action cannot be undone and will affect any applications or services that depend on this identity for email delivery. The identity must exist in your SES account for the deletion operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity to delete. |
Returns
A response object confirming the successful deletion of the email identity.
function DeleteEmailIdentity( const AEmailIdentity: string): ISESV2DeleteEmailIdentityResponse; overload;
ISESV2DeleteEmailIdentityResponse
Deletes an email identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The email identity to delete. Can be either an email address or a domain name. |
Returns
A response object confirming the successful deletion of the email identity.
DeleteEmailIdentityPolicy
function DeleteEmailIdentityPolicy( const ARequest: ISESV2DeleteEmailIdentityPolicyRequest): ISESV2DeleteEmailIdentityPolicyResponse; overload;
ISESV2DeleteEmailIdentityPolicyRequest → ISESV2DeleteEmailIdentityPolicyResponse
Deletes the specified sending authorization policy for the given identity.
Sending authorization is a feature that enables an identity owner to authorize other AWS accounts to send emails on their behalf from the specified identity. Policies define which AWS accounts are granted permission and under what conditions. This operation returns successfully even if a policy with the specified name does not exist, making it safe to use for cleanup operations without needing to check if the policy exists first. The identity must be verified and owned by the calling AWS account. You can execute this operation no more than once per second due to AWS rate limiting.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity and policy name for the sending authorization policy to delete. |
Returns
A response object confirming the successful deletion of the sending authorization policy.
function DeleteEmailIdentityPolicy( const AEmailIdentity, APolicyName: string): ISESV2DeleteEmailIdentityPolicyResponse; overload;
ISESV2DeleteEmailIdentityPolicyResponse
Deletes the specified sending authorization policy for the given identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The email identity from which to delete the sending authorization policy. Can be either an email address or a domain name. |
APolicyName | The name of the sending authorization policy to delete. |
Returns
A response object confirming the successful deletion of the sending authorization policy.
DeleteEmailTemplate
function DeleteEmailTemplate( const ARequest: ISESV2DeleteEmailTemplateRequest): ISESV2DeleteEmailTemplateResponse; overload;
ISESV2DeleteEmailTemplateRequest → ISESV2DeleteEmailTemplateResponse
Deletes an email template.
Email templates are reusable message formats that contain placeholders for dynamic content. They enable consistent branding and messaging across bulk email campaigns while allowing personalization through template variables. Once deleted, the template cannot be recovered and will no longer be available for use in email sending operations. Any applications or processes that depend on this template will fail when attempting to use it. The template must exist in your SES account for the deletion operation to succeed. You can execute this operation no more than once per second due to AWS rate limiting.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the email template to delete. |
Returns
A response object confirming the successful deletion of the email template.
function DeleteEmailTemplate( const ATemplateName: string): ISESV2DeleteEmailTemplateResponse; overload;
ISESV2DeleteEmailTemplateResponse
Deletes an email template.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the email template to delete. |
Returns
A response object confirming the successful deletion of the email template.
DeleteMultiRegionEndpoint
function DeleteMultiRegionEndpoint( const ARequest: ISESV2DeleteMultiRegionEndpointRequest): ISESV2DeleteMultiRegionEndpointResponse; overload;
ISESV2DeleteMultiRegionEndpointRequest → ISESV2DeleteMultiRegionEndpointResponse
Deletes a multi-region endpoint (global-endpoint).
Multi-region endpoints (global-endpoints) enable you to send emails across multiple AWS regions while maintaining consistent performance and failover capabilities. These endpoints provide geographic redundancy for email delivery. Only multi-region endpoints whose primary region matches the AWS region where this operation is executed can be deleted. You cannot delete endpoints from a region other than their primary region. The deletion operation is asynchronous and the endpoint status will transition to DELETING before final removal. Monitor the status to confirm completion of the deletion process.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the multi-region endpoint to delete. |
Returns
A response object containing the current status of the multi-region endpoint immediately after the deletion request.
function DeleteMultiRegionEndpoint( const AEndpointName: string): ISESV2DeleteMultiRegionEndpointResponse; overload;
ISESV2DeleteMultiRegionEndpointResponse
Deletes a multi-region endpoint (global-endpoint).
Parameters
| Name | Description |
|---|---|
AEndpointName | The name of the multi-region endpoint (global-endpoint) to delete. |
Returns
A response object containing the current status of the multi-region endpoint immediately after the deletion request.
DeleteSuppressedDestination
function DeleteSuppressedDestination( const ARequest: ISESV2DeleteSuppressedDestinationRequest): ISESV2DeleteSuppressedDestinationResponse; overload;
ISESV2DeleteSuppressedDestinationRequest → ISESV2DeleteSuppressedDestinationResponse
Removes an email address from the suppression list for your account.
The suppression list contains email addresses that have been automatically blocked from receiving emails due to bounces or complaints. Email addresses are typically added to this list when they generate hard bounces or when recipients mark messages as spam. Removing an address from the suppression list allows you to resume sending emails to that destination. However, use caution when removing addresses, as sending to addresses that previously bounced or complained may negatively impact your sender reputation and email deliverability. The email address must currently exist in your account's suppression list for the removal operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email address to remove from the suppression list. |
Returns
A response object confirming the successful removal of the email address from the suppression list.
function DeleteSuppressedDestination( const AEmailAddress: string): ISESV2DeleteSuppressedDestinationResponse; overload;
ISESV2DeleteSuppressedDestinationResponse
Removes an email address from the suppression list for your account.
Parameters
| Name | Description |
|---|---|
AEmailAddress | The email address to remove from the account suppression list. |
Returns
A response object confirming the successful removal of the email address from the suppression list.
DeleteTenant
function DeleteTenant( const ARequest: ISESV2DeleteTenantRequest): ISESV2DeleteTenantResponse; overload;
ISESV2DeleteTenantRequest → ISESV2DeleteTenantResponse
Deletes an existing tenant.
Tenants in SES provide multi-tenancy capabilities, allowing you to organize and isolate resources within your AWS account. Tenants can be associated with various SES resources such as identities, configuration sets, and dedicated IP pools. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted. The associated resources remain available in your account and can be reassigned to other tenants or used independently. The tenant must exist in your account for the deletion operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the tenant to delete. |
Returns
A response object confirming the successful deletion of the tenant.
function DeleteTenant( const ATenantName: string): ISESV2DeleteTenantResponse; overload;
Deletes an existing tenant.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to delete. |
Returns
A response object confirming the successful deletion of the tenant.
DeleteTenantResourceAssociation
function DeleteTenantResourceAssociation( const ARequest: ISESV2DeleteTenantResourceAssociationRequest): ISESV2DeleteTenantResourceAssociationResponse; overload;
ISESV2DeleteTenantResourceAssociationRequest → ISESV2DeleteTenantResourceAssociationResponse
Deletes an association between a tenant and a resource.
Tenant-resource associations enable multi-tenant organization of SES resources. Resources such as identities, configuration sets, and dedicated IP pools can be associated with specific tenants to provide isolation and organized management within your AWS account. When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations, but remains available in your account. Both the tenant and the resource must exist, and the association between them must be present for the deletion operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the tenant name and resource ARN for the association to delete. |
Returns
A response object confirming the successful deletion of the tenant-resource association.
function DeleteTenantResourceAssociation(const ATenentName: string; const AResourceArn: TARN): ISESV2DeleteTenantResourceAssociationResponse; overload;
ISESV2DeleteTenantResourceAssociationResponse
Deletes an association between a tenant and a resource.
Parameters
| Name | Description |
|---|---|
ATenentName | The name of the tenant to remove the resource association from. |
AResourceArn | The Amazon Resource Name (ARN) of the resource to remove from the tenant association. |
Returns
A response object confirming the successful deletion of the tenant-resource association.
GetAccount
function GetAccount(const ARequest: ISESV2GetAccountRequest): ISESV2GetAccountResponse; overload;
ISESV2GetAccountRequest → ISESV2GetAccountResponse
Obtains information about the email-sending status and capabilities of your Amazon SES account.
This operation retrieves comprehensive information about your SES account configuration in the current AWS region, including sending quotas, enforcement status, production access level, and various account settings that affect email delivery capabilities. The response includes critical information such as whether your account is in sandbox mode, your daily sending limits, dedicated IP configuration, suppression list settings, and Virtual Deliverability Manager (VDM) attributes. Use this operation to programmatically check account status, monitor sending quotas, and verify configuration settings for automated account management and monitoring.
Parameters
| Name | Description |
|---|---|
ARequest | The request object for retrieving account information. This request takes no parameters. |
Returns
A response object containing comprehensive information about your SES account status, capabilities, and configuration.
function GetAccount: ISESV2GetAccountResponse; overload;
Obtains information about the email-sending status and capabilities of your Amazon SES account.
Returns
A response object containing comprehensive information about your SES account status, capabilities, and configuration.
GetBlacklistReports
function GetBlacklistReports(const ARequest: ISESV2GetBlacklistReportsRequest): ISESV2GetBlacklistReportsResponse; overload;
ISESV2GetBlacklistReportsRequest → ISESV2GetBlacklistReportsResponse
Retrieves a list of the blacklists that your dedicated IP addresses appear on.
This operation checks multiple Real-time Blackhole Lists (RBLs) and Domain Name System Blacklists (DNSBLs) to determine if any of your dedicated IP addresses have been listed. Blacklist entries can significantly impact email deliverability by causing messages to be blocked or filtered as spam. The response provides detailed information for each IP address, including the specific blacklist names, listing timestamps, and descriptions of why the IP was blacklisted. This information is essential for reputation monitoring and proactive deliverability management. Regular monitoring of blacklist status helps identify reputation issues early, allowing you to take corrective action before significant deliverability impact occurs. Common causes include compromised accounts, policy violations, or suspicious sending patterns.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the list of dedicated IP addresses to check for blacklist entries. |
Returns
A response object containing blacklist information for each requested IP address, organized as a mapping of IP addresses to their associated blacklist entries.
function GetBlacklistReports(const ABlacklistItemNames: array of string): ISESV2GetBlacklistReportsResponse; overload;
ISESV2GetBlacklistReportsResponse
Retrieves a list of the blacklists that your dedicated IP addresses appear on.
Parameters
| Name | Description |
|---|---|
ABlacklistItemNames | An array of dedicated IP addresses to check for blacklist entries. Only IP addresses associated with your AWS account can be specified. |
Returns
A response object containing blacklist information for each requested IP address, organized as a mapping of IP addresses to their associated blacklist entries.
GetConfigurationSet
function GetConfigurationSet( const ARequest: ISESV2GetConfigurationSetRequest): ISESV2GetConfigurationSetResponse; overload;
ISESV2GetConfigurationSetRequest → ISESV2GetConfigurationSetResponse
Retrieves information about an existing configuration set.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the email headers. When applied, all rules in the configuration set are automatically applied to the email. This operation returns comprehensive information including the dedicated IP pool association, sending enablement status, reputation tracking settings, suppression options, delivery preferences, tracking configurations, and VDM settings. Configuration sets enable fine-grained control over email sending behavior, allowing you to customize delivery options, reputation management, event tracking, and compliance settings for different types of email campaigns or applications.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the name of the configuration set to retrieve. |
Returns
A response object containing comprehensive configuration details including delivery options, reputation settings, suppression preferences, tracking configurations, and VDM attributes.
function GetConfigurationSet( const AConfigurationSetName: string): ISESV2GetConfigurationSetResponse; overload;
ISESV2GetConfigurationSetResponse
Retrieves information about an existing configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set to retrieve information for. |
Returns
A response object containing comprehensive configuration details including delivery options, reputation settings, suppression preferences, tracking configurations, and VDM attributes.
GetConfigurationSetEventDestinations
function GetConfigurationSetEventDestinations( const ARequest: ISESV2GetConfigurationSetEventDestinationsRequest): ISESV2GetConfigurationSetEventDestinationsResponse; overload;
ISESV2GetConfigurationSetEventDestinationsRequest → ISESV2GetConfigurationSetEventDestinationsResponse
Retrieves all event destinations associated with a configuration set.
Event destinations define where Amazon SES sends information about email events such as sends, deliveries, opens, clicks, bounces, complaints, and delivery delays. These destinations can target various AWS services including Amazon CloudWatch, Amazon EventBridge, Amazon Kinesis Data Firehose, Amazon SNS, and Amazon Pinpoint. This operation requires no special permissions beyond standard SES API access and returns an empty array if no event destinations are configured for the specified configuration set.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the configuration set name and any additional parameters. |
Returns
A response object containing an array of event destinations configured for the specified configuration set.
function GetConfigurationSetEventDestinations( const AConfigurationSetName: string): ISESV2GetConfigurationSetEventDestinationsResponse; overload;
ISESV2GetConfigurationSetEventDestinationsResponse
Retrieves all event destinations associated with a configuration set.
This is a convenience overload that creates the request object internally using the provided configuration set name. The configuration set name is case-sensitive and must match exactly with an existing configuration set in your AWS account.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set that contains the event destinations to retrieve. |
Returns
A response object containing an array of event destinations configured for the specified configuration set.
GetContact
function GetContact( const ARequest: ISESV2GetContactRequest): ISESV2GetContactResponse; overload;
ISESV2GetContactRequest → ISESV2GetContactResponse
Retrieves a contact from a contact list.
This method returns comprehensive information about a specific contact including their email address, custom attribute data, topic subscription preferences, creation and last updated timestamps, and global unsubscribe status. The contact is identified by the combination of contact list name and email address, which together form a unique key within your AWS account. Both the contact list and the specified email address must exist for the operation to succeed.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the contact list name and email address of the contact to retrieve. |
Returns
A response object containing the contact's details, attributes, subscription preferences, and metadata.
function GetContact( const AContactListName, AEmailAddress: string): ISESV2GetContactResponse; overload;
Retrieves a contact from a contact list.
This is a convenience overload that creates the request object internally using the provided contact list name and email address. Both parameters are case-sensitive and must match exactly with existing resources in your AWS account.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list to which the contact belongs. |
AEmailAddress | The email address of the contact to retrieve. |
Returns
A response object containing the contact's details, attributes, subscription preferences, and metadata.
GetContactList
function GetContactList( const ARequest: ISESV2GetContactListRequest): ISESV2GetContactListResponse; overload;
ISESV2GetContactListRequest → ISESV2GetContactListResponse
Retrieves contact list metadata without returning information about individual contacts.
This method returns comprehensive metadata about a contact list including its description, configured topics for subscription management, associated tags, creation timestamp, and last updated timestamp. It does not return any information about individual contacts present in the list. Topics within the contact list define interest groups or categories that contacts can subscribe to independently, enabling granular subscription management and audience segmentation for your email campaigns.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the contact list name to retrieve. |
Returns
A response object containing the contact list's metadata including description, topics, tags, and timestamps.
function GetContactList( const AContactListName: string): ISESV2GetContactListResponse; overload;
Retrieves contact list metadata without returning information about individual contacts.
This is a convenience overload that creates the request object internally using the provided contact list name. The contact list name is case-sensitive and must match exactly with an existing contact list in your AWS account.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list to retrieve metadata for. |
Returns
A response object containing the contact list's metadata including description, topics, tags, and timestamps.
GetCustomVerificationEmailTemplate
function GetCustomVerificationEmailTemplate( const ARequest: ISESV2GetCustomVerificationEmailTemplateRequest): ISESV2GetCustomVerificationEmailTemplateResponse; overload;
ISESV2GetCustomVerificationEmailTemplateRequest → ISESV2GetCustomVerificationEmailTemplateResponse
Retrieves the configuration details of a custom verification email template.
This method returns comprehensive configuration details for a custom verification email template including the HTML content, subject line, sender email address, success redirection URL, and failure redirection URL. Custom verification email templates are used to send branded verification emails when adding new email addresses to your verified identities. The verification process allows recipients to confirm ownership of their email address by clicking a verification link, which redirects them to either the success or failure URL based on the verification outcome. This operation can be executed no more than once per second.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the template name to retrieve. |
Returns
A response object containing the template's content, subject, sender address, and redirection URLs.
function GetCustomVerificationEmailTemplate( const ATemplateName: string): ISESV2GetCustomVerificationEmailTemplateResponse; overload;
ISESV2GetCustomVerificationEmailTemplateResponse
Retrieves the configuration details of a custom verification email template.
This is a convenience overload that creates the request object internally using the provided template name. The template name must be at least 1 character in length and must match exactly with an existing custom verification email template in your AWS account.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the custom verification email template to retrieve. |
Returns
A response object containing the template's content, subject, sender address, and redirection URLs.
GetDedicatedIp
function GetDedicatedIp( const ARequest: ISESV2GetDedicatedIpRequest): ISESV2GetDedicatedIpResponse; overload;
ISESV2GetDedicatedIpRequest → ISESV2GetDedicatedIpResponse
Retrieves information about a dedicated IP address including pool association and warm-up status.
This method returns comprehensive information about a dedicated IP address including the name of the dedicated IP pool it belongs to, its current warm-up status, and the percentage of the warm-up process that has been completed. Dedicated IP addresses provide better control over sender reputation compared to shared IP addresses. The warm-up process is automatically managed by Amazon SES and gradually increases sending volume from new dedicated IPs to establish positive reputation with email providers. This information is essential for monitoring deliverability performance and planning email campaigns.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the dedicated IP address to query. |
Returns
A response object containing detailed information about the dedicated IP address.
function GetDedicatedIp( const AIP: string): ISESV2GetDedicatedIpResponse; overload;
Retrieves information about a dedicated IP address including pool association and warm-up status.
This is a convenience overload that creates the request object internally using the provided IP address. The IP address must be a dedicated IP that is currently associated with your AWS account.
Parameters
| Name | Description |
|---|---|
AIP | The dedicated IP address for which to retrieve information. |
Returns
A response object containing detailed information about the dedicated IP address.
GetDedicatedIpPool
function GetDedicatedIpPool( const ARequest: ISESV2GetDedicatedIpPoolRequest): ISESV2GetDedicatedIpPoolResponse; overload;
ISESV2GetDedicatedIpPoolRequest → ISESV2GetDedicatedIpPoolResponse
Retrieves information about a dedicated IP pool including its configuration and scaling mode.
This method returns comprehensive information about a dedicated IP pool including its name and scaling mode configuration. Dedicated IP pools are used to organize and manage groups of dedicated IP addresses for different email sending purposes, campaigns, or organizational units. Pools can be associated with configuration sets to control which dedicated IPs are used when sending emails through specific configuration sets. The scaling mode determines how the pool automatically manages IP allocation and capacity based on your sending volume requirements.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the pool name to retrieve information for. |
Returns
A response object containing detailed information about the dedicated IP pool.
function GetDedicatedIpPool( const APoolName: string): ISESV2GetDedicatedIpPoolResponse; overload;
ISESV2GetDedicatedIpPoolResponse
Retrieves information about a dedicated IP pool including its configuration and scaling mode.
This is a convenience overload that creates the request object internally using the provided pool name. The pool name is case-sensitive and must match exactly with an existing dedicated IP pool in your AWS account.
Parameters
| Name | Description |
|---|---|
APoolName | The name of the dedicated IP pool to retrieve information for. |
Returns
A response object containing detailed information about the dedicated IP pool.
GetDedicatedIps
function GetDedicatedIps( const ARequest: ISESV2GetDedicatedIpsRequest): ISESV2GetDedicatedIpsResponse;
ISESV2GetDedicatedIpsRequest → ISESV2GetDedicatedIpsResponse
Retrieves a list of dedicated IP addresses associated with your AWS account.
This method returns a paginated list of all dedicated IP addresses associated with your AWS account, including details about each IP's pool assignment, warm-up status, and warm-up completion percentage. Results can be filtered by pool name and controlled through pagination parameters. Dedicated IP addresses provide better control over email sender reputation compared to shared IP addresses. The warm-up information helps you monitor the readiness of new dedicated IPs for high-volume email campaigns.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing optional pagination and filtering parameters. |
Returns
A response object containing an array of dedicated IP addresses and optional pagination token.
GetDeliverabilityDashboardOptions
function GetDeliverabilityDashboardOptions( const ARequest: ISESV2GetDeliverabilityDashboardOptionsRequest): ISESV2GetDeliverabilityDashboardOptionsResponse; overload;
ISESV2GetDeliverabilityDashboardOptionsRequest → ISESV2GetDeliverabilityDashboardOptionsResponse
Retrieves the current status and configuration of the Deliverability dashboard for your account.
This method returns comprehensive information about your Deliverability dashboard subscription including the current account status, whether the dashboard is enabled, active subscribed domains, domains with pending expiration, and subscription expiry dates. When the Deliverability dashboard is enabled, you gain access to reputation metrics, deliverability insights, and predictive inbox placement testing capabilities for your verified domains. The dashboard incurs a monthly subscription charge in addition to standard Amazon SES usage fees.
Parameters
| Name | Description |
|---|---|
ARequest | A request object for retrieving deliverability dashboard options. |
Returns
A response object containing dashboard status, subscription details, and domain tracking configurations.
function GetDeliverabilityDashboardOptions: ISESV2GetDeliverabilityDashboardOptionsResponse; overload;
ISESV2GetDeliverabilityDashboardOptionsResponse
Retrieves the current status and configuration of the Deliverability dashboard for your account.
This is a convenience overload that creates the request object internally. The GetDeliverabilityDashboardOptions API does not require any request parameters as it retrieves account-level dashboard configuration and subscription information.
Returns
A response object containing dashboard status, subscription details, and domain tracking configurations.
GetDeliverabilityTestReport
function GetDeliverabilityTestReport( const ARequest: ISESV2GetDeliverabilityTestReportRequest): ISESV2GetDeliverabilityTestReportResponse; overload;
ISESV2GetDeliverabilityTestReportRequest → ISESV2GetDeliverabilityTestReportResponse
Retrieves the comprehensive results of a predictive inbox placement test.
This method returns comprehensive results from a predictive inbox placement test including overall placement statistics, ISP-specific placement data, authentication success rates, and the original test message content. Results are only available for tests with a status of COMPLETE. Predictive inbox placement tests help predict how your messages will be handled by various email providers around the world by sending sample content to special addresses across major ISPs. Tests typically complete within 24 hours and provide actionable insights for optimizing email deliverability and authentication configurations.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the report identifier for the deliverability test to retrieve. |
Returns
A response object containing detailed test results, placement statistics, and ISP-specific data.
function GetDeliverabilityTestReport( const AReportId: string): ISESV2GetDeliverabilityTestReportResponse; overload;
ISESV2GetDeliverabilityTestReportResponse
Retrieves the comprehensive results of a predictive inbox placement test.
This is a convenience overload that creates the request object internally using the provided report ID. The report ID is obtained when creating a deliverability test and serves as the permanent identifier for accessing the test results.
Parameters
| Name | Description |
|---|---|
AReportId | The unique identifier of the predictive inbox placement test report to retrieve. |
Returns
A response object containing detailed test results, placement statistics, and ISP-specific data.
GetDomainDeliverabilityCampaign
function GetDomainDeliverabilityCampaign( const ARequest: ISESV2GetDomainDeliverabilityCampaignRequest): ISESV2GetDomainDeliverabilityCampaignResponse; overload;
ISESV2GetDomainDeliverabilityCampaignRequest → ISESV2GetDomainDeliverabilityCampaignResponse
Retrieves comprehensive deliverability data and analytics for a specific email campaign.
This method returns comprehensive deliverability analytics for a specific email campaign including engagement metrics (open rates, delete rates, read-delete rates), inbox and spam placement counts, ESP distribution, sending IP addresses, campaign metadata, and execution timeframes. Deliverability data is only available for campaigns that sent email using a domain with an active Deliverability dashboard subscription. The campaign must have been executed through Amazon SES with deliverability tracking enabled to generate the comprehensive analytics and performance insights returned by this operation.
Parameters
| Name | Description |
|---|---|
ARequest | A request object containing the campaign identifier for which to retrieve deliverability data. |
Returns
A response object containing detailed campaign analytics including engagement metrics, placement statistics, and infrastructure data.
function GetDomainDeliverabilityCampaign( const ACampaignId: string): ISESV2GetDomainDeliverabilityCampaignResponse; overload;
ISESV2GetDomainDeliverabilityCampaignResponse
Retrieves comprehensive deliverability data and analytics for a specific email campaign.
This is a convenience overload that creates the request object internally using the provided campaign ID. The campaign ID is automatically generated and assigned by the Deliverability dashboard when email campaigns are detected and must correspond to a campaign that used a monitored domain.
Parameters
| Name | Description |
|---|---|
ACampaignId | The unique identifier for the email campaign to retrieve deliverability data for. |
Returns
A response object containing detailed campaign analytics including engagement metrics, placement statistics, and infrastructure data.
GetDomainStatisticsReport
function GetDomainStatisticsReport( const ARequest: ISESV2GetDomainStatisticsReportRequest): ISESV2GetDomainStatisticsReportResponse; overload;
ISESV2GetDomainStatisticsReportRequest → ISESV2GetDomainStatisticsReportResponse
Retrieves inbox placement and engagement rates for the domains that you use to send email.
This operation provides detailed deliverability analytics for verified domains in your AWS account. The statistics include both daily breakdowns and aggregated summaries across the specified date range. The response includes ISP-specific placement data, allowing you to identify which email providers are successfully delivering your messages and which may require attention to improve deliverability. The date range specified in the request must not exceed 30 days, and the domain must be verified in your Amazon SES account with deliverability tracking enabled.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the domain name and date range parameters for retrieving deliverability metrics. |
Returns
A response object containing daily and overall volume statistics, including inbox placement rates, spam folder placement rates, and ISP-specific breakdowns for the specified domain and time period.
function GetDomainStatisticsReport( const ADomain: string; AStartDate, AEndDate: TDate): ISESV2GetDomainStatisticsReportResponse; overload;
ISESV2GetDomainStatisticsReportResponse
Retrieves inbox placement and engagement rates for the specified domain and date range.
This convenience overload automatically constructs the request object using the provided parameters. The date values are converted to Unix timestamps as required by the Amazon SES API. This method provides the same detailed deliverability analytics as the primary overload, including daily volume breakdowns and overall summary statistics with ISP-specific placement data.
Parameters
| Name | Description |
|---|---|
ADomain | The domain that you want to obtain deliverability metrics for. The domain must be verified in your Amazon SES account. |
AStartDate | The first day that you want to obtain domain deliverability metrics for. |
AEndDate | The last day that you want to obtain domain deliverability metrics for. Must be less than or equal to 30 days after the start date. |
Returns
A response object containing daily and overall volume statistics, including inbox placement rates, spam folder placement rates, and ISP-specific breakdowns for the specified domain and time period.
GetEmailIdentity
function GetEmailIdentity( const ARequest: ISESV2GetEmailIdentityRequest): ISESV2GetEmailIdentityResponse; overload;
ISESV2GetEmailIdentityRequest → ISESV2GetEmailIdentityResponse
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.
This operation retrieves detailed information about an email identity (email address or domain) associated with your Amazon SES account. The identity does not need to be verified to use this operation. The response includes verification status, DKIM authentication settings, custom Mail-From domain configuration, sending authorization policies, associated tags, and default configuration set information. This operation is useful for checking the current status and configuration of your email identities, troubleshooting verification issues, and auditing identity settings.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity for which to retrieve detailed information. |
Returns
A response object containing comprehensive identity information including verification status, DKIM configuration, Mail-From attributes, sending policies, tags, and configuration set assignments.
function GetEmailIdentity( const AEmailIdentity: string): ISESV2GetEmailIdentityResponse; overload;
ISESV2GetEmailIdentityResponse
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.
This convenience overload automatically constructs the request object using the provided email identity parameter. For email addresses, specify the full address (e.g., user@example.com). For domains, specify the domain name without subdomains (e.g., example.com). This method provides the same comprehensive identity information as the primary overload, including verification details, authentication settings, and configuration attributes.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The email identity for which to retrieve information. This can be either an email address or a domain name. |
Returns
A response object containing comprehensive identity information including verification status, DKIM configuration, Mail-From attributes, sending policies, tags, and configuration set assignments.
GetEmailIdentityPolicies
function GetEmailIdentityPolicies( const ARequest: ISESV2GetEmailIdentityPoliciesRequest): ISESV2GetEmailIdentityPoliciesResponse; overload;
ISESV2GetEmailIdentityPoliciesRequest → ISESV2GetEmailIdentityPoliciesResponse
Returns the requested sending authorization policies for the given identity.
This operation retrieves sending authorization policies that have been applied to an email identity (email address or domain). The policies are returned as a map of policy names to their JSON policy content. 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 operation will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. You can execute this operation no more than once per second. The returned policies define permissions for other AWS accounts or IAM users to send emails using the specified identity.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity for which to retrieve sending authorization policies. |
Returns
A response object containing a map of policy names to policy contents for the specified identity.
function GetEmailIdentityPolicies( const AEmailIdentity: string): ISESV2GetEmailIdentityPoliciesResponse; overload;
ISESV2GetEmailIdentityPoliciesResponse
Returns the requested sending authorization policies for the given identity.
This convenience overload automatically constructs the request object using the provided email identity parameter. For email addresses, specify the full address (e.g., user@example.com). For domains, specify the domain name without subdomains (e.g., example.com). The identity must be verified and owned by your AWS account to retrieve its policies. This method provides the same policy information as the primary overload, returning up to 20 policies with their names and JSON content.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The email identity for which to retrieve sending authorization policies. This can be either an email address or a domain name. |
Returns
A response object containing a map of policy names to policy contents for the specified identity.
GetEmailTemplate
function GetEmailTemplate( const ARequest: ISESV2GetEmailTemplateRequest): ISESV2GetEmailTemplateResponse; overload;
ISESV2GetEmailTemplateRequest → ISESV2GetEmailTemplateResponse
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
This operation retrieves the complete content of an existing email template from your Amazon SES account. The returned template includes the subject line, HTML body, and plain text body that can be used for sending personalized emails. Email templates support variable substitution using replacement tags, enabling you to send personalized content to multiple recipients. The template content can be used with operations like SendEmail to send templated messages. You can execute this operation no more than once per second. If the specified template does not exist, the operation will return a NotFoundException.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name for which to retrieve the email template content. |
Returns
A response object containing the template content (subject, HTML part, and text part) and the template name.
function GetEmailTemplate( const ATemplateName: string): ISESV2GetEmailTemplateResponse; overload;
ISESV2GetEmailTemplateResponse
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
This convenience overload automatically constructs the request object using the provided template name parameter. The template name must be at least 1 character in length and match an existing template in your Amazon SES account. This method provides the same template retrieval functionality as the primary overload, returning the complete template content that can be used for sending personalized emails with variable substitution. Use ListEmailTemplates to discover available template names if you need to browse existing templates in your account.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the template to retrieve. The template name is case-sensitive and must match exactly with an existing template. |
Returns
A response object containing the template content (subject, HTML part, and text part) and the template name.
GetExportJob
function GetExportJob( const ARequest: ISESV2GetExportJobRequest): ISESV2GetExportJobResponse; overload;
ISESV2GetExportJobRequest → ISESV2GetExportJobResponse
Provides information about an export job.
This operation retrieves comprehensive information about a specific export job in your Amazon SES account. Export jobs are used to export email sending data, such as message insights or metrics data, to external destinations like Amazon S3. The response includes the job status, creation and completion timestamps, data source configuration, export destination details, processing statistics, and failure information if applicable. Export jobs can have various statuses including CREATED, PROCESSING, COMPLETED, FAILED, or CANCELLED. Use this operation to monitor job progress and retrieve results.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the job ID for which to retrieve export job information. |
Returns
A response object containing detailed information about the export job, including status, timestamps, data source configuration, destination settings, and processing statistics.
function GetExportJob( const AJobId: string): ISESV2GetExportJobResponse; overload;
Provides information about an export job.
This convenience overload automatically constructs the request object using the provided job ID parameter. The job ID must be at least 1 character in length and correspond to an existing export job. This method provides the same export job information as the primary overload, returning complete details about the job's configuration, current status, and processing results. If the specified job ID does not exist, the operation will return a NotFoundException. Use ListExportJobs to discover available export jobs if needed.
Parameters
| Name | Description |
|---|---|
AJobId | The export job ID. This must be the unique identifier of an existing export job in your Amazon SES account. |
Returns
A response object containing detailed information about the export job, including status, timestamps, data source configuration, destination settings, and processing statistics.
GetImportJob
function GetImportJob( const ARequest: ISESV2GetImportJobRequest): ISESV2GetImportJobResponse; overload;
ISESV2GetImportJobRequest → ISESV2GetImportJobResponse
Provides information about an import job.
This operation retrieves comprehensive information about a specific import job in your Amazon SES account. Import jobs are used to import contact data into contact lists or email addresses into suppression lists from external data sources like Amazon S3. The response includes the job status, creation and completion timestamps, data source and destination configurations, processing statistics, and failure information if applicable. Import jobs can have various statuses including CREATED, PROCESSING, COMPLETED, FAILED, or CANCELLED. Use this operation to monitor job progress and retrieve results.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the job ID for which to retrieve import job information. |
Returns
A response object containing detailed information about the import job, including status, timestamps, data source configuration, destination settings, and processing statistics.
function GetImportJob(const AJobId: string): ISESV2GetImportJobResponse; overload;
Provides information about an import job.
This convenience overload automatically constructs the request object using the provided job ID parameter. The job ID must be at least 1 character in length and correspond to an existing import job. This method provides the same import job information as the primary overload, returning complete details about the job's configuration, current status, and processing results. If the specified job ID does not exist, the operation will return a ESESV2NotFoundException. Use ListImportJobs to discover available import jobs if needed.
Parameters
| Name | Description |
|---|---|
AJobId | The import job ID. This must be the unique identifier of an existing import job in your Amazon SES account. |
Returns
A response object containing detailed information about the import job, including status, timestamps, data source configuration, destination settings, and processing statistics.
GetMessageInsights
function GetMessageInsights( const ARequest: ISESV2GetMessageInsightsRequest): ISESV2GetMessageInsightsResponse; overload;
ISESV2GetMessageInsightsRequest → ISESV2GetMessageInsightsResponse
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.
This operation retrieves detailed analytics and event data for a specific email message sent through Amazon SES. The message insights include metadata about the email and a complete event history showing delivery status, bounces, complaints, and other delivery-related events. The insights data includes ISP-specific information, allowing you to understand how different email providers handled your message. This information is valuable for troubleshooting delivery issues and monitoring email performance across different recipients and providers. You can execute this operation no more than once per second. If the specified message ID does not exist or is not accessible, the operation will return a NotFoundException.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the message ID for which to retrieve detailed insights and event information. |
Returns
A response object containing comprehensive message information including sender details, subject, recipients, email tags, and delivery events such as bounces, complaints, and delivery confirmations.
function GetMessageInsights( const AMessageId: string): ISESV2GetMessageInsightsResponse; overload;
ISESV2GetMessageInsightsResponse
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.
This convenience overload automatically constructs the request object using the provided message ID parameter. The message ID must be a valid identifier returned from a previous SendEmail or SendRawEmail operation. This method provides the same detailed message insights as the primary overload, returning complete information about the email's journey including delivery events, ISP-specific handling, and any associated tags or metadata. Message insights are particularly useful for debugging delivery issues, understanding recipient engagement patterns, and maintaining good sender reputation by monitoring bounce and complaint rates.
Parameters
| Name | Description |
|---|---|
AMessageId | A unique identifier for a message, returned when sending emails through Amazon SES. This must correspond to a message sent from your account. |
Returns
A response object containing comprehensive message information including sender details, subject, recipients, email tags, and delivery events such as bounces, complaints, and delivery confirmations.
GetMultiRegionEndpoint
function GetMultiRegionEndpoint( const ARequest: ISESV2GetMultiRegionEndpointRequest): ISESV2GetMultiRegionEndpointResponse; overload;
ISESV2GetMultiRegionEndpointRequest → ISESV2GetMultiRegionEndpointResponse
Displays the multi-region endpoint (global-endpoint) configuration.
This operation retrieves comprehensive configuration information about a specific multi-region endpoint (also called global-endpoint) in your Amazon SES account. Multi-region endpoints provide cross-region email sending capabilities with failover functionality and load distribution. The response includes the endpoint's current status, creation and update timestamps, routing configuration across AWS regions, and other operational details needed for managing cross-region email infrastructure. Only multi-region endpoints whose primary region is the AWS region where the operation is executed can be displayed. If the specified endpoint does not exist or is not accessible from the current region, the operation will return a NotFoundException.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the endpoint name for which to retrieve multi-region endpoint configuration. |
Returns
A response object containing detailed information about the multi-region endpoint, including status, timestamps, routes, and configuration details.
function GetMultiRegionEndpoint( const AEndpointName: string): ISESV2GetMultiRegionEndpointResponse; overload;
ISESV2GetMultiRegionEndpointResponse
Displays the multi-region endpoint (global-endpoint) configuration.
This convenience overload automatically constructs the request object using the provided endpoint name parameter. The endpoint name must follow the pattern ^[w-_]+$ and correspond to an existing multi-region endpoint. This method provides the same comprehensive endpoint information as the primary overload, returning complete configuration details including routing across AWS regions and current operational status. Multi-region endpoints enable geographic distribution of email sending with automatic failover capabilities, helping ensure high availability and optimal performance for email delivery across different regions.
Parameters
| Name | Description |
|---|---|
AEndpointName | The name of the multi-region endpoint (global-endpoint). Must be 1-64 characters containing only alphanumeric characters, hyphens, and underscores. |
Returns
A response object containing detailed information about the multi-region endpoint, including status, timestamps, routes, and configuration details.
GetReputationEntity
function GetReputationEntity( const ARequest: ISESV2GetReputationEntityRequest): ISESV2GetReputationEntityResponse; overload;
ISESV2GetReputationEntityRequest → ISESV2GetReputationEntityResponse
Retrieves information about a specific reputation entity in your SES account.
This operation returns detailed information about a reputation entity, including its reputation management policy, customer-managed status, AWS SES-managed status, and aggregate sending status. Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Use this operation to monitor the reputation status of your SES resources and understand any reputation-related impacts on your sending capability.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the reputation entity type and reference identifier. |
Returns
A response object containing the reputation entity information, including status records, policy configuration, and reputation impact details.
function GetReputationEntity( const AReputationEntityType, AReputationEntityReference: string): ISESV2GetReputationEntityResponse; overload;
ISESV2GetReputationEntityResponse
Retrieves information about a specific reputation entity using direct parameters.
This overload provides a convenient way to retrieve reputation entity information by specifying the entity type and reference directly without creating a request object. Currently, only RESOURCE type entities are supported. The reference should be the Amazon Resource Name (ARN) of the resource.
Parameters
| Name | Description |
|---|---|
AReputationEntityType | The type of reputation entity. Currently, onlyis supported. |
AReputationEntityReference | The Amazon Resource Name (ARN) of the reputation entity resource. |
Returns
A response object containing the reputation entity information, including status records, policy configuration, and reputation impact details.
GetSuppressedDestination
function GetSuppressedDestination( const ARequest: ISESV2GetSuppressedDestinationRequest): ISESV2GetSuppressedDestinationResponse; overload;
ISESV2GetSuppressedDestinationRequest → ISESV2GetSuppressedDestinationResponse
Retrieves information about a specific email address that's on the suppression list for your account.
This operation retrieves comprehensive information about a specific email address that has been added to your account's suppression list. The suppression list prevents Amazon SES from sending emails to addresses that have bounced or complained. The response includes details about why the email address was suppressed, when it was last updated, and any associated metadata such as message IDs and feedback IDs that triggered the suppression. If the specified email address is not on the suppression list, the operation will return a ESESV2NotFoundException. Use ListSuppressedDestinations to browse suppressed addresses.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email address for which to retrieve suppression information. |
Returns
A response object containing detailed information about the suppressed destination, including the reason for suppression, timestamps, and associated attributes.
function GetSuppressedDestination( const AEmailAddress: string): ISESV2GetSuppressedDestinationResponse; overload;
ISESV2GetSuppressedDestinationResponse
Retrieves information about a specific email address that's on the suppression list for your account.
This convenience overload automatically constructs the request object using the provided email address parameter. The email address must be properly formatted and correspond to an address that exists on your suppression list. This method provides the same suppression information as the primary overload, returning complete details about why the address was suppressed and any associated bounce or complaint metadata. Suppression reasons include BOUNCE for hard bounces and COMPLAINT for spam complaints. Understanding suppression details helps maintain good sender reputation and deliverability.
Parameters
| Name | Description |
|---|---|
AEmailAddress | The email address that's on the account suppression list. This must be a valid email address format. |
Returns
A response object containing detailed information about the suppressed destination, including the reason for suppression, timestamps, and associated attributes.
GetTenant
function GetTenant( const ARequest: ISESV2GetTenantRequest): ISESV2GetTenantResponse; overload;
ISESV2GetTenantRequest → ISESV2GetTenantResponse
Retrieves information about a specific tenant in your SES account.
This operation returns detailed information about a tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status. Tenants provide isolated email containers that help organize and monitor email sending across different logical groups, customers, or departments within your SES account. Use this operation to retrieve tenant configuration details, monitor sending capabilities, and manage tenant-specific email operations.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the tenant name to retrieve information about. |
Returns
A response object containing the tenant details including name, ID, ARN, creation timestamp, tags, and current sending status.
function GetTenant( const ATenantName: string): ISESV2GetTenantResponse; overload;
Retrieves information about a specific tenant using the tenant name directly.
This overload provides a convenient way to retrieve tenant information by specifying the tenant name directly without creating a request object. The tenant name must be an existing tenant that was previously created in your SES account.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to retrieve information about. |
Returns
A response object containing the tenant details including name, ID, ARN, creation timestamp, tags, and current sending status.
ListConfigurationSets
function ListConfigurationSets( const ARequest: ISESV2ListConfigurationSetsRequest): ISESV2ListConfigurationSetsResponse; overload;
ISESV2ListConfigurationSetsRequest → ISESV2ListConfigurationSetsResponse
Retrieves a list of all configuration sets associated with your account in the current region.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. This operation supports pagination to handle accounts with large numbers of configuration sets. Use the pagination parameters to control the number of results returned and to retrieve additional pages of results. Use configuration sets to monitor sending activity, manage deliverability settings, and organize your email sending operations.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of configuration set names and an optional pagination token for retrieving additional results.
function ListConfigurationSets: ISESV2ListConfigurationSetsResponse; overload;
ISESV2ListConfigurationSetsResponse
Retrieves a list of all configuration sets with default pagination settings.
This overload provides a convenient way to retrieve configuration sets without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of configuration set names and an optional pagination token for retrieving additional results.
function ListConfigurationSets( const APageSize: Integer): ISESV2ListConfigurationSetsResponse; overload;
ISESV2ListConfigurationSetsResponse
Retrieves a list of configuration sets with a specified page size.
This overload allows you to control the number of configuration sets returned in a single call without manually creating a request object.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. If there are more results than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of configuration set names and an optional pagination token for retrieving additional results.
function ListConfigurationSets(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListConfigurationSetsResponse; overload;
ISESV2ListConfigurationSetsResponse
Retrieves a list of configuration sets starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListConfigurationSets call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets. |
APageSize | The number of results to show in a single call. If not specified, uses the service default page size. |
Returns
A response object containing a list of configuration set names and an optional pagination token for retrieving additional results.
ListContactLists
function ListContactLists( const ARequest: ISESV2ListContactListsRequest): ISESV2ListContactListsResponse; overload;
ISESV2ListContactListsRequest → ISESV2ListContactListsResponse
Retrieves a list of all contact lists available in your SES account.
Contact lists are collections of contacts that have subscribed to particular topics or topics. Use contact lists to organize subscribers for targeted email campaigns and manage subscription preferences. This operation supports pagination to handle accounts with large numbers of contact lists. Use the pagination parameters to control the number of results returned and to retrieve additional pages of results. Each contact list entry includes the contact list name and the timestamp when it was last updated, allowing you to track contact list activity and modifications.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing a list of contact list information and an optional pagination token for retrieving additional results.
function ListContactLists: ISESV2ListContactListsResponse; overload;
ISESV2ListContactListsResponse
Retrieves a list of all contact lists with default pagination settings.
This overload provides a convenient way to retrieve contact lists without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of contact list information and an optional pagination token for retrieving additional results.
function ListContactLists( const APageSize: Integer): ISESV2ListContactListsResponse; overload;
ISESV2ListContactListsResponse
Retrieves a list of contact lists with a specified page size.
This overload allows you to control the number of contact lists returned in a single call without manually creating a request object.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of contact lists to return at once. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. |
Returns
A response object containing an array of contact list information and an optional pagination token for retrieving additional results.
function ListContactLists(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListContactListsResponse; overload;
ISESV2ListContactListsResponse
Retrieves a list of contact lists starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListContactLists call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListContactLists indicating that there might be additional contact lists available to be listed. |
APageSize | Maximum number of contact lists to return at once. If not specified, uses the service default page size. |
Returns
A response object containing an array of contact list information and an optional pagination token for retrieving additional results.
ListContacts
function ListContacts( const ARequest: ISESV2ListContactsRequest): ISESV2ListContactsResponse; overload;
ISESV2ListContactsRequest → ISESV2ListContactsResponse
Retrieves a list of contacts present in a specific contact list.
This operation returns contacts from a specified contact list with support for filtering by subscription status and topic preferences. Use this to manage subscriber lists and target specific segments for email campaigns. The operation supports pagination to handle contact lists with large numbers of contacts efficiently. Filtering options allow you to retrieve only contacts that match specific criteria such as opt-in status or topic subscriptions. Each contact entry includes email address, subscription preferences, topic preferences, and last updated timestamp for comprehensive contact management.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name, optional filtering criteria, and pagination parameters. |
Returns
A response object containing an array of contacts and an optional pagination token for retrieving additional results.
function ListContacts( const AContactListName: string): ISESV2ListContactsResponse; overload;
Retrieves all contacts from a specific contact list with default settings.
This overload provides a convenient way to retrieve all contacts from a contact list without specifying filtering or pagination parameters. It will return the first page of results using the default page size.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list containing the contacts to retrieve. |
Returns
A response object containing an array of contacts and an optional pagination token for retrieving additional results.
function ListContacts(const AContactListName: string; const APageSize: Integer): ISESV2ListContactsResponse; overload;
Retrieves contacts from a contact list with a specified page size.
This overload allows you to control the number of contacts returned in a single call without manually creating a request object.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list containing the contacts to retrieve. |
APageSize | The number of contacts to return in a single call. If there are more contacts than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of contacts and an optional pagination token for retrieving additional results.
function ListContacts( const AContactListName, ANextToken: string; const APageSize: Integer = 0): ISESV2ListContactsResponse; overload;
Retrieves contacts starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListContacts call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
AContactListName | The name of the contact list containing the contacts to retrieve. |
ANextToken | A token returned from a previous call to ListContacts indicating that there might be additional contacts available to be listed. |
APageSize | The number of contacts to return in a single call. If not specified, uses the service default page size. |
Returns
A response object containing an array of contacts and an optional pagination token for retrieving additional results.
ListCustomVerificationEmailTemplates
function ListCustomVerificationEmailTemplates( const ARequest: ISESV2ListCustomVerificationEmailTemplatesRequest): ISESV2ListCustomVerificationEmailTemplatesResponse; overload;
ISESV2ListCustomVerificationEmailTemplatesRequest → ISESV2ListCustomVerificationEmailTemplatesResponse
Retrieves a list of existing custom verification email templates for your account.
Custom verification email templates allow you to customize the email that Amazon SES sends when verifying email addresses. This operation lists all custom verification email templates that exist in your account in the current AWS Region. The operation supports pagination to handle accounts with large numbers of custom verification email templates. Each template includes metadata such as the template name, subject, sender address, and success/failure redirection URLs. You can execute this operation no more than once per second. Use these templates with operations like SendCustomVerificationEmail to send branded verification emails to your users.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of custom verification email template metadata and an optional pagination token for retrieving additional results.
function ListCustomVerificationEmailTemplates: ISESV2ListCustomVerificationEmailTemplatesResponse; overload;
ISESV2ListCustomVerificationEmailTemplatesResponse
Retrieves all custom verification email templates with default pagination settings.
This overload provides a convenient way to retrieve custom verification email templates without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of custom verification email template metadata and an optional pagination token for retrieving additional results.
function ListCustomVerificationEmailTemplates( const APageSize: Integer): ISESV2ListCustomVerificationEmailTemplatesResponse; overload;
ISESV2ListCustomVerificationEmailTemplatesResponse
Retrieves custom verification email templates with a specified page size.
This overload allows you to control the number of templates returned in a single call without manually creating a request object. The page size must be between 1 and 50.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. Must be between 1 and 50. If there are more templates than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of custom verification email template metadata and an optional pagination token for retrieving additional results.
function ListCustomVerificationEmailTemplates(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListCustomVerificationEmailTemplatesResponse; overload;
ISESV2ListCustomVerificationEmailTemplatesResponse
Retrieves custom verification email templates starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListCustomVerificationEmailTemplates call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListCustomVerificationEmailTemplates indicating that there are additional templates available to be listed. |
APageSize | The number of results to show in a single call. Must be between 1 and 50. If not specified, uses the service default page size. |
Returns
A response object containing an array of custom verification email template metadata and an optional pagination token for retrieving additional results.
ListDedicatedIpPools
function ListDedicatedIpPools( const ARequest: ISESV2ListDedicatedIpPoolsRequest): ISESV2ListDedicatedIpPoolsResponse; overload;
ISESV2ListDedicatedIpPoolsRequest → ISESV2ListDedicatedIpPoolsResponse
Retrieves a list of all dedicated IP pools that exist in your AWS account in the current region.
Dedicated IP pools are groups of dedicated IP addresses that you can use for sending specific types of email. This operation lists all IP pools associated with your account, including both standard and managed dedicated IP pools. The operation supports pagination to handle accounts with large numbers of dedicated IP pools. Use dedicated IP pools to isolate your sender reputation, control IP address allocation, and optimize deliverability for different email campaigns or sending patterns. Dedicated IP pools help you organize and manage your dedicated IP addresses for better reputation management and email delivery control.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of dedicated IP pool names and an optional pagination token for retrieving additional results.
function ListDedicatedIpPools: ISESV2ListDedicatedIpPoolsResponse; overload;
ISESV2ListDedicatedIpPoolsResponse
Retrieves all dedicated IP pools with default pagination settings.
This overload provides a convenient way to retrieve dedicated IP pools without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of dedicated IP pool names and an optional pagination token for retrieving additional results.
function ListDedicatedIpPools( const APageSize: Integer): ISESV2ListDedicatedIpPoolsResponse; overload;
ISESV2ListDedicatedIpPoolsResponse
Retrieves dedicated IP pools with a specified page size.
This overload allows you to control the number of dedicated IP pools returned in a single call without manually creating a request object.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. If there are more IP pools than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of dedicated IP pool names and an optional pagination token for retrieving additional results.
function ListDedicatedIpPools(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListDedicatedIpPoolsResponse; overload;
ISESV2ListDedicatedIpPoolsResponse
Retrieves dedicated IP pools starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListDedicatedIpPools call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListDedicatedIpPools indicating that there are additional IP pools available to be listed. |
APageSize | The number of results to show in a single call. If not specified, uses the service default page size. |
Returns
A response object containing an array of dedicated IP pool names and an optional pagination token for retrieving additional results.
ListDeliverabilityTestReports
function ListDeliverabilityTestReports( const ARequest: ISESV2ListDeliverabilityTestReportsRequest): ISESV2ListDeliverabilityTestReportsResponse; overload;
ISESV2ListDeliverabilityTestReportsRequest → ISESV2ListDeliverabilityTestReportsResponse
Retrieves a list of predictive inbox placement tests that you've performed.
This operation shows a list of the predictive inbox placement tests that you've performed, regardless of their statuses. Predictive inbox placement tests help you predict how your messages will be handled by various email providers around the world. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view detailed results of the test, including inbox placement rates and spam folder placement. The operation supports pagination to handle accounts with large numbers of deliverability test reports. Use these tests to optimize your email content and sending practices for better inbox delivery rates.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of deliverability test report metadata and an optional pagination token for retrieving additional results.
function ListDeliverabilityTestReports: ISESV2ListDeliverabilityTestReportsResponse; overload;
ISESV2ListDeliverabilityTestReportsResponse
Retrieves all deliverability test reports with default pagination settings.
This overload provides a convenient way to retrieve deliverability test reports without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of deliverability test report metadata and an optional pagination token for retrieving additional results.
function ListDeliverabilityTestReports( const APageSize: Integer): ISESV2ListDeliverabilityTestReportsResponse; overload;
ISESV2ListDeliverabilityTestReportsResponse
Retrieves deliverability test reports with a specified page size.
This overload allows you to control the number of test reports returned in a single call without manually creating a request object. The page size must be between 0 and 1000.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. Must be between 0 and 1000. If there are more reports than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of deliverability test report metadata and an optional pagination token for retrieving additional results.
function ListDeliverabilityTestReports(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListDeliverabilityTestReportsResponse; overload;
ISESV2ListDeliverabilityTestReportsResponse
Retrieves deliverability test reports starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListDeliverabilityTestReports call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListDeliverabilityTestReports indicating that there are additional predictive inbox placement tests available to be listed. |
APageSize | The number of results to show in a single call. Must be between 0 and 1000. If not specified, uses the service default page size. |
Returns
A response object containing an array of deliverability test report metadata and an optional pagination token for retrieving additional results.
ListDomainDeliverabilityCampaigns
function ListDomainDeliverabilityCampaigns( const ARequest: ISESV2ListDomainDeliverabilityCampaignsRequest): ISESV2ListDomainDeliverabilityCampaignsResponse; overload;
ISESV2ListDomainDeliverabilityCampaignsRequest → ISESV2ListDomainDeliverabilityCampaignsResponse
Retrieves deliverability data for all campaigns that used a specific domain during a specified time range.
This operation returns deliverability data for campaigns that used a specific domain to send email during a specified time period. The data includes metrics such as inbox placement rates, spam folder placement, read rates, and delete rates. This data is available for a domain only if you enabled the Deliverability dashboard for the domain. The time range can be up to 30 days, providing insights into campaign performance and email deliverability trends. Use this operation to analyze the effectiveness of your email campaigns, identify deliverability issues, and optimize your sending practices for better inbox placement rates.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the domain name, time range (start and end dates), and optional pagination parameters. |
Returns
A response object containing an array of domain deliverability campaign data and an optional pagination token for retrieving additional results.
function ListDomainDeliverabilityCampaigns(const ASubscribedDomain: string; const AStartDate, AEndDate: TDate): ISESV2ListDomainDeliverabilityCampaignsResponse; overload;
ISESV2ListDomainDeliverabilityCampaignsResponse
Retrieves deliverability campaign data for a domain within a specified date range.
This overload provides a convenient way to retrieve campaign deliverability data for a specific domain and time period without manually creating a request object. The end date must be within 30 days of the start date.
Parameters
| Name | Description |
|---|---|
ASubscribedDomain | The domain to obtain deliverability data for. This domain must have the Deliverability dashboard enabled. |
AStartDate | The first day that you want to obtain deliverability data for. |
AEndDate | The last day that you want to obtain deliverability data for. Must be less than or equal to 30 days after the StartDate. |
Returns
A response object containing an array of domain deliverability campaign data and an optional pagination token for retrieving additional results.
function ListDomainDeliverabilityCampaigns(const ASubscribedDomain: string; const AStartDate, AEndDate: TDate; const APageSize: Integer): ISESV2ListDomainDeliverabilityCampaignsResponse; overload;
ISESV2ListDomainDeliverabilityCampaignsResponse
Retrieves deliverability campaign data with pagination control.
This overload allows you to specify a page size to control the number of campaign results returned in a single call without manually creating a request object.
Parameters
| Name | Description |
|---|---|
ASubscribedDomain | The domain to obtain deliverability data for. This domain must have the Deliverability dashboard enabled. |
AStartDate | The first day that you want to obtain deliverability data for. |
AEndDate | The last day that you want to obtain deliverability data for. Must be less than or equal to 30 days after the StartDate. |
APageSize | The maximum number of results to include in the response. If there are more results than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of domain deliverability campaign data and an optional pagination token for retrieving additional results.
function ListDomainDeliverabilityCampaigns(const ASubscribedDomain: string; const AStartDate, AEndDate: TDate; const ANextToken: string; const APageSize: Integer = 0): ISESV2ListDomainDeliverabilityCampaignsResponse; overload;
ISESV2ListDomainDeliverabilityCampaignsResponse
Retrieves deliverability campaign data starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListDomainDeliverabilityCampaigns call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ASubscribedDomain | The domain to obtain deliverability data for. This domain must have the Deliverability dashboard enabled. |
AStartDate | The first day that you want to obtain deliverability data for. |
AEndDate | The last day that you want to obtain deliverability data for. Must be less than or equal to 30 days after the StartDate. |
ANextToken | A token returned from a previous call to ListDomainDeliverabilityCampaigns indicating the position of a campaign in the list of campaigns. |
APageSize | The maximum number of results to include in the response. If not specified, uses the service default page size. |
Returns
A response object containing an array of domain deliverability campaign data and an optional pagination token for retrieving additional results.
ListEmailIdentities
function ListEmailIdentities( const ARequest: ISESV2ListEmailIdentitiesRequest): ISESV2ListEmailIdentitiesResponse; overload;
ISESV2ListEmailIdentitiesRequest → ISESV2ListEmailIdentitiesResponse
Retrieves a list of all email identities 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 currently verified. The operation returns identities that are associated with both Amazon SES and Amazon Pinpoint. The operation supports pagination to handle accounts with large numbers of email identities. Use this operation to manage and monitor all email sending identities in your account, regardless of their verification status. Email identities are fundamental to SES operations as they determine which email addresses and domains you can use as senders for your email campaigns and transactional messages.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of email identity information and an optional pagination token for retrieving additional results.
function ListEmailIdentities: ISESV2ListEmailIdentitiesResponse; overload;
ISESV2ListEmailIdentitiesResponse
Retrieves all email identities with default pagination settings.
This overload provides a convenient way to retrieve email identities without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing an array of email identity information and an optional pagination token for retrieving additional results.
function ListEmailIdentities( const APageSize: Integer): ISESV2ListEmailIdentitiesResponse; overload;
ISESV2ListEmailIdentitiesResponse
Retrieves email identities with a specified page size.
This overload allows you to control the number of email identities returned in a single call without manually creating a request object. The page size must be between 0 and 1000.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. Must be between 0 and 1000. If there are more identities than specified, the response will include a NextToken for pagination. |
Returns
A response object containing an array of email identity information and an optional pagination token for retrieving additional results.
function ListEmailIdentities(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListEmailIdentitiesResponse; overload;
ISESV2ListEmailIdentitiesResponse
Retrieves email identities starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListEmailIdentities call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListEmailIdentities indicating that there are additional identities available to be listed. |
APageSize | The number of results to show in a single call. Must be between 0 and 1000. If not specified, uses the service default page size. |
Returns
A response object containing an array of email identity information and an optional pagination token for retrieving additional results.
ListEmailTemplates
function ListEmailTemplates( const ARequest: ISESV2ListEmailTemplatesRequest): ISESV2ListEmailTemplatesResponse; overload;
ISESV2ListEmailTemplatesRequest → ISESV2ListEmailTemplatesResponse
Retrieves a list of all email templates present in your SES account in the current region.
Email templates allow you to create reusable email content with placeholder variables that can be dynamically replaced when sending emails. This operation returns metadata about each template including the template name and creation timestamp. The operation supports pagination to handle accounts with large numbers of email templates. You can execute this operation no more than once per second to maintain optimal service performance. Use email templates to streamline your email campaigns, ensure consistent branding, and efficiently send personalized messages at scale through template variables and conditional content.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters to control the number of results and specify continuation tokens. |
Returns
A response object containing an array of email template metadata and an optional pagination token for retrieving additional results.
function ListEmailTemplates: ISESV2ListEmailTemplatesResponse; overload;
ISESV2ListEmailTemplatesResponse
Retrieves all email templates with default pagination settings.
This overload provides a convenient way to retrieve email templates without specifying pagination parameters. It will return the first page of results using the default page size.
Returns
A response object containing a list of email template metadata and an optional pagination token for retrieving additional results.
function ListEmailTemplates( const APageSize: Integer): ISESV2ListEmailTemplatesResponse; overload;
ISESV2ListEmailTemplatesResponse
Retrieves email templates with a specified page size.
This overload allows you to control the number of email templates returned in a single call without manually creating a request object. The page size must be between 1 and 100.
Parameters
| Name | Description |
|---|---|
APageSize | The number of results to show in a single call. Must be between 1 and 100. If there are more templates than specified, the response will include a NextToken for pagination. |
Returns
A response object containing a list of email template metadata and an optional pagination token for retrieving additional results.
function ListEmailTemplates(const ANextToken: string; const APageSize: Integer): ISESV2ListEmailTemplatesResponse; overload;
ISESV2ListEmailTemplatesResponse
Retrieves email templates starting from a specific pagination token.
This overload is useful for continuing pagination from a previous call. Use the NextToken returned from a previous ListEmailTemplates call to retrieve the next page of results.
Parameters
| Name | Description |
|---|---|
ANextToken | A token returned from a previous call to ListEmailTemplates indicating that there are additional email templates available to be listed. |
APageSize | The number of results to show in a single call. Must be between 1 and 100. If not specified, uses the service default page size. |
Returns
A response object containing an array of email template metadata and an optional pagination token for retrieving additional results.
ListExportJobs
function ListExportJobs( const ARequest: ISESV2ListExportJobsRequest): ISESV2ListExportJobsResponse; overload;
ISESV2ListExportJobsRequest → ISESV2ListExportJobsResponse
Lists all export jobs in your Amazon SES account with optional filtering and pagination.
Export jobs allow you to extract data from SES for analysis and reporting. This operation retrieves a paginated list of export job summaries that can be filtered by source type and status. Supported export source types:
METRICS_DATA– Exports sending and engagement metrics data.MESSAGE_INSIGHTS– Exports message event data and insights. This operation supports pagination usingNextTokenandPageSizeparameters for handling large result sets efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional filtering criteria, pagination parameters, and other configuration options for listing export jobs. |
Returns
A response object containing an array of export job summaries and an optionalfor retrieving additional results.
function ListExportJobs: ISESV2ListExportJobsResponse; overload;
Lists all export jobs in your Amazon SES account using default settings.
This is a convenience overload that retrieves all export jobs without applying any filters for source type or job status. Results are returned using the default page size and starting from the beginning of the list.
Returns
A response object containing an array of all export job summaries and an optionalfor retrieving additional results if more jobs exist.
function ListExportJobs( const APageSize: Integer): ISESV2ListExportJobsResponse; overload;
Lists export jobs with a specified maximum number of results per page.
This overload allows you to control the number of export jobs returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies. Results start from the beginning of the list and include all job types and statuses. Use the returned NextToken to retrieve subsequent pages.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of export jobs to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of export job summaries limited to the specified page size and an optionalfor retrieving the next page of results.
function ListExportJobs(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListExportJobsResponse; overload;
Lists export jobs starting from a specific position with optional page size control. ) This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of export jobs. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility to either maintain consistent page sizes across calls or allow SES to determine the optimal page size.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the list from which to continue retrieving results. |
APageSize | Maximum number of export jobs to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of export job summaries starting from the specified token position and an optionalfor retrieving further results.
ListImportJobs
function ListImportJobs( const ARequest: ISESV2ListImportJobsRequest): ISESV2ListImportJobsResponse; overload;
ISESV2ListImportJobsRequest → ISESV2ListImportJobsResponse
Lists all import jobs in your Amazon SES account with optional filtering and pagination.
Import jobs allow you to bulk import contact data and suppression list entries into Amazon SES. This operation retrieves a paginated list of import job summaries that can be filtered by destination type and includes processing status and record counts. Supported import destination types:
SUPPRESSION_LIST– Import jobs that add email addresses to suppression lists.CONTACT_LIST– Import jobs that add contacts to contact lists for email campaigns. This operation supports pagination usingNextTokenandPageSizeparameters for handling large result sets efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional filtering criteria, pagination parameters, and other configuration options for listing import jobs. |
Returns
A response object containing an array of import job summaries with processing statistics and an optionalfor retrieving additional results.
function ListImportJobs: ISESV2ListImportJobsResponse; overload;
Lists all import jobs in your Amazon SES account without filtering.
This is a convenience overload that retrieves all import jobs without applying any filters for destination type. Results include both suppression list and contact list import jobs using the default page size.
Returns
A response object containing an array of all import job summaries and an optionalfor retrieving additional results if more jobs exist.
function ListImportJobs( const APageSize: Integer): ISESV2ListImportJobsResponse; overload;
Lists import jobs with a specified maximum number of results per page.
This overload allows you to control the number of import jobs returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies. Results start from the beginning of the list and include all job destination types. Use the returned NextToken to retrieve subsequent pages.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of import jobs to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of import job summaries limited to the specified page size and an optionalfor retrieving the next page of results.
function ListImportJobs(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListImportJobsResponse; overload;
Lists import jobs starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of import jobs. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility to either maintain consistent page sizes across calls or allow SES to determine the optimal page size.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the list from which to continue retrieving results. |
APageSize | Maximum number of import jobs to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of import job summaries starting from the specified token position and an optionalfor retrieving further results.
ListMultiRegionEndpoints
function ListMultiRegionEndpoints( const ARequest: ISESV2ListMultiRegionEndpointsRequest): ISESV2ListMultiRegionEndpointsResponse; overload;
ISESV2ListMultiRegionEndpointsRequest → ISESV2ListMultiRegionEndpointsResponse
Lists multi-region endpoints (global-endpoints) in your Amazon SES account with optional pagination.
Multi-region endpoints (also called global-endpoints) allow you to distribute email sending across multiple AWS regions for improved reliability and performance. This operation retrieves a paginated list of multi-region endpoints with their configuration details and status information. Only multi-region endpoints whose primary region matches the AWS region where this operation is executed will be included in the results. This ensures you see endpoints relevant to your current regional context. This operation supports pagination using NextToken and PageSize parameters for handling large result sets efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional pagination parameters and other configuration options for listing multi-region endpoints. |
Returns
A response object containing an array of multi-region endpoint details including status, regions, and timestamps, along with an optionalfor retrieving additional results.
function ListMultiRegionEndpoints: ISESV2ListMultiRegionEndpointsResponse; overload;
ISESV2ListMultiRegionEndpointsResponse
Lists all multi-region endpoints (global-endpoints) in your Amazon SES account using default settings.
This is a convenience overload that retrieves all multi-region endpoints without specifying pagination parameters. Results are returned using the default page size and starting from the beginning of the list. Only endpoints whose primary region matches the current AWS region will be returned, providing a filtered view relevant to your operational context.
Returns
A response object containing an array of all accessible multi-region endpoint details and an optionalfor retrieving additional results if more endpoints exist.
function ListMultiRegionEndpoints( const APageSize: Integer): ISESV2ListMultiRegionEndpointsResponse; overload;
ISESV2ListMultiRegionEndpointsResponse
Lists multi-region endpoints with a specified maximum number of results per page.
This overload allows you to control the number of multi-region endpoints returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies. The page size can range from 1 to 1000 endpoints per request. Results start from the beginning of the list and include only endpoints whose primary region matches the current AWS region. Use the returned NextToken to retrieve subsequent pages.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of multi-region endpoints to return in a single call. Must be between 1 and 1000. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of multi-region endpoint details limited to the specified page size and an optionalfor retrieving the next page of results.
function ListMultiRegionEndpoints(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListMultiRegionEndpointsResponse; overload;
ISESV2ListMultiRegionEndpointsResponse
Lists multi-region endpoints starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of multi-region endpoints. The pagination token has specific length constraints (1-5000 characters) and format requirements. If APageSize is 0 or not specified, the default page size will be used, providing flexibility in pagination management. Only endpoints whose primary region matches the current AWS region will be returned, maintaining regional context consistency across paginated requests.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the list from which to continue retrieving results. Must be 1-5000 characters long. |
APageSize | Maximum number of multi-region endpoints to return in a single call. If 0, uses the default page size. Must be a non-negative integer, with a maximum value of 1000 when specified. |
Returns
A response object containing an array of multi-region endpoint details starting from the specified token position and an optionalfor retrieving further results.
ListRecommendations
function ListRecommendations( const ARequest: ISESV2ListRecommendationsRequest): ISESV2ListRecommendationsResponse; overload;
ISESV2ListRecommendationsRequest → ISESV2ListRecommendationsResponse
Lists security and deliverability recommendations for your Amazon SES account with optional filtering and pagination.
Amazon SES analyzes your email sending configuration and generates recommendations to improve security, deliverability, and compliance. This operation retrieves a paginated list of these recommendations, which can be filtered by type, status, impact level, or affected resource. Supported recommendation types include:
DKIM– Recommendations for DomainKeys Identified Mail authentication setup.SPF– Recommendations for Sender Policy Framework record configuration.DMARC– Recommendations for Domain-based Message Authentication reporting and conformance.BIMI– Recommendations for Brand Indicators for Message Identification implementation.COMPLAINT– Recommendations for handling complaint rates and feedback loops. You can execute this operation no more than once per second to ensure optimal service performance. This operation supports comprehensive filtering and pagination for efficient recommendation management.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional filtering criteria, pagination parameters, and other configuration options for listing recommendations. |
Returns
A response object containing an array of recommendation details with security and deliverability guidance, along with an optionalfor retrieving additional results.
function ListRecommendations: ISESV2ListRecommendationsResponse; overload;
ISESV2ListRecommendationsResponse
Lists all security and deliverability recommendations for your Amazon SES account using default settings.
This is a convenience overload that retrieves all recommendations without applying any filters for type, status, or impact level. Results include all available recommendations such as DKIM, SPF, DMARC, BIMI, and complaint handling suggestions. Recommendations are returned using the default page size and starting from the beginning of the list. Use the returned NextToken to retrieve additional pages if more recommendations exist.
Returns
A response object containing an array of all security and deliverability recommendations and an optionalfor retrieving additional results if more recommendations exist.
function ListRecommendations( const APageSize: Integer): ISESV2ListRecommendationsResponse; overload;
ISESV2ListRecommendationsResponse
Lists security and deliverability recommendations with a specified maximum number of results per page.
This overload allows you to control the number of recommendations returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies. The page size must be between 1 and 100 recommendations per request. Results start from the beginning of the list and include all recommendation types and statuses. Use the returned NextToken to retrieve subsequent pages efficiently.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of recommendations to return in a single call. Must be between 1 and 100. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of recommendation details limited to the specified page size and an optionalfor retrieving the next page of results.
function ListRecommendations(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListRecommendationsResponse; overload;
ISESV2ListRecommendationsResponse
Lists recommendations starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of recommendations while maintaining any filtering criteria from the original request. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility to either maintain consistent page sizes across calls or allow SES to determine the optimal page size for performance. The pagination token preserves any filters that were applied in the original request, ensuring consistent filtering across paginated results.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the list from which to continue retrieving results. |
APageSize | Maximum number of recommendations to return in a single call. If 0, uses the default page size. Must be a non-negative integer, with a maximum value of 100 when specified. |
Returns
A response object containing an array of recommendation details starting from the specified token position and an optionalfor retrieving further results.
ListReputationEntities
function ListReputationEntities( const ARequest: ISESV2ListReputationEntitiesRequest): ISESV2ListReputationEntitiesResponse; overload;
ISESV2ListReputationEntitiesRequest → ISESV2ListReputationEntitiesResponse
Lists reputation entities in your Amazon SES account with optional filtering and pagination.
Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. This operation provides an overview of all entities and their current reputation status, including both AWS-managed and customer-managed reputation data. Entities can be filtered by various criteria to help you monitor and manage your email sending reputation effectively. The comprehensive filtering options enable targeted reputation analysis and proactive reputation management. Supported filter types include:
ENTITY_TYPE– Filter by the type of reputation entity such as identity or configuration set.REPUTATION_IMPACT– Filter by reputation impact level to focus on entities affecting deliverability.SENDING_STATUS– Filter by current sending status to identify entities with sending restrictions.ENTITY_REFERENCE_PREFIX– Filter by entity reference prefix for targeted entity management. This operation supports pagination for handling large numbers of reputation entities efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional filtering criteria, pagination parameters, and other configuration options for listing reputation entities. |
Returns
A response object containing an array of reputation entity details including status, impact levels, and management policies, along with an optionalfor retrieving additional results.
function ListReputationEntities: ISESV2ListReputationEntitiesResponse; overload;
ISESV2ListReputationEntitiesResponse
Lists all reputation entities in your Amazon SES account using default settings.
This is a convenience overload that retrieves all reputation entities without applying any filters for entity type, reputation impact, or sending status. Results include all entities with reputation tracking capabilities in your account. Use this overload to get a comprehensive overview of your account's reputation landscape and identify entities that may require attention or monitoring.
Returns
A response object containing an array of all reputation entity details and an optionalfor retrieving additional results if more entities exist.
function ListReputationEntities( const APageSize: Integer): ISESV2ListReputationEntitiesResponse; overload;
ISESV2ListReputationEntitiesResponse
Lists reputation entities with a specified maximum number of results per page.
This overload allows you to control the number of reputation entities returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies when dealing with large numbers of entities in your account. Results start from the beginning of the list and include all entity types and statuses. Use the returned NextToken to retrieve subsequent pages of reputation entities.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of reputation entities to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of reputation entity details limited to the specified page size and an optionalfor retrieving the next page of results.
function ListReputationEntities(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListReputationEntitiesResponse; overload;
ISESV2ListReputationEntitiesResponse
Lists reputation entities starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of reputation entities while maintaining any filtering criteria from the original request. The pagination token preserves all filtering criteria that were applied in the original request, including entity type, reputation impact, sending status, and entity reference prefix filters. This ensures consistent reputation monitoring across paginated results. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility in managing result set sizes while maintaining pagination continuity.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the list from which to continue retrieving results. |
APageSize | Maximum number of reputation entities to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of reputation entity details starting from the specified token position and an optionalfor retrieving further results.
ListResourceTenants
function ListResourceTenants( const ARequest: ISESV2ListResourceTenantsRequest): ISESV2ListResourceTenantsResponse; overload;
ISESV2ListResourceTenantsRequest → ISESV2ListResourceTenantsResponse
Lists all tenants associated with a specific Amazon SES resource with optional pagination.
This operation returns a list of tenants that are associated with the specified resource. It is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template within your Amazon SES account. Tenants provide logical containers that group related SES resources together, enabling multi-tenant architectures and resource isolation. This operation helps manage tenant relationships and understand resource usage across different tenant boundaries. This operation supports pagination for handling resources with large numbers of associated tenants efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the resource ARN, optional pagination parameters, and other configuration options for listing resource tenants. |
Returns
A response object containing an array of tenant metadata including tenant identifiers, names, and association timestamps, along with an optionalfor retrieving additional results.
function ListResourceTenants( const AResourceArn: TARN): ISESV2ListResourceTenantsResponse; overload;
ISESV2ListResourceTenantsResponse
Lists all tenants associated with the specified Amazon SES resource.
This is a convenience overload that retrieves all tenants associated with the specified resource without specifying pagination parameters. Results are returned using the default page size and starting from the beginning of the tenant list. Use this overload when you need a complete view of all tenants using a specific resource such as an email identity, configuration set, or email template.
Parameters
| Name | Description |
|---|---|
AResourceArn | The Amazon Resource Name (ARN) of the resource to list associated tenants for. Must be a valid SES resource ARN with a minimum length of 1 character. |
Returns
A response object containing an array of all tenant metadata associated with the resource and an optionalfor retrieving additional results if more tenants exist.
function ListResourceTenants(const AResourceArn: TARN; const APageSize: Integer): ISESV2ListResourceTenantsResponse; overload;
ISESV2ListResourceTenantsResponse
Lists tenants associated with the specified resource with a specified maximum number of results per page.
This overload allows you to control the number of tenant associations returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies when dealing with resources that have many associated tenants. Results start from the beginning of the tenant list for the specified resource. Use the returned NextToken to retrieve subsequent pages of tenant associations.
Parameters
| Name | Description |
|---|---|
AResourceArn | The Amazon Resource Name (ARN) of the resource to list associated tenants for. Must be a valid SES resource ARN. |
APageSize | Maximum number of tenant associations to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of tenant metadata limited to the specified page size and an optionalfor retrieving the next page of results.
function ListResourceTenants(const AResourceArn: TARN; const ANextToken: string; const APageSize: Integer = 0): ISESV2ListResourceTenantsResponse; overload;
ISESV2ListResourceTenantsResponse
Lists tenants associated with the specified resource starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token for the specified resource. It is primarily used when implementing pagination to retrieve subsequent pages of tenant associations while maintaining the resource context. The pagination token is specific to the resource ARN and maintains the position in the tenant association list. This ensures consistent pagination behavior for resource-specific tenant management workflows. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility in managing result set sizes while maintaining pagination continuity.
Parameters
| Name | Description |
|---|---|
AResourceArn | The Amazon Resource Name (ARN) of the resource to list associated tenants for. Must be a valid SES resource ARN. |
ANextToken | Pagination token returned from a previous call tofor the same resource to indicate the position in the tenant list from which to continue retrieving results. |
APageSize | Maximum number of tenant associations to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of tenant metadata for the specified resource starting from the token position and an optionalfor retrieving further results.
ListSuppressedDestinations
function ListSuppressedDestinations( const ARequest: ISESV2ListSuppressedDestinationsRequest): ISESV2ListSuppressedDestinationsResponse; overload;
ISESV2ListSuppressedDestinationsRequest → ISESV2ListSuppressedDestinationsResponse
Retrieves a list of email addresses that are on the suppression list for your Amazon SES account with optional filtering and pagination.
The suppression list contains email addresses that Amazon SES has determined should not receive further email attempts due to hard bounces, spam complaints, or other delivery issues. This operation provides comprehensive visibility into suppressed destinations and enables effective suppression list management for maintaining good sender reputation and optimizing email deliverability. Advanced filtering capabilities allow you to analyze suppression patterns by reason, date ranges, and other criteria. This enables targeted remediation strategies and detailed deliverability analysis. Supported suppression reasons:
BOUNCE– Email addresses suppressed due to hard bounces indicating permanent delivery failures.COMPLAINT– Email addresses suppressed due to spam complaints from recipients. This operation supports comprehensive filtering by suppression reasons, date ranges for temporal analysis, and pagination for handling large suppression lists efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing optional filtering criteria including suppression reasons, date ranges, pagination parameters, and other configuration options for listing suppressed destinations. |
Returns
A response object containing an array of suppressed destination summaries with email addresses, suppression reasons, and timestamps, along with an optionalfor retrieving additional results.
function ListSuppressedDestinations: ISESV2ListSuppressedDestinationsResponse; overload;
ISESV2ListSuppressedDestinationsResponse
Retrieves all email addresses that are on the suppression list for your Amazon SES account using default settings.
This is a convenience overload that retrieves all suppressed email addresses without applying any filters for suppression reasons or date ranges. Results include all destinations suppressed due to bounces, complaints, or other delivery issues. Use this overload to get a comprehensive overview of your suppression list for general deliverability assessment and reputation monitoring. Results are returned using the default page size and starting from the beginning of the suppression list.
Returns
A response object containing an array of all suppressed destination summaries and an optionalfor retrieving additional results if more suppressed destinations exist.
function ListSuppressedDestinations( const APageSize: Integer): ISESV2ListSuppressedDestinationsResponse; overload;
ISESV2ListSuppressedDestinationsResponse
Retrieves suppressed email addresses with a specified maximum number of results per page.
This overload allows you to control the number of suppressed destinations returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies when dealing with large suppression lists across extensive email campaigns. Results start from the beginning of the suppression list and include all suppression reasons. Moderate page sizes are often preferred for suppression list management to enable detailed review of suppressed addresses and their associated reasons.
Parameters
| Name | Description |
|---|---|
APageSize | Maximum number of suppressed destinations to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of suppressed destination summaries limited to the specified page size and an optionalfor retrieving the next page of results.
function ListSuppressedDestinations(const ANextToken: string; const APageSize: Integer = 0): ISESV2ListSuppressedDestinationsResponse; overload;
ISESV2ListSuppressedDestinationsResponse
Retrieves suppressed destinations starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token. It is primarily used when implementing pagination to retrieve subsequent pages of suppressed destinations while maintaining any filtering criteria from the original request. The pagination token preserves all filtering criteria that were applied in the original request, including suppression reasons and date ranges. This ensures consistent suppression list analysis and deliverability monitoring across paginated results. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility in managing result set sizes while maintaining pagination continuity for comprehensive suppression list management workflows.
Parameters
| Name | Description |
|---|---|
ANextToken | Pagination token returned from a previous call toto indicate the position in the suppression list from which to continue retrieving results. |
APageSize | Maximum number of suppressed destinations to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of suppressed destination summaries starting from the specified token position and an optionalfor retrieving further results.
ListTagsForResource
function ListTagsForResource( const ARequest: ISESV2ListTagsForResourceRequest): ISESV2ListTagsForResourceResponse; overload;
ISESV2ListTagsForResourceRequest → ISESV2ListTagsForResourceResponse
Retrieves a list of tags (keys and values) associated with a specified Amazon SES resource.
Tags are labels that help organize and categorize your SES resources for management, billing, operational automation, and access control purposes. Each tag consists of a required tag key and an optional associated tag value. Tag keys act as general categories, while tag values provide more specific descriptors within those categories. This operation enables comprehensive tag management by retrieving all tags associated with a specific resource. The retrieved tags can be used for various AWS management strategies including cost allocation, resource organization, automated operations, and policy-based access control implementations. Supported SES resource types include email identities, configuration sets, contact lists, email templates, dedicated IP pools, and other SES resources that support tagging capabilities.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the resource ARN and other configuration options for retrieving tag information from the specified Amazon SES resource. |
Returns
A response object containing an array of tags (key-value pairs) associated with the specified resource, enabling comprehensive resource metadata management and organization.
function ListTagsForResource( const AResourceArn: TARN): ISESV2ListTagsForResourceResponse; overload;
ISESV2ListTagsForResourceResponse
Retrieves all tags associated with the specified Amazon SES resource using its ARN.
This is a convenience overload that retrieves all tags for a specific SES resource without requiring a full request object. It provides direct access to resource metadata for immediate tag inspection and management operations. Use this overload when you need to quickly inspect the tags associated with a known resource, such as during resource auditing, cost analysis, or operational automation workflows that depend on resource categorization and metadata.
Parameters
| Name | Description |
|---|---|
AResourceArn | The Amazon Resource Name (ARN) of the SES resource to retrieve tag information for. Must be a valid SES resource ARN following the format:. |
Returns
A response object containing an array of all tags associated with the specified resource, providing complete resource metadata for management and organizational purposes.
ListTenantResources
function ListTenantResources( const ARequest: ISESV2ListTenantResourcesRequest): ISESV2ListTenantResourcesResponse; overload;
ISESV2ListTenantResourcesRequest → ISESV2ListTenantResourcesResponse
Lists all resources associated with a specific tenant in your Amazon SES account with optional filtering and pagination.
This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. Tenants provide logical containers that group related SES resources together, enabling multi-tenant architectures and resource isolation. The operation supports filtering by resource type to focus on specific categories of resources within the tenant. This enables efficient tenant resource management and helps understand resource allocation and usage patterns across different tenant boundaries. Common tenant resource types include:
- Email identities (domains and email addresses) for tenant-specific sending.
- Configuration sets for tenant-specific email sending configuration.
- Email templates for tenant-specific content and branding. This operation supports comprehensive filtering by resource type and pagination for handling tenants with large numbers of associated resources efficiently.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the tenant name, optional resource type filtering, pagination parameters, and other configuration options for listing tenant resources. |
Returns
A response object containing an array of tenant resource details including resource ARNs and types, along with an optionalfor retrieving additional results.
function ListTenantResources( const ATenantName: string): ISESV2ListTenantResourcesResponse; overload;
ISESV2ListTenantResourcesResponse
Lists all resources associated with the specified tenant using default settings.
This is a convenience overload that retrieves all resources associated with the specified tenant without applying any resource type filters or custom pagination parameters. Results include all resource types (email identities, configuration sets, and email templates) associated with the tenant. Use this overload to get a comprehensive overview of all resources allocated to a specific tenant for resource auditing, capacity planning, and tenant management workflows.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to list resources for. Must be a valid tenant name with a minimum length of 1 character. |
Returns
A response object containing an array of all tenant resource details and an optionalfor retrieving additional results if more resources exist.
function ListTenantResources(const ATenantName: string; const APageSize: Integer): ISESV2ListTenantResourcesResponse; overload;
ISESV2ListTenantResourcesResponse
Lists resources associated with the specified tenant with a specified maximum number of results per page.
This overload allows you to control the number of tenant resources returned in a single call, which is useful for managing memory usage and implementing custom pagination strategies when dealing with tenants that have many associated resources. Results start from the beginning of the tenant's resource list and include all resource types. Use the returned NextToken to retrieve subsequent pages of tenant resources.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to list resources for. Must be a valid tenant name. |
APageSize | Maximum number of tenant resources to return in a single call. Must be a positive integer. Larger values return more results per call but may increase response time and memory usage. |
Returns
A response object containing an array of tenant resource details limited to the specified page size and an optionalfor retrieving the next page of results.
function ListTenantResources(const ATenantName, ANextToken: string; const APageSize: Integer = 0): ISESV2ListTenantResourcesResponse; overload;
ISESV2ListTenantResourcesResponse
Lists resources associated with the specified tenant starting from a specific position with optional page size control.
This overload enables continuation of a previous listing operation using a pagination token for the specified tenant. It is primarily used when implementing pagination to retrieve subsequent pages of tenant resources while maintaining the tenant context. The pagination token is specific to the tenant and maintains the position in the tenant's resource list. This ensures consistent pagination behavior for tenant-specific resource management workflows and comprehensive tenant resource auditing. If APageSize is 0 or not specified, the default page size will be used. This provides flexibility in managing result set sizes while maintaining pagination continuity.
Parameters
| Name | Description |
|---|---|
ATenantName | The name of the tenant to list resources for. Must be a valid tenant name. |
ANextToken | Pagination token returned from a previous call tofor the same tenant to indicate the position in the resource list from which to continue retrieving results. |
APageSize | Maximum number of tenant resources to return in a single call. If 0, uses the default page size. Must be a non-negative integer. |
Returns
A response object containing an array of tenant resource details for the specified tenant starting from the token position and an optionalfor retrieving further results.
ListTenants
function ListTenants( const ARequest: ISESV2ListTenantsRequest): ISESV2ListTenantsResponse; overload;
ISESV2ListTenantsRequest → ISESV2ListTenantsResponse
Lists all tenants associated with your account in the current AWS region.
This operation returns basic information about each tenant, including the tenant name, unique identifier, ARN, and creation timestamp. Results are paginated when the total number of tenants exceeds the specified page size. Use the returned NextToken to retrieve additional pages of results.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing pagination parameters for the tenant listing operation. |
Returns
A response object containing an array of tenant information and an optional pagination token.
function ListTenants: ISESV2ListTenantsResponse; overload;
Lists all tenants associated with your account in the current AWS region.
Returns
A response object containing an array of tenant information and an optional pagination token.
function ListTenants( const APageSize: Integer): ISESV2ListTenantsResponse; overload;
Lists all tenants associated with your account in the current AWS region.
Parameters
| Name | Description |
|---|---|
APageSize | The maximum number of tenant results to return in a single call. Valid range is 1-1000. |
Returns
A response object containing an array of tenant information and an optional pagination token.
function ListTenants(const ANextToken: string; const APageSize: Integer): ISESV2ListTenantsResponse; overload;
Lists all tenants associated with your account in the current AWS region.
Parameters
| Name | Description |
|---|---|
ANextToken | A pagination token from a previouscall to retrieve the next page of results. |
APageSize | The maximum number of tenant results to return in a single call. Valid range is 1-1000. |
Returns
A response object containing an array of tenant information and an optional pagination token.
PutAccountDedicatedIpWarmupAttributes
function PutAccountDedicatedIpWarmupAttributes( const ARequest: ISESV2PutAccountDedicatedIpWarmupAttributesRequest): ISESV2PutAccountDedicatedIpWarmupAttributesResponse; overload;
ISESV2PutAccountDedicatedIpWarmupAttributesRequest → ISESV2PutAccountDedicatedIpWarmupAttributesResponse
Enables or disables the automatic warm-up feature for dedicated IP addresses.
This operation configures the automatic warm-up behavior for newly allocated dedicated IP addresses associated with your Amazon SES account in the current AWS region. When automatic warm-up is enabled, new dedicated IPs will gradually increase their sending volume over time to establish sender reputation. When disabled, you must manually manage the warm-up process.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the warm-up configuration for dedicated IP addresses. |
Returns
A response object indicating the successful configuration of the warm-up attributes.
function PutAccountDedicatedIpWarmupAttributes( const AAutoWarmupEnabled: Boolean): ISESV2PutAccountDedicatedIpWarmupAttributesResponse; overload;
ISESV2PutAccountDedicatedIpWarmupAttributesResponse
Enables or disables the automatic warm-up feature for dedicated IP addresses.
Parameters
| Name | Description |
|---|---|
AAutoWarmupEnabled | Set toto enable automatic warm-up for new dedicated IPs, orto disable it. |
Returns
A response object indicating the successful configuration of the warm-up attributes.
PutAccountDetails
function PutAccountDetails( const ARequest: ISESV2PutAccountDetailsRequest): ISESV2PutAccountDetailsResponse;
ISESV2PutAccountDetailsRequest → ISESV2PutAccountDetailsResponse
Updates your Amazon SES account details and configuration settings.
This operation updates essential account information including the type of email you plan to send, your website URL, preferred contact language, and additional notification email addresses. The MailType and WebsiteURL fields are required. When requesting production access, set ProductionAccessEnabled to true to move your account out of the sandbox environment. If there is already an ongoing account details update under review, this operation will return a ConflictException.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing account details such as mail type, website URL, contact preferences, and production access settings. |
Returns
A response object indicating the successful update of account details.
PutAccountSendingAttributes
function PutAccountSendingAttributes( const ARequest: ISESV2PutAccountSendingAttributesRequest): ISESV2PutAccountSendingAttributesResponse; overload;
ISESV2PutAccountSendingAttributesRequest → ISESV2PutAccountSendingAttributesResponse
Enables or disables the ability of your account to send email.
This operation controls your account's ability to send email through Amazon SES. When disabled, all email sending operations will be blocked for your account. Note that if AWS has paused your account's ability to send email due to policy violations or other issues, this operation cannot be used to resume sending capabilities.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the sending enabled configuration for your account. |
Returns
A response object indicating the successful configuration of sending attributes.
function PutAccountSendingAttributes( const ASendingEnabled: Boolean): ISESV2PutAccountSendingAttributesResponse; overload;
ISESV2PutAccountSendingAttributesResponse
Enables or disables the ability of your account to send email.
Parameters
| Name | Description |
|---|---|
ASendingEnabled | Set toto enable email sending for your account, orto disable it. |
Returns
A response object indicating the successful configuration of sending attributes.
PutAccountSuppressionAttributes
function PutAccountSuppressionAttributes( const ARequest: ISESV2PutAccountSuppressionAttributesRequest): ISESV2PutAccountSuppressionAttributesResponse; overload;
ISESV2PutAccountSuppressionAttributesRequest → ISESV2PutAccountSuppressionAttributesResponse
Changes the settings for the account-level suppression list.
This operation configures which types of delivery failures will automatically add recipient email addresses to your account-level suppression list to protect your sender reputation. When an email address is suppressed, Amazon SES will refuse to send future messages to that address until it is manually removed from the suppression list.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the suppression reasons configuration for your account. |
Returns
A response object indicating the successful configuration of suppression attributes.
function PutAccountSuppressionAttributes( const ASuppressedReasons: TArray<string>): ISESV2PutAccountSuppressionAttributesResponse; overload;
ISESV2PutAccountSuppressionAttributesResponse
Changes the settings for the account-level suppression list.
Parameters
| Name | Description |
|---|---|
ASuppressedReasons | An array of suppression reasons specifying when to automatically suppress recipients. Valid values arefor hard bounces andfor spam complaints. |
Returns
A response object indicating the successful configuration of suppression attributes.
PutAccountVdmAttributes
function PutAccountVdmAttributes( const ARequest: ISESV2PutAccountVdmAttributesRequest): ISESV2PutAccountVdmAttributesResponse; overload;
ISESV2PutAccountVdmAttributesRequest → ISESV2PutAccountVdmAttributesResponse
Updates your Amazon SES account VDM (Virtual Deliverability Manager) attributes.
This operation configures Virtual Deliverability Manager features including engagement metrics dashboard and optimized shared delivery settings. VDM provides advanced deliverability insights and automatic optimization to improve your email sending reputation and delivery rates. This operation is rate-limited to one request per second.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the VDM configuration attributes for your account. |
Returns
A response object indicating the successful configuration of VDM attributes.
function PutAccountVdmAttributes( const AVdmAttributes: ISESV2VdmAttributes): ISESV2PutAccountVdmAttributesResponse; overload;
ISESV2VdmAttributes → ISESV2PutAccountVdmAttributesResponse
Updates your Amazon SES account VDM (Virtual Deliverability Manager) attributes.
Parameters
| Name | Description |
|---|---|
AVdmAttributes | The VDM attributes configuration including enablement status, dashboard settings, and guardian options. |
Returns
A response object indicating the successful configuration of VDM attributes.
PutConfigurationSetArchivingOptions
function PutConfigurationSetArchivingOptions( const ARequest: ISESV2PutConfigurationSetArchivingOptionsRequest): ISESV2PutConfigurationSetArchivingOptionsResponse; overload;
ISESV2PutConfigurationSetArchivingOptionsRequest → ISESV2PutConfigurationSetArchivingOptionsResponse
Associates a configuration set with a MailManager archive for email message archiving.
When emails are sent using SendEmail or SendBulkEmail operations with this configuration set, the complete message as delivered to the receiving SMTP server will be archived along with recipient information. This enables compliance, audit, and analytics capabilities by preserving copies of sent messages in the specified MailManager archive.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and MailManager archive ARN. |
Returns
A response object indicating the successful association of the configuration set with the archive.
function PutConfigurationSetArchivingOptions( const AConfigurationSetName: string; const AArchiveArn: TARN): ISESV2PutConfigurationSetArchivingOptionsResponse; overload;
ISESV2PutConfigurationSetArchivingOptionsResponse
Associates a configuration set with a MailManager archive for email message archiving.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set to associate with the MailManager archive. |
AArchiveArn | The Amazon Resource Name (ARN) of the MailManager archive where Amazon SES will store sent messages. |
Returns
A response object indicating the successful association of the configuration set with the archive.
PutConfigurationSetDeliveryOptions
function PutConfigurationSetDeliveryOptions( const ARequest: ISESV2PutConfigurationSetDeliveryOptionsRequest): ISESV2PutConfigurationSetDeliveryOptionsResponse;
ISESV2PutConfigurationSetDeliveryOptionsRequest → ISESV2PutConfigurationSetDeliveryOptionsResponse
Associates a configuration set with delivery options including dedicated IP pools and TLS policies.
This operation configures how emails using the specified configuration set are delivered, including association with dedicated IP pools for better sender reputation control and TLS encryption requirements for enhanced security. Dedicated IP pools allow you to group dedicated IP addresses for sending specific types of email, while TLS policies control whether encrypted connections are required or optional during delivery attempts. The delivery timeout setting determines how long Amazon SES will attempt delivery before marking messages as failed, with valid ranges from 5 minutes to 14 hours.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and delivery options such as IP pool, TLS policy, and delivery timeout. |
Returns
A response object indicating the successful configuration of delivery options.
PutConfigurationSetReputationOptions
function PutConfigurationSetReputationOptions( const ARequest: ISESV2PutConfigurationSetReputationOptionsRequest): ISESV2PutConfigurationSetReputationOptionsResponse; overload;
ISESV2PutConfigurationSetReputationOptionsRequest → ISESV2PutConfigurationSetReputationOptionsResponse
Enables or disables collection of reputation metrics for emails sent using a configuration set.
This operation controls whether Amazon SES collects and tracks reputation metrics such as bounce rates, complaint rates, and delivery statistics for emails sent using the specified configuration set. Reputation metrics help monitor sender reputation and identify potential deliverability issues. These metrics are collected on a per-region basis and can be viewed through the Amazon SES console or retrieved via API.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and reputation metrics settings. |
Returns
A response object indicating the successful configuration of reputation tracking options.
function PutConfigurationSetReputationOptions( const AConfigurationSetName: string; const AReputationMetricsEnabled: Boolean): ISESV2PutConfigurationSetReputationOptionsResponse; overload;
ISESV2PutConfigurationSetReputationOptionsResponse
Enables or disables collection of reputation metrics for emails sent using a configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set for which to configure reputation metrics tracking. |
AReputationMetricsEnabled | Set toto enable reputation metrics tracking, orto disable it. |
Returns
A response object indicating the successful configuration of reputation tracking options.
PutConfigurationSetSendingOptions
function PutConfigurationSetSendingOptions( const ARequest: ISESV2PutConfigurationSetSendingOptionsRequest): ISESV2PutConfigurationSetSendingOptionsResponse; overload;
ISESV2PutConfigurationSetSendingOptionsRequest → ISESV2PutConfigurationSetSendingOptionsResponse
Enables or disables email sending for messages that use a particular configuration set.
This operation controls whether emails using the specified configuration set can be sent in the current AWS region. When disabled, all email sending attempts using this configuration set will be blocked. This provides a convenient way to temporarily suspend email sending for specific message types or campaigns without deleting the configuration set or modifying your application code.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and sending enabled status. |
Returns
A response object indicating the successful configuration of sending options.
function PutConfigurationSetSendingOptions( const AConfigurationSetName: string; const ASendingEnabled: Boolean): ISESV2PutConfigurationSetSendingOptionsResponse; overload;
ISESV2PutConfigurationSetSendingOptionsResponse
Enables or disables email sending for messages that use a particular configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set to enable or disable email sending for. |
ASendingEnabled | Set toto enable email sending for the configuration set, orto disable it. |
Returns
A response object indicating the successful configuration of sending options.
PutConfigurationSetSuppressionOptions
function PutConfigurationSetSuppressionOptions( const ARequest: ISESV2PutConfigurationSetSuppressionOptionsRequest): ISESV2PutConfigurationSetSuppressionOptionsResponse; overload;
ISESV2PutConfigurationSetSuppressionOptionsRequest → ISESV2PutConfigurationSetSuppressionOptionsResponse
Specifies the account suppression list preferences for a configuration set.
This operation configures which types of delivery failures will automatically add recipient email addresses to the account-level suppression list when using the specified configuration set. When an email address is suppressed, Amazon SES will refuse to send future messages to that address to protect your sender reputation until it is manually removed from the suppression list.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and suppression reasons configuration. |
Returns
A response object indicating the successful configuration of suppression options.
function PutConfigurationSetSuppressionOptions( const AConfigurationSetName: string; const ASuppressedReasons: TArray<string>): ISESV2PutConfigurationSetSuppressionOptionsResponse; overload;
ISESV2PutConfigurationSetSuppressionOptionsResponse
Specifies the account suppression list preferences for a configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set to change the suppression list preferences for. |
ASuppressedReasons | A list of suppression reasons specifying when to automatically suppress recipients. Valid values arefor hard bounces andfor spam complaints. |
Returns
A response object indicating the successful configuration of suppression options.
PutConfigurationSetTrackingOptions
function PutConfigurationSetTrackingOptions( const ARequest: ISESV2PutConfigurationSetTrackingOptionsRequest): ISESV2PutConfigurationSetTrackingOptionsResponse;
ISESV2PutConfigurationSetTrackingOptionsRequest → ISESV2PutConfigurationSetTrackingOptionsResponse
Specifies a custom domain to use for open and click tracking elements in emails sent using a configuration set.
This operation configures how open and click tracking elements are handled for emails sent using the specified configuration set, including the ability to use a custom domain instead of default Amazon SES tracking domains. Custom tracking domains can improve recipient trust by displaying your own domain in tracking URLs rather than Amazon SES domains. The custom domain must be properly configured with DNS records pointing to Amazon SES tracking infrastructure. The HTTPS policy controls whether tracking elements use HTTP or HTTPS protocols, with options to require HTTPS for all tracking, only open tracking, or use the original link protocol for click tracking.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name, custom redirect domain, and HTTPS policy for tracking. |
Returns
A response object indicating the successful configuration of tracking options.
PutConfigurationSetVdmOptions
function PutConfigurationSetVdmOptions( const ARequest: ISESV2PutConfigurationSetVdmOptionsRequest): ISESV2PutConfigurationSetVdmOptionsResponse; overload;
ISESV2PutConfigurationSetVdmOptionsRequest → ISESV2PutConfigurationSetVdmOptionsResponse
Specifies VDM (Virtual Deliverability Manager) preferences for emails sent using a configuration set.
This operation configures Virtual Deliverability Manager features at the configuration set level, including engagement metrics dashboard settings and guardian optimized shared delivery options. VDM provides advanced deliverability insights and automatic optimization specific to emails sent using this configuration set, allowing for granular control over different email types or campaigns within your account. This operation is rate-limited to one request per second.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name and VDM options including dashboard and guardian settings. |
Returns
A response object indicating the successful configuration of VDM options.
function PutConfigurationSetVdmOptions( const AConfigurationSetName: string; const AVdmOptions: ISESV2VdmOptions): ISESV2PutConfigurationSetVdmOptionsResponse; overload;
ISESV2VdmOptions → ISESV2PutConfigurationSetVdmOptionsResponse
Specifies VDM (Virtual Deliverability Manager) preferences for emails sent using a configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set to configure with VDM options. |
AVdmOptions | The VDM options configuration including dashboard engagement metrics and guardian delivery optimization settings. |
Returns
A response object indicating the successful configuration of VDM options.
PutDedicatedIpInPool
function PutDedicatedIpInPool( const ARequest: ISESV2PutDedicatedIpInPoolRequest): ISESV2PutDedicatedIpInPoolResponse; overload;
ISESV2PutDedicatedIpInPoolRequest → ISESV2PutDedicatedIpInPoolResponse
Moves a dedicated IP address to an existing dedicated IP pool.
This operation moves a dedicated IP address from its current pool to the specified destination pool, allowing you to reorganize IP addresses for better sender reputation management and traffic segmentation. The dedicated IP address must already exist and be associated with your AWS account. The destination pool must also exist before moving the IP address. Moving IP addresses between pools enables grouping based on sending patterns, reputation requirements, or organizational needs without affecting email delivery.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the dedicated IP address and destination pool name. |
Returns
A response object indicating the successful movement of the IP address to the specified pool.
function PutDedicatedIpInPool( const AIP, ADestinationPoolName: string): ISESV2PutDedicatedIpInPoolResponse; overload;
ISESV2PutDedicatedIpInPoolResponse
Moves a dedicated IP address to an existing dedicated IP pool.
Parameters
| Name | Description |
|---|---|
AIP | The dedicated IP address to move. Must be a dedicated IP already associated with your AWS account. |
ADestinationPoolName | The name of the existing IP pool to move the dedicated IP address to. |
Returns
A response object indicating the successful movement of the IP address to the specified pool.
PutDedicatedIpPoolScalingAttributes
function PutDedicatedIpPoolScalingAttributes( const ARequest: ISESV2PutDedicatedIpPoolScalingAttributesRequest): ISESV2PutDedicatedIpPoolScalingAttributesResponse; overload;
ISESV2PutDedicatedIpPoolScalingAttributesRequest → ISESV2PutDedicatedIpPoolScalingAttributesResponse
Converts a dedicated IP pool to a different scaling mode.
This operation changes the scaling mode of an existing dedicated IP pool to control how IP addresses are managed and allocated within the pool. Scaling modes determine whether the pool is managed by AWS or manually controlled. Note that pools in MANAGED mode cannot be converted back to STANDARD mode. This operation may result in a ESESV2ConcurrentModificationException if the pool is being modified by another operation.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the pool name and scaling mode configuration. |
Returns
A response object indicating the successful conversion of the IP pool scaling mode.
function PutDedicatedIpPoolScalingAttributes( const APoolName, AScalingMode: string): ISESV2PutDedicatedIpPoolScalingAttributesResponse; overload;
ISESV2PutDedicatedIpPoolScalingAttributesResponse
Converts a dedicated IP pool to a different scaling mode.
Parameters
| Name | Description |
|---|---|
APoolName | The name of the dedicated IP pool to modify. |
AScalingMode | The scaling mode to apply to the pool. Valid values arefor manual control orfor AWS management. |
Returns
A response object indicating the successful conversion of the IP pool scaling mode.
PutDedicatedIpWarmupAttributes
function PutDedicatedIpWarmupAttributes( const ARequest: ISESV2PutDedicatedIpWarmupAttributesRequest): ISESV2PutDedicatedIpWarmupAttributesResponse; overload;
ISESV2PutDedicatedIpWarmupAttributesRequest → ISESV2PutDedicatedIpWarmupAttributesResponse
Updates the warm-up attributes for a dedicated IP address.
This operation configures the warm-up percentage for a dedicated IP address to control its sending volume during the reputation building process. Proper warm-up is essential for establishing sender reputation gradually with mailbox providers. The warm-up percentage determines how much of the IP's total sending capacity can be utilized. Percentages typically start low and increase over time to build reputation without triggering deliverability issues from sudden high-volume sending.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the dedicated IP address and warm-up percentage configuration. |
Returns
A response object indicating the successful update of warm-up attributes.
function PutDedicatedIpWarmupAttributes( const AIP: string; AWarmupPercentage: Integer): ISESV2PutDedicatedIpWarmupAttributesResponse; overload;
ISESV2PutDedicatedIpWarmupAttributesResponse
Updates the warm-up attributes for a dedicated IP address.
Parameters
| Name | Description |
|---|---|
AIP | The dedicated IP address to update warm-up attributes for. Must be associated with your AWS account. |
AWarmupPercentage | The warm-up percentage controlling the sending capacity allowed for this dedicated IP address. |
Returns
A response object indicating the successful update of warm-up attributes.
PutDeliverabilityDashboardOption
function PutDeliverabilityDashboardOption( const ARequest: ISESV2PutDeliverabilityDashboardOptionRequest): ISESV2PutDeliverabilityDashboardOptionResponse; overload;
ISESV2PutDeliverabilityDashboardOptionRequest → ISESV2PutDeliverabilityDashboardOptionResponse
Enables or disables the Deliverability dashboard for your Amazon SES account.
When enabled, the Deliverability dashboard provides access to reputation metrics, deliverability statistics, and predictive inbox placement testing capabilities for your verified domains. Enabling the dashboard incurs a monthly subscription charge in addition to standard Amazon SES usage fees. The dashboard provides valuable insights for monitoring and optimizing email deliverability performance.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the dashboard enablement setting and optional domain subscriptions. |
Returns
A response object indicating the successful configuration of Deliverability dashboard options.
function PutDeliverabilityDashboardOption( const ADashboardEnabled: Boolean): ISESV2PutDeliverabilityDashboardOptionResponse; overload;
ISESV2PutDeliverabilityDashboardOptionResponse
Enables or disables the Deliverability dashboard for your Amazon SES account.
Parameters
| Name | Description |
|---|---|
ADashboardEnabled | Set toto enable the Deliverability dashboard, orto disable it. |
Returns
A response object indicating the successful configuration of Deliverability dashboard options.
function PutDeliverabilityDashboardOption(const ADashboardEnabled: Boolean; const ASubscribedDomains: TArray<ISESV2DomainDeliverabilityTrackingOption>): ISESV2PutDeliverabilityDashboardOptionResponse; overload;
ISESV2DomainDeliverabilityTrackingOption → ISESV2PutDeliverabilityDashboardOptionResponse
Enables or disables the Deliverability dashboard for your Amazon SES account.
Parameters
| Name | Description |
|---|---|
ADashboardEnabled | Set toto enable the Deliverability dashboard, orto disable it. |
ASubscribedDomains | An array of verified domains to subscribe for detailed deliverability tracking and inbox placement monitoring. |
Returns
A response object indicating the successful configuration of Deliverability dashboard options.
PutEmailIdentityConfigurationSetAttributes
function PutEmailIdentityConfigurationSetAttributes( const ARequest: ISESV2PutEmailIdentityConfigurationSetAttributesRequest): ISESV2PutEmailIdentityConfigurationSetAttributesResponse; overload;
ISESV2PutEmailIdentityConfigurationSetAttributesRequest → ISESV2PutEmailIdentityConfigurationSetAttributesResponse
Associates a configuration set with an email identity.
This operation sets or updates the default configuration set for a verified email identity. When associated, all emails sent from this identity will use the configuration set's settings unless overridden at send time. Configuration sets provide consistent delivery options, reputation tracking, event publishing, and suppression preferences across email identities and campaigns. Both the email identity and configuration set must already exist in your account.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity and configuration set name for association. |
Returns
A response object indicating the successful association of the configuration set with the email identity.
function PutEmailIdentityConfigurationSetAttributes( const AEmailIdentity: string; AConfigurationSetName: string = ''): ISESV2PutEmailIdentityConfigurationSetAttributesResponse; overload;
ISESV2PutEmailIdentityConfigurationSetAttributesResponse
Associates a configuration set with an email identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified email address or domain to associate with the configuration set. |
AConfigurationSetName | The name of the configuration set to associate with the identity. If empty, removes any existing association. |
Returns
A response object indicating the successful association of the configuration set with the email identity.
PutEmailIdentityDkimAttributes
function PutEmailIdentityDkimAttributes( const ARequest: ISESV2PutEmailIdentityDkimAttributesRequest): ISESV2PutEmailIdentityDkimAttributesResponse; overload;
ISESV2PutEmailIdentityDkimAttributesRequest → ISESV2PutEmailIdentityDkimAttributesResponse
Enables or disables DKIM authentication for an email identity.
DKIM (DomainKeys Identified Mail) is an email authentication method that allows recipients to verify that messages were sent by the domain owner and have not been tampered with during transit. When DKIM signing is enabled, Amazon SES automatically adds DKIM signatures to all messages sent from the identity, improving deliverability and helping prevent email spoofing and phishing attacks. The email identity must be verified before DKIM can be configured.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity and DKIM signing configuration. |
Returns
A response object indicating the successful configuration of DKIM attributes.
function PutEmailIdentityDkimAttributes( const AEmailIdentity: string; ASigningEnabled: Boolean): ISESV2PutEmailIdentityDkimAttributesResponse; overload;
ISESV2PutEmailIdentityDkimAttributesResponse
Enables or disables DKIM authentication for an email identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified email address or domain to configure DKIM signing for. |
ASigningEnabled | Set toto enable DKIM signing for messages from this identity, orto disable it. |
Returns
A response object indicating the successful configuration of DKIM attributes.
PutEmailIdentityDkimSigningAttributes
function PutEmailIdentityDkimSigningAttributes( const ARequest: ISESV2PutEmailIdentityDkimSigningAttributesRequest): ISESV2PutEmailIdentityDkimSigningAttributesResponse; overload;
ISESV2PutEmailIdentityDkimSigningAttributesRequest → ISESV2PutEmailIdentityDkimSigningAttributesResponse
Configures or changes the DKIM authentication settings for an email domain identity.
This operation allows you to configure DKIM authentication using either Easy DKIM (Amazon SES managed keys) or Bring Your Own DKIM (BYODKIM) with your own private keys. You can also switch between authentication methods or transition from no DKIM to either approach. For Easy DKIM, Amazon SES provides DKIM tokens that you use to create CNAME records in your domain's DNS configuration. For BYODKIM, you provide your own private keys and selectors, and Amazon SES returns the selector for DNS TXT record creation. The domain identity must be verified before DKIM signing attributes can be configured.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity, signing attributes origin, and optional signing configuration. |
Returns
A response object containing the DKIM status and authentication tokens for DNS configuration.
function PutEmailIdentityDkimSigningAttributes( const AEmailIdentity, ASigningAttributesOrigin: string): ISESV2PutEmailIdentityDkimSigningAttributesResponse; overload;
ISESV2PutEmailIdentityDkimSigningAttributesResponse
Configures or changes the DKIM authentication settings for an email domain identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified domain identity to configure DKIM signing for. |
ASigningAttributesOrigin | The DKIM method to use:for Easy DKIM orfor Bring Your Own DKIM. |
Returns
A response object containing the DKIM status and authentication tokens for DNS configuration.
function PutEmailIdentityDkimSigningAttributes( const AEmailIdentity, ASigningAttributesOrigin: string; const ASigningAttributes: ISESV2DkimSigningAttributes): ISESV2PutEmailIdentityDkimSigningAttributesResponse; overload;
ISESV2DkimSigningAttributes → ISESV2PutEmailIdentityDkimSigningAttributesResponse
Configures or changes the DKIM authentication settings for an email domain identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified domain identity to configure DKIM signing for. |
ASigningAttributesOrigin | The DKIM method to use:for Easy DKIM orfor Bring Your Own DKIM. |
ASigningAttributes | The signing configuration including private keys and selectors for BYODKIM, or key length settings for Easy DKIM. |
Returns
A response object containing the DKIM status and authentication tokens for DNS configuration.
PutEmailIdentityFeedbackAttributes
function PutEmailIdentityFeedbackAttributes( const ARequest: ISESV2PutEmailIdentityFeedbackAttributesRequest): ISESV2PutEmailIdentityFeedbackAttributesResponse; overload;
ISESV2PutEmailIdentityFeedbackAttributesRequest → ISESV2PutEmailIdentityFeedbackAttributesResponse
Enables or disables feedback forwarding for an email identity.
This operation controls whether bounce and complaint notifications are forwarded as email messages to the address specified in the Return-Path header of sent emails. When enabled, you receive email notifications for bounce and complaint events. However, you are required to have a method of tracking these events, so if no other mechanism is configured (such as event destinations), notifications will be sent regardless of this setting. Feedback forwarding helps monitor email deliverability and maintain sender reputation by providing visibility into delivery issues and recipient complaints.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity and feedback forwarding configuration. |
Returns
A response object indicating the successful configuration of feedback attributes.
function PutEmailIdentityFeedbackAttributes( const AEmailIdentity: string; AEmailForwardingEnabled: Boolean): ISESV2PutEmailIdentityFeedbackAttributesResponse; overload;
ISESV2PutEmailIdentityFeedbackAttributesResponse
Enables or disables feedback forwarding for an email identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified email address or domain to configure feedback forwarding for. |
AEmailForwardingEnabled | Set toto enable email notifications for bounces and complaints, orto disable them. |
Returns
A response object indicating the successful configuration of feedback attributes.
PutEmailIdentityMailFromAttributes
function PutEmailIdentityMailFromAttributes( const ARequest: ISESV2PutEmailIdentityMailFromAttributesRequest): ISESV2PutEmailIdentityMailFromAttributesResponse;
ISESV2PutEmailIdentityMailFromAttributesRequest → ISESV2PutEmailIdentityMailFromAttributesResponse
Enables or disables the custom Mail-From domain configuration for an email identity.
This operation configures a custom Mail-From domain that appears in email headers instead of the default Amazon SES domain, improving sender reputation and email authentication by using your own domain for the MAIL FROM field. The custom Mail-From domain must be a subdomain of the verified identity and requires proper MX record configuration in DNS. You can specify fallback behavior for when MX record validation fails, either using the default amazonses.com domain or rejecting messages entirely. Mail-From domain configuration enhances SPF authentication and helps establish better sender reputation by showing your domain rather than Amazon SES infrastructure in email headers.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity, custom Mail-From domain, and MX failure behavior configuration. |
Returns
A response object indicating the successful configuration of Mail-From attributes.
PutSuppressedDestination
function PutSuppressedDestination( const ARequest: ISESV2PutSuppressedDestinationRequest): ISESV2PutSuppressedDestinationResponse; overload;
ISESV2PutSuppressedDestinationRequest → ISESV2PutSuppressedDestinationResponse
Adds an email address to the suppression list for your account.
This operation manually adds an email address to your account-level suppression list to prevent future email delivery attempts to that address, protecting your sender reputation from continued bounces or complaints. Suppressed addresses will not receive emails sent through Amazon SES until they are manually removed from the suppression list. This is useful for proactively managing problematic addresses that cause delivery issues. The suppression reason helps categorize why the address was suppressed and can be used for reporting and analysis of delivery issues.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email address and suppression reason. |
Returns
A response object indicating the successful addition of the email address to the suppression list.
function PutSuppressedDestination( const AEmailAddress, AReason: string): ISESV2PutSuppressedDestinationResponse; overload;
ISESV2PutSuppressedDestinationResponse
Adds an email address to the suppression list for your account.
Parameters
| Name | Description |
|---|---|
AEmailAddress | The email address to add to the suppression list. |
AReason | The reason for suppression:for hard bounce issues orfor spam complaints. |
Returns
A response object indicating the successful addition of the email address to the suppression list.
SendBulkEmail
function SendBulkEmail(const ARequest: ISESV2SendBulkEmailRequest): ISESV2SendBulkEmailResponse;
ISESV2SendBulkEmailRequest → ISESV2SendBulkEmailResponse
Composes and sends an email message to multiple destinations with personalization support.
This operation enables efficient sending of personalized emails to multiple recipients using templates, replacement data, and individual customization for each destination. Each recipient can have unique template data, headers, and tags while sharing common email content and structure. The operation processes each bulk email entry individually, returning success or failure status for each recipient. Successful entries receive unique message IDs for tracking, while failed entries include error descriptions for troubleshooting. Bulk email sending is subject to your account's sending quotas, rate limits, and reputation monitoring. Failed entries should be analyzed and potentially retried based on the specific error conditions returned in the response. All referenced resources including identities, configuration sets, and templates must exist and be properly configured before sending. The From address must be verified, and any specified configuration set must be available in your account.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing bulk email entries, default content, sender information, and delivery options. |
Returns
A response object containing the delivery status and message IDs for each individual email in the bulk operation.
SendCustomVerificationEmail
function SendCustomVerificationEmail( const ARequest: ISESV2SendCustomVerificationEmailRequest): ISESV2SendCustomVerificationEmailResponse; overload;
ISESV2SendCustomVerificationEmailRequest → ISESV2SendCustomVerificationEmailResponse
Adds an email address to your Amazon SES identities and sends a customized verification email.
This operation automatically adds the specified email address to your account's identity list and sends a custom verification email using a predefined template. The recipient must click the verification link to complete the identity verification process. You must create a custom verification email template before using this operation. The template defines the subject, content, and verification link structure for the verification email sent to recipients. This operation is rate-limited to one request per second to prevent abuse. The returned message ID can be used to track the verification email delivery.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email address, template name, and optional configuration set. |
Returns
A response object containing the unique message identifier for the verification email.
function SendCustomVerificationEmail( const AEmailAddress, ATemplateName: string; AConfigurationSetName: string = ''): ISESV2SendCustomVerificationEmailResponse; overload;
ISESV2SendCustomVerificationEmailResponse
Adds an email address to your Amazon SES identities and sends a customized verification email.
Parameters
| Name | Description |
|---|---|
AEmailAddress | The email address to verify and add to your account's identity list. |
ATemplateName | The name of the custom verification email template to use for sending the verification email. |
AConfigurationSetName | Optional name of a configuration set to use when sending the verification email. If empty, default settings are used. |
Returns
A response object containing the unique message identifier for the verification email.
SendEmail
function SendEmail(const ARequest: ISESV2SendEmailRequest): ISESV2SendEmailResponse;
ISESV2SendEmailRequest → ISESV2SendEmailResponse
Sends an email message using Amazon SES with support for Simple, Raw, or Templated content.
This operation supports three types of email messages: Simple (standard email with subject and body), Raw (MIME-formatted email with full header control and attachments), and Templated (personalized email using templates with automatic tag replacement). The email is immediately queued for sending after acceptance. Amazon SES may accept a message without sending it in cases such as virus detection in attachments or invalid personalization content in templated emails. All referenced resources including From addresses, configuration sets, and templates must be verified and properly configured. The From address must be a verified identity in your Amazon SES account. The returned message ID can be used to track delivery events, correlate bounce and complaint notifications, and troubleshoot delivery issues through Amazon SES monitoring and event publishing systems.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing email content, recipients, sender information, and delivery options. |
Returns
A response object containing the unique message identifier for tracking the sent email.
TagResource
function TagResource(const ARequest: ISESV2TagResourceRequest): ISESV2TagResourceResponse;
ISESV2TagResourceRequest → ISESV2TagResourceResponse
Adds one or more tags to a specified Amazon SES resource.
This operation attaches metadata labels to Amazon SES resources such as configuration sets, email identities, dedicated IP pools, and contact lists. Tags help categorize and manage resources by purpose, owner, environment, or other organizational criteria. Each tag consists of a required tag key (maximum 128 characters) and an associated tag value (maximum 256 characters). A single resource can have up to 50 tags total, providing flexible resource organization and management capabilities. Tags enable attribute-based access control, cost allocation tracking, resource filtering, and automated resource management policies. They are essential for implementing governance and operational best practices in multi-environment or multi-tenant scenarios. This operation may result in a ESESV2ConcurrentModificationException if the resource is being modified by another operation simultaneously.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the resource ARN and the tags to add. |
Returns
A response object indicating the successful addition of tags to the resource.
TestRenderEmailTemplate
function TestRenderEmailTemplate( const ARequest: ISESV2TestRenderEmailTemplateRequest): ISESV2TestRenderEmailTemplateResponse; overload;
ISESV2TestRenderEmailTemplateRequest → ISESV2TestRenderEmailTemplateResponse
Creates a preview of the MIME content of an email using a template and replacement data.
This operation allows you to test and preview how an email template will appear when personalization tags are replaced with actual data before sending emails to recipients. This is essential for validating template formatting and content. The template data is a JSON object containing key-value pairs where keys correspond to replacement tags in the email template. Amazon SES processes these tags and generates the final MIME-formatted email content. This operation is rate-limited to one request per second to prevent abuse. The template must exist in your Amazon SES account before rendering can be tested.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name and replacement data for rendering. |
Returns
A response object containing the complete MIME message with personalization data applied.
function TestRenderEmailTemplate( const ATemplateName, ATemplateData: string): ISESV2TestRenderEmailTemplateResponse; overload;
ISESV2TestRenderEmailTemplateResponse
Creates a preview of the MIME content of an email using a template and replacement data.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the email template to render. Must be at least 1 character in length. |
ATemplateData | The JSON object containing key-value pairs for template tag replacement, with a maximum length of 262144 characters. |
Returns
A response object containing the complete MIME message with personalization data applied.
UntagResource
function UntagResource( const ARequest: ISESV2UntagResourceRequest): ISESV2UntagResourceResponse; overload;
ISESV2UntagResourceRequest → ISESV2UntagResourceResponse
Removes one or more tags from a specified Amazon SES resource.
This operation removes metadata labels from Amazon SES resources such as configuration sets, email identities, dedicated IP pools, and contact lists. When a tag key is specified, both the key and its associated value are removed from the resource. Tag removal is useful for cleaning up outdated metadata, changing resource categorization, or updating access control policies that rely on tag-based permissions. Multiple tag keys can be removed in a single operation for efficient resource management. If a specified tag key does not exist on the resource, it is silently ignored without causing an error. This allows for safe cleanup operations even when tag states are uncertain. This operation may result in a ESESV2ConcurrentModificationException if the resource is being modified by another operation simultaneously.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the resource ARN and the tag keys to remove. |
Returns
A response object indicating the successful removal of tags from the resource.
function UntagResource( const AResourceArn: TARN; ATagKeys: TArray<string>): ISESV2UntagResourceResponse; overload;
Removes one or more tags from a specified Amazon SES resource.
Parameters
| Name | Description |
|---|---|
AResourceArn | The Amazon Resource Name (ARN) of the resource to remove tags from. |
ATagKeys | The array of tag keys to remove from the resource. Both keys and their associated values will be removed. |
Returns
A response object indicating the successful removal of tags from the resource.
UpdateConfigurationSetEventDestination
function UpdateConfigurationSetEventDestination( const ARequest: ISESV2UpdateConfigurationSetEventDestinationRequest): ISESV2UpdateConfigurationSetEventDestinationResponse; overload;
ISESV2UpdateConfigurationSetEventDestinationRequest → ISESV2UpdateConfigurationSetEventDestinationResponse
Updates the configuration of an event destination for a configuration set.
This operation modifies how email sending events (sends, deliveries, opens, clicks, bounces, and complaints) are published to external services. Event destinations can route data to Amazon EventBridge, CloudWatch, Kinesis Data Firehose, SNS, or Pinpoint. Event destinations enable monitoring and analysis of email campaign performance by sending real-time event data to analytics platforms, monitoring systems, or custom applications for processing and visualization. Both the configuration set and event destination must exist before updates can be applied. The updated configuration takes effect immediately for future email events.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the configuration set name, event destination name, and updated event destination settings. |
Returns
A response object indicating the successful update of the event destination configuration.
function UpdateConfigurationSetEventDestination( const AConfigurationSetName, AEventDestinationName: string; const AEventDestination: ISESV2EventDestinationDefinition): ISESV2UpdateConfigurationSetEventDestinationResponse; overload;
ISESV2EventDestinationDefinition → ISESV2UpdateConfigurationSetEventDestinationResponse
Updates the configuration of an event destination for a configuration set.
Parameters
| Name | Description |
|---|---|
AConfigurationSetName | The name of the configuration set that contains the event destination to modify. |
AEventDestinationName | The name of the event destination to update. |
AEventDestination | The updated event destination configuration including destination type, settings, and event types. |
Returns
A response object indicating the successful update of the event destination configuration.
UpdateContact
function UpdateContact(const ARequest: ISESV2UpdateContactRequest): ISESV2UpdateContactResponse;
ISESV2UpdateContactRequest → ISESV2UpdateContactResponse
Updates a contact's subscription preferences and attributes for a contact list.
This operation modifies an existing contact's subscription preferences for specific topics within a contact list, updates their attribute data, and manages their global unsubscribe status for comprehensive subscription management. When updating topic preferences, you must specify all existing topic preferences that you want to preserve. Any topic preferences not included in the update will be removed from the contact, so ensure all desired preferences are included. The operation supports granular subscription control through individual topic preferences and provides a master unsubscribe option that overrides all topic settings to comply with email marketing regulations and user preferences. Both the contact list and the specific contact must exist before updates can be applied. This operation may result in a ESESV2ConcurrentModificationException if the contact is being modified by another operation simultaneously.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name, email address, and updated contact preferences and attributes. |
Returns
A response object indicating the successful update of the contact's information.
UpdateContactList
function UpdateContactList(const ARequest: ISESV2UpdateContactListRequest): ISESV2UpdateContactListResponse;
ISESV2UpdateContactListRequest → ISESV2UpdateContactListResponse
Updates contact list metadata with a complete replacement of existing configuration.
This operation performs a complete replacement of the contact list's metadata, including its description and topic definitions. All existing metadata is replaced with the new configuration provided in the request. Topics define interest groups, themes, or categories within the contact list that subscribers can selectively subscribe to or unsubscribe from. Each topic includes a name, display name, description, and default subscription status for new contacts. The contact list must exist before updates can be applied. Existing contacts within the list retain their individual subscription preferences, but any topics not included in the update will be removed from the contact list structure. This operation may result in a ESESV2ConcurrentModificationException if the contact list is being modified by another operation simultaneously. Use this operation to reorganize subscription categories and update contact list information.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the contact list name and updated metadata including description and topics. |
Returns
A response object indicating the successful update of the contact list metadata.
UpdateCustomVerificationEmailTemplate
function UpdateCustomVerificationEmailTemplate( const ARequest: ISESV2UpdateCustomVerificationEmailTemplateRequest): ISESV2UpdateCustomVerificationEmailTemplateResponse;
ISESV2UpdateCustomVerificationEmailTemplateRequest → ISESV2UpdateCustomVerificationEmailTemplateResponse
Updates an existing custom verification email template with new content and configuration.
This operation modifies an existing custom verification email template used for branded identity verification processes. The template defines the email content, subject line, sender address, and success/failure redirection URLs for the verification workflow. Custom verification email templates enable you to brand the verification process to match your application's look and feel, improving user trust and completion rates during email address verification. The From email address must be a verified identity in your Amazon SES account, and the template content must be less than 10 MB with HTML formatting limitations for security and compatibility. This operation is rate-limited to one request per second to prevent abuse. The updated template takes effect immediately for future verification emails sent using this template.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name and updated template settings including content, subject, and redirection URLs. |
Returns
A response object indicating the successful update of the custom verification email template.
UpdateEmailIdentityPolicy
function UpdateEmailIdentityPolicy( const ARequest: ISESV2UpdateEmailIdentityPolicyRequest): ISESV2UpdateEmailIdentityPolicyResponse; overload;
ISESV2UpdateEmailIdentityPolicyRequest → ISESV2UpdateEmailIdentityPolicyResponse
Updates the specified sending authorization policy for an email identity.
This operation updates or creates a sending authorization policy that enables other AWS accounts to send emails using your verified email identity. Sending authorization allows controlled delegation of email sending privileges to trusted third parties. The operation succeeds even if a policy with the specified name does not exist, effectively creating a new policy in such cases. This API is restricted to verified identity owners and cannot be used by unauthorized accounts. Sending authorization policies are JSON documents that define permissions, conditions, and restrictions for authorized senders. The policy must be valid JSON and cannot exceed 4 KB in size. This operation is rate-limited to one request per second to prevent abuse. Policy updates take effect immediately for future email sending operations.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the email identity, policy name, and policy document. |
Returns
A response object indicating the successful update of the email identity policy.
function UpdateEmailIdentityPolicy( const AEmailIdentity, APolicyName, APolicy: string): ISESV2UpdateEmailIdentityPolicyResponse; overload;
ISESV2UpdateEmailIdentityPolicyResponse
Updates the specified sending authorization policy for an email identity.
Parameters
| Name | Description |
|---|---|
AEmailIdentity | The verified email address or domain to update the policy for. Must be at least 1 character in length. |
APolicyName | The name of the policy to update. Must be 1-64 characters and can only include alphanumeric characters, dashes, and underscores. |
APolicy | The JSON policy document defining sending authorization permissions. Must be valid JSON and cannot exceed 4 KB. |
Returns
A response object indicating the successful update of the email identity policy.
UpdateEmailTemplate
function UpdateEmailTemplate( const ARequest: ISESV2UpdateEmailTemplateRequest): ISESV2UpdateEmailTemplateResponse; overload;
ISESV2UpdateEmailTemplateRequest → ISESV2UpdateEmailTemplateResponse
Updates an existing email template with new content for personalized email campaigns.
This operation modifies an existing email template used for sending personalized emails to multiple destinations. Email templates enable efficient bulk email sending by defining reusable content with replacement tags for dynamic personalization. The template content should include a subject line and either HTML body, text body, or both to ensure compatibility across all email clients and accessibility requirements. Providing both formats improves deliverability and user experience. Template updates replace the entire existing content with the new configuration. Personalization tags within the content are replaced with actual recipient data when emails are sent using the template. This operation is rate-limited to one request per second to prevent abuse. The template must exist before it can be updated, and changes take effect immediately for future email sending operations.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the template name and updated template content. |
Returns
A response object indicating the successful update of the email template.
function UpdateEmailTemplate(const ATemplateName: string; const ATemplateContent: ISESV2EmailTemplateContent): ISESV2UpdateEmailTemplateResponse; overload;
ISESV2EmailTemplateContent → ISESV2UpdateEmailTemplateResponse
Updates an existing email template with new content for personalized email campaigns.
Parameters
| Name | Description |
|---|---|
ATemplateName | The name of the existing email template to update. Must be at least 1 character in length. |
ATemplateContent | The updated template content including subject line, HTML body, and text body. |
Returns
A response object indicating the successful update of the email template.
UpdateReputationEntityCustomerManagedStatus
function UpdateReputationEntityCustomerManagedStatus( const ARequest: ISESV2UpdateReputationEntityCustomerManagedStatusRequest): ISESV2UpdateReputationEntityCustomerManagedStatusResponse; overload;
ISESV2UpdateReputationEntityCustomerManagedStatusRequest → ISESV2UpdateReputationEntityCustomerManagedStatusResponse
Updates the customer-managed sending status for a reputation entity.
This operation allows you to enable, disable, or reinstate sending for a reputation entity independent of Amazon SES automated reputation management decisions. The customer-managed status works in conjunction with the AWS-managed status to determine overall sending capability. When you update the customer-managed status, the AWS-managed status remains unchanged. If AWS has disabled the entity due to reputation issues, it will not be allowed to send regardless of the customer-managed status setting. The reinstated status provides temporary override capability, allowing sending even with active reputation findings until they are resolved or new violations occur. This is useful for urgent sending needs while addressing reputation issues. This operation may result in a ConflictException if there is an ongoing account details update under review.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the reputation entity type, reference, and new sending status. |
Returns
A response object indicating the successful update of the reputation entity's customer-managed status.
function UpdateReputationEntityCustomerManagedStatus( const AReputationEntityType, AReputationEntityReference, ASendingStatus: string): ISESV2UpdateReputationEntityCustomerManagedStatusResponse; overload;
ISESV2UpdateReputationEntityCustomerManagedStatusResponse
Updates the customer-managed sending status for a reputation entity.
Parameters
| Name | Description |
|---|---|
AReputationEntityType | The type of reputation entity. Currently onlyis supported. |
AReputationEntityReference | The unique identifier (ARN) for the reputation entity. Must be at least 1 character in length. |
ASendingStatus | The new sending status:,, or. |
Returns
A response object indicating the successful update of the reputation entity's customer-managed status.
UpdateReputationEntityPolicy
function UpdateReputationEntityPolicy( const ARequest: ISESV2UpdateReputationEntityPolicyRequest): ISESV2UpdateReputationEntityPolicyResponse; overload;
ISESV2UpdateReputationEntityPolicyRequest → ISESV2UpdateReputationEntityPolicyResponse
Updates the reputation management policy for a reputation entity.
This operation assigns an AWS-managed reputation policy to a reputation entity, determining how the entity automatically responds to reputation findings such as high bounce rates, complaints, or other deliverability issues. Reputation management policies are predefined by Amazon SES and include options ranging from none (no automated actions) to strict (aggressive enforcement with low tolerance). The selected policy automatically pauses sending when certain thresholds are exceeded. These automated policies help protect your overall sender reputation by preventing continued sending from entities experiencing reputation problems, thereby maintaining deliverability across all your email sending resources. This operation may result in a ESESV2ConflictException if there is an ongoing account details update under review.
Parameters
| Name | Description |
|---|---|
ARequest | The request object containing the reputation entity type, reference, and policy ARN. |
Returns
A response object indicating the successful update of the reputation entity's management policy.
function UpdateReputationEntityPolicy( const AReputationEntityType, AReputationEntityReference: string; const AReputationEntityPolicy: TARN): ISESV2UpdateReputationEntityPolicyResponse; overload;
ISESV2UpdateReputationEntityPolicyResponse
Updates the reputation management policy for a reputation entity.
Parameters
| Name | Description |
|---|---|
AReputationEntityType | The type of reputation entity. Currently onlyis supported. |
AReputationEntityReference | The unique identifier (ARN) for the reputation entity. Must be at least 1 character in length. |
AReputationEntityPolicy | The ARN of the AWS-managed reputation policy to apply to the entity. |
Returns
A response object indicating the successful update of the reputation entity's management policy.