Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/ses.ts?docs=full";

§Classes

SES

§Interfaces

AddHeaderAction

When included in a receipt rule, this action adds a header to the received email.

Body

Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.

BounceAction

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

BouncedRecipientInfo

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

BulkEmailDestination

An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

BulkEmailDestinationStatus

An object that contains the response from the SendBulkTemplatedEmail operation.

CloneReceiptRuleSetRequest

Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

CloudWatchDestination

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

CloudWatchDimensionConfiguration

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

ConfigurationSet

The name of the configuration set.

Content

Represents textual data, plus an optional character set specification.

CreateConfigurationSetEventDestinationRequest

Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

CreateConfigurationSetRequest

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

CreateConfigurationSetTrackingOptionsRequest

Represents a request to create an open and click tracking option object in a configuration set.

CreateCustomVerificationEmailTemplateRequest

Represents a request to create a custom verification email template.

CreateReceiptFilterRequest

Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

CreateReceiptRuleRequest

Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

CreateReceiptRuleSetRequest

Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

CreateTemplateRequest

Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.

CustomVerificationEmailTemplate

Contains information about a custom verification email template.

DeleteConfigurationSetEventDestinationRequest

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

DeleteConfigurationSetRequest

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

DeleteConfigurationSetTrackingOptionsRequest

Represents a request to delete open and click tracking options in a configuration set.

DeleteCustomVerificationEmailTemplateRequest

Represents a request to delete an existing custom verification email template.

DeleteIdentityPolicyRequest

Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

DeleteIdentityRequest

Represents a request to delete one of your Amazon SES identities (an email address or domain).

DeleteReceiptFilterRequest

Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

DeleteReceiptRuleRequest

Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

DeleteReceiptRuleSetRequest

Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

DeleteTemplateRequest

Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.

DeleteVerifiedEmailAddressRequest

Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.

DeliveryOptions

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

DescribeActiveReceiptRuleSetResponse

Represents the metadata and receipt rules for the receipt rule set that is currently active.

DescribeConfigurationSetRequest

Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

DescribeConfigurationSetResponse

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

DescribeReceiptRuleRequest

Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

DescribeReceiptRuleResponse

Represents the details of a receipt rule.

DescribeReceiptRuleSetRequest

Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

DescribeReceiptRuleSetResponse

Represents the details of the specified receipt rule set.

Destination

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

EventDestination

Contains information about the event destination that the specified email sending events will be published to.

ExtensionField

Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

GetAccountSendingEnabledResponse

Represents a request to return the email sending status for your Amazon SES account in the current AWS Region.

GetCustomVerificationEmailTemplateRequest

Represents a request to retrieve an existing custom verification email template.

GetCustomVerificationEmailTemplateResponse

The content of the custom verification email template.

GetIdentityDkimAttributesRequest

Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.

GetIdentityDkimAttributesResponse

Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.

GetIdentityMailFromDomainAttributesRequest

Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

GetIdentityMailFromDomainAttributesResponse

Represents the custom MAIL FROM attributes for a list of identities.

GetIdentityNotificationAttributesRequest

Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

GetIdentityNotificationAttributesResponse

Represents the notification attributes for a list of identities.

GetIdentityPoliciesRequest

Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

GetIdentityPoliciesResponse

Represents the requested sending authorization policies.

GetIdentityVerificationAttributesRequest

Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.

GetIdentityVerificationAttributesResponse

The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

GetSendQuotaResponse

Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

GetSendStatisticsResponse

Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

GetTemplateRequest
GetTemplateResponse
IdentityDkimAttributes

Represents the DKIM attributes of a verified email address or a domain.

IdentityMailFromDomainAttributes

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

IdentityNotificationAttributes

Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

IdentityVerificationAttributes

Represents the verification attributes of a single identity.

KinesisFirehoseDestination

Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

LambdaAction

When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

ListConfigurationSetsRequest

Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

ListConfigurationSetsResponse

A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

ListCustomVerificationEmailTemplatesRequest

Represents a request to list the existing custom verification email templates for your account.

ListCustomVerificationEmailTemplatesResponse

A paginated list of custom verification email templates.

ListIdentitiesRequest

Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.

ListIdentitiesResponse

A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.

ListIdentityPoliciesRequest

Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

ListIdentityPoliciesResponse

A list of names of sending authorization policies that apply to an identity.

ListReceiptFiltersResponse

A list of IP address filters that exist under your AWS account.

ListReceiptRuleSetsRequest

Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

ListReceiptRuleSetsResponse

A list of receipt rule sets that exist under your AWS account.

ListTemplatesRequest
ListTemplatesResponse
ListVerifiedEmailAddressesResponse

A list of email addresses that you have verified with Amazon SES under your AWS account.

Message

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

MessageDsn

Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

MessageTag

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

PutConfigurationSetDeliveryOptionsRequest

A request to modify the delivery options for a configuration set.

PutIdentityPolicyRequest

Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

RawMessage

Represents the raw data of the message.

ReceiptAction

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

ReceiptFilter

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

ReceiptIpFilter

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

ReceiptRule

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

ReceiptRuleSetMetadata

Information about a receipt rule set.

RecipientDsnFields

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

ReorderReceiptRuleSetRequest

Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

ReputationOptions

Contains information about the reputation settings for a configuration set.

S3Action

When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

SendBounceRequest

Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

SendBounceResponse

Represents a unique message ID.

SendBulkTemplatedEmailRequest

Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendBulkTemplatedEmailResponse
SendCustomVerificationEmailRequest

Represents a request to send a custom verification email to a specified recipient.

SendCustomVerificationEmailResponse

The response received when attempting to send the custom verification email.

SendDataPoint

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

SendEmailRequest

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendEmailResponse

Represents a unique message ID.

SendRawEmailRequest

Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendRawEmailResponse

Represents a unique message ID.

SendTemplatedEmailRequest

Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendTemplatedEmailResponse
SetActiveReceiptRuleSetRequest

Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

SetIdentityDkimEnabledRequest

Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

SetIdentityFeedbackForwardingEnabledRequest

Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.

SetIdentityHeadersInNotificationsEnabledRequest

Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

SetIdentityMailFromDomainRequest

Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

SetIdentityNotificationTopicRequest

Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint, or delivery notifications for emails sent with that identity as the Source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

SetReceiptRulePositionRequest

Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

SNSAction

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

SNSDestination

Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

StopAction

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

Template

The content of the email, composed of a subject line, an HTML part, and a text-only part.

TemplateMetadata

Contains information about an email template.

TestRenderTemplateRequest
TestRenderTemplateResponse
TrackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

UpdateAccountSendingEnabledRequest

Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.

UpdateConfigurationSetEventDestinationRequest

Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

UpdateConfigurationSetReputationMetricsEnabledRequest

Represents a request to modify the reputation metric publishing settings for a configuration set.

UpdateConfigurationSetSendingEnabledRequest

Represents a request to enable or disable the email sending capabilities for a specific configuration set.

UpdateConfigurationSetTrackingOptionsRequest

Represents a request to update the tracking options for a configuration set.

UpdateCustomVerificationEmailTemplateRequest

Represents a request to update an existing custom verification email template.

UpdateReceiptRuleRequest

Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

UpdateTemplateRequest
VerifyDomainDkimRequest

Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

VerifyDomainDkimResponse

Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

VerifyDomainIdentityRequest

Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.

VerifyDomainIdentityResponse

Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

VerifyEmailAddressRequest

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

VerifyEmailIdentityRequest

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

WorkmailAction

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

§Type Aliases

BehaviorOnMXFailure
BounceType
BulkEmailStatus
ConfigurationSetAttribute
CustomMailFromStatus
DimensionValueSource
DsnAction
EventType
IdentityType
InvocationType
NotificationType
ReceiptFilterPolicy
SNSActionEncoding
StopScope
TlsPolicy
VerificationStatus