types

package
v1.29.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 4 Imported by: 69

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountSendingPausedException 

type AccountSendingPausedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

func (*AccountSendingPausedException) Error 

func (e *AccountSendingPausedException) Error() string

func (*AccountSendingPausedException) ErrorCode 

func (e *AccountSendingPausedException) ErrorCode() string

func (*AccountSendingPausedException) ErrorFault 

func (e *AccountSendingPausedException) ErrorFault() smithy.ErrorFault

func (*AccountSendingPausedException) ErrorMessage 

func (e *AccountSendingPausedException) ErrorMessage() string

type AddHeaderAction 

type AddHeaderAction struct {

	// The name of the header to add to the incoming message. The name must contain at
	// least one character, and can contain up to 50 characters. It consists of
	// alphanumeric (a–z, A–Z, 0–9) characters and dashes.
	//
	// This member is required.
	HeaderName *string

	// The content to include in the header. This value can contain up to 2048
	// characters. It can't contain newline ( \n ) or carriage return ( \r ) characters.
	//
	// This member is required.
	HeaderValue *string
	// contains filtered or unexported fields
}

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

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

type AlreadyExistsException 

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	Name *string
	// contains filtered or unexported fields
}

Indicates that a resource could not be created because of a naming conflict.

func (*AlreadyExistsException) Error 

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode 

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault 

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage 

func (e *AlreadyExistsException) ErrorMessage() string

type BehaviorOnMXFailure 

type BehaviorOnMXFailure string
const (
	BehaviorOnMXFailureUseDefaultValue BehaviorOnMXFailure = "UseDefaultValue"
	BehaviorOnMXFailureRejectMessage   BehaviorOnMXFailure = "RejectMessage"
)

Enum values for BehaviorOnMXFailure

func (BehaviorOnMXFailure) Values added in v0.29.0 

func (BehaviorOnMXFailure) Values() []BehaviorOnMXFailure

Values returns all known values for BehaviorOnMXFailure. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Body 

type Body struct {

	// The content of the message, in HTML format. Use this for email clients that can
	// process HTML. You can include clickable links, formatted text, and much more in
	// an HTML message.
	Html *Content

	// The content of the message, in text format. Use this for text-based email
	// clients, or clients on high-latency networks (such as mobile devices).
	Text *Content
	// contains filtered or unexported fields
}

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.

type BounceAction 

type BounceAction struct {

	// Human-readable text to include in the bounce message.
	//
	// This member is required.
	Message *string

	// The email address of the sender of the bounced email. This is the address from
	// which the bounce message is sent.
	//
	// This member is required.
	Sender *string

	// The SMTP reply code, as defined by [RFC 5321].
	//
	// [RFC 5321]: https://tools.ietf.org/html/rfc5321
	//
	// This member is required.
	SmtpReplyCode *string

	// The SMTP enhanced status code, as defined by [RFC 3463].
	//
	// [RFC 3463]: https://tools.ietf.org/html/rfc3463
	StatusCode *string

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
	// bounce action is taken. You can find the ARN of a topic by using the [ListTopics]operation
	// in Amazon SNS.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	TopicArn *string
	// contains filtered or unexported fields
}

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).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

type BounceType 

type BounceType string
const (
	BounceTypeDoesNotExist     BounceType = "DoesNotExist"
	BounceTypeMessageTooLarge  BounceType = "MessageTooLarge"
	BounceTypeExceededQuota    BounceType = "ExceededQuota"
	BounceTypeContentRejected  BounceType = "ContentRejected"
	BounceTypeUndefined        BounceType = "Undefined"
	BounceTypeTemporaryFailure BounceType = "TemporaryFailure"
)

Enum values for BounceType

func (BounceType) Values added in v0.29.0 

func (BounceType) Values() []BounceType

Values returns all known values for BounceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BouncedRecipientInfo 

type BouncedRecipientInfo struct {

	// The email address of the recipient of the bounced email.
	//
	// This member is required.
	Recipient *string

	// The reason for the bounce. You must provide either this parameter or
	// RecipientDsnFields .
	BounceType BounceType

	// This parameter is used only for sending authorization. It is the ARN of the
	// identity that is associated with the sending authorization policy that permits
	// you to receive email for the recipient of the bounced email. For more
	// information about sending authorization, see the [Amazon SES Developer Guide].
	//
	// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
	RecipientArn *string

	// Recipient-related DSN fields, most of which would normally be filled in
	// automatically when provided with a BounceType . You must provide either this
	// parameter or BounceType .
	RecipientDsnFields *RecipientDsnFields
	// contains filtered or unexported fields
}

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

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

type BulkEmailDestination 

type BulkEmailDestination struct {

	// Represents the destination of the message, consisting of To:, CC:, and BCC:
	// fields.
	//
	// Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this
	// reason, the email address string must be 7-bit ASCII. If you want to send to or
	// from email addresses that contain Unicode characters in the domain part of an
	// address, you must encode the domain using Punycode. Punycode is not permitted in
	// the local part of the email address (the part before the @ sign) nor in the
	// "friendly from" name. If you want to use Unicode characters in the "friendly
	// from" name, you must encode the "friendly from" name using MIME encoded-word
	// syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].
	//
	// [RFC6531]: https://tools.ietf.org/html/rfc6531
	// [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
	// [RFC 3492]: http://tools.ietf.org/html/rfc3492
	//
	// This member is required.
	Destination *Destination

	// A list of tags, in the form of name/value pairs, to apply to an email that you
	// send using SendBulkTemplatedEmail . Tags correspond to characteristics of the
	// email that you define, so that you can publish email sending events.
	ReplacementTags []MessageTag

	// A list of replacement values to apply to the template. This parameter is a JSON
	// object, typically consisting of key-value pairs in which the keys correspond to
	// replacement tags in the email template.
	ReplacementTemplateData *string
	// contains filtered or unexported fields
}

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

type BulkEmailDestinationStatus 

type BulkEmailDestinationStatus struct {

	// A description of an error that prevented a message being sent using the
	// SendBulkTemplatedEmail operation.
	Error *string

	// The unique message identifier returned from the SendBulkTemplatedEmail
	// operation.
	MessageId *string

	// The status of a message sent using the SendBulkTemplatedEmail operation.
	//
	// Possible values for this parameter include:
	//
	//   - Success : Amazon SES accepted the message, and attempts to deliver it to the
	//   recipients.
	//
	//   - MessageRejected : The message was rejected because it contained a virus.
	//
	//   - MailFromDomainNotVerified : The sender's email address or domain was not
	//   verified.
	//
	//   - ConfigurationSetDoesNotExist : The configuration set you specified does not
	//   exist.
	//
	//   - TemplateDoesNotExist : The template you specified does not exist.
	//
	//   - AccountSuspended : Your account has been shut down because of issues related
	//   to your email sending practices.
	//
	//   - AccountThrottled : The number of emails you can send has been reduced
	//   because your account has exceeded its allocated sending limit.
	//
	//   - AccountDailyQuotaExceeded : You have reached or exceeded the maximum number
	//   of emails you can send from your account in a 24-hour period.
	//
	//   - InvalidSendingPoolName : The configuration set you specified refers to an IP
	//   pool that does not exist.
	//
	//   - AccountSendingPaused : Email sending for the Amazon SES account was disabled
	//   using the UpdateAccountSendingEnabledoperation.
	//
	//   - ConfigurationSetSendingPaused : Email sending for this configuration set was
	//   disabled using the UpdateConfigurationSetSendingEnabledoperation.
	//
	//   - InvalidParameterValue : One or more of the parameters you specified when
	//   calling this operation was invalid. See the error message for additional
	//   information.
	//
	//   - TransientFailure : Amazon SES was unable to process your request because of
	//   a temporary issue.
	//
	//   - Failed : Amazon SES was unable to process your request. See the error
	//   message for additional information.
	Status BulkEmailStatus
	// contains filtered or unexported fields
}

An object that contains the response from the SendBulkTemplatedEmail operation.

type BulkEmailStatus 

type BulkEmailStatus string
const (
	BulkEmailStatusSuccess                       BulkEmailStatus = "Success"
	BulkEmailStatusMessageRejected               BulkEmailStatus = "MessageRejected"
	BulkEmailStatusMailFromDomainNotVerified     BulkEmailStatus = "MailFromDomainNotVerified"
	BulkEmailStatusConfigurationSetDoesNotExist  BulkEmailStatus = "ConfigurationSetDoesNotExist"
	BulkEmailStatusTemplateDoesNotExist          BulkEmailStatus = "TemplateDoesNotExist"
	BulkEmailStatusAccountSuspended              BulkEmailStatus = "AccountSuspended"
	BulkEmailStatusAccountThrottled              BulkEmailStatus = "AccountThrottled"
	BulkEmailStatusAccountDailyQuotaExceeded     BulkEmailStatus = "AccountDailyQuotaExceeded"
	BulkEmailStatusInvalidSendingPoolName        BulkEmailStatus = "InvalidSendingPoolName"
	BulkEmailStatusAccountSendingPaused          BulkEmailStatus = "AccountSendingPaused"
	BulkEmailStatusConfigurationSetSendingPaused BulkEmailStatus = "ConfigurationSetSendingPaused"
	BulkEmailStatusInvalidParameterValue         BulkEmailStatus = "InvalidParameterValue"
	BulkEmailStatusTransientFailure              BulkEmailStatus = "TransientFailure"
	BulkEmailStatusFailed                        BulkEmailStatus = "Failed"
)

Enum values for BulkEmailStatus

func (BulkEmailStatus) Values added in v0.29.0 

func (BulkEmailStatus) Values() []BulkEmailStatus

Values returns all known values for BulkEmailStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CannotDeleteException 

type CannotDeleteException struct {
	Message *string

	ErrorCodeOverride *string

	Name *string
	// contains filtered or unexported fields
}

Indicates that the delete operation could not be completed.

func (*CannotDeleteException) Error 

func (e *CannotDeleteException) Error() string

func (*CannotDeleteException) ErrorCode 

func (e *CannotDeleteException) ErrorCode() string

func (*CannotDeleteException) ErrorFault 

func (e *CannotDeleteException) ErrorFault() smithy.ErrorFault

func (*CannotDeleteException) ErrorMessage 

func (e *CannotDeleteException) ErrorMessage() string

type CloudWatchDestination 

type CloudWatchDestination struct {

	// A list of dimensions upon which to categorize your emails when you publish
	// email sending events to Amazon CloudWatch.
	//
	// This member is required.
	DimensionConfigurations []CloudWatchDimensionConfiguration
	// contains filtered or unexported fields
}

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

Event destinations, such as Amazon CloudWatch, 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.

type CloudWatchDimensionConfiguration 

type CloudWatchDimensionConfiguration struct {

	// The default value of the dimension that is published to Amazon CloudWatch if
	// you do not provide the value of the dimension when you send an email. The
	// default value must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
	//   dashes (-), at signs (@), or periods (.).
	//
	//   - Contain 256 characters or fewer.
	//
	// This member is required.
	DefaultDimensionValue *string

	// The name of an Amazon CloudWatch dimension associated with an email sending
	// metric. The name must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
	//   dashes (-), or colons (:).
	//
	//   - Contain 256 characters or fewer.
	//
	// This member is required.
	DimensionName *string

	// The place where Amazon SES finds the value of a dimension to publish to Amazon
	// CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS
	// header or a parameter to the SendEmail / SendRawEmail API, specify messageTag .
	// To use your own email headers, specify emailHeader . To put a custom tag on any
	// link included in your email, specify linkTag .
	//
	// This member is required.
	DimensionValueSource DimensionValueSource
	// contains filtered or unexported fields
}

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

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

type ConfigurationSet 

type ConfigurationSet struct {

	// The name of the configuration set. The name must meet the following
	// requirements:
	//
	//   - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes
	//   (-).
	//
	//   - Contain 64 characters or fewer.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The name of the configuration set.

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Setsin the Amazon SES Developer Guide.

type ConfigurationSetAlreadyExistsException 

type ConfigurationSetAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Indicates that the configuration set could not be created because of a naming conflict.

func (*ConfigurationSetAlreadyExistsException) Error 

func (e *ConfigurationSetAlreadyExistsException) Error() string

func (*ConfigurationSetAlreadyExistsException) ErrorCode 

func (e *ConfigurationSetAlreadyExistsException) ErrorCode() string

func (*ConfigurationSetAlreadyExistsException) ErrorFault 

func (e *ConfigurationSetAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ConfigurationSetAlreadyExistsException) ErrorMessage 

func (e *ConfigurationSetAlreadyExistsException) ErrorMessage() string

type ConfigurationSetAttribute 

type ConfigurationSetAttribute string
const (
	ConfigurationSetAttributeEventDestinations ConfigurationSetAttribute = "eventDestinations"
	ConfigurationSetAttributeTrackingOptions   ConfigurationSetAttribute = "trackingOptions"
	ConfigurationSetAttributeDeliveryOptions   ConfigurationSetAttribute = "deliveryOptions"
	ConfigurationSetAttributeReputationOptions ConfigurationSetAttribute = "reputationOptions"
)

Enum values for ConfigurationSetAttribute

func (ConfigurationSetAttribute) Values added in v0.29.0 

func (ConfigurationSetAttribute) Values() []ConfigurationSetAttribute

Values returns all known values for ConfigurationSetAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfigurationSetDoesNotExistException 

type ConfigurationSetDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Indicates that the configuration set does not exist.

func (*ConfigurationSetDoesNotExistException) Error 

func (e *ConfigurationSetDoesNotExistException) Error() string

func (*ConfigurationSetDoesNotExistException) ErrorCode 

func (e *ConfigurationSetDoesNotExistException) ErrorCode() string

func (*ConfigurationSetDoesNotExistException) ErrorFault 

func (e *ConfigurationSetDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*ConfigurationSetDoesNotExistException) ErrorMessage 

func (e *ConfigurationSetDoesNotExistException) ErrorMessage() string

type ConfigurationSetSendingPausedException 

type ConfigurationSetSendingPausedException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

func (*ConfigurationSetSendingPausedException) Error 

func (e *ConfigurationSetSendingPausedException) Error() string

func (*ConfigurationSetSendingPausedException) ErrorCode 

func (e *ConfigurationSetSendingPausedException) ErrorCode() string

func (*ConfigurationSetSendingPausedException) ErrorFault 

func (e *ConfigurationSetSendingPausedException) ErrorFault() smithy.ErrorFault

func (*ConfigurationSetSendingPausedException) ErrorMessage 

func (e *ConfigurationSetSendingPausedException) ErrorMessage() string

type ConnectAction added in v1.29.0 

type ConnectAction struct {

	//  The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple
	// Email Service while starting email contacts to the Amazon Connect instance. This
	// role should have permission to invoke connect:StartEmailContact for the given
	// Amazon Connect instance.
	//
	// This member is required.
	IAMRoleARN *string

	// The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES
	// integrates with for starting email contacts.
	//
	// For more information about Amazon Connect instances, see the [Amazon Connect Administrator Guide]
	//
	// [Amazon Connect Administrator Guide]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html
	//
	// This member is required.
	InstanceARN *string
	// contains filtered or unexported fields
}

When included in a receipt rule, this action parses the received message and starts an email contact in Amazon Connect on your behalf.

When you receive emails, the maximum email size (including headers) is 40 MB. Additionally, emails may only have up to 10 attachments. Emails larger than 40 MB or with more than 10 attachments will be bounced.

We recommend that you configure this action via Amazon Connect.

type Content 

type Content struct {

	// The textual data of the content.
	//
	// This member is required.
	Data *string

	// The character set of the content.
	Charset *string
	// contains filtered or unexported fields
}

Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

type CustomMailFromStatus 

type CustomMailFromStatus string
const (
	CustomMailFromStatusPending          CustomMailFromStatus = "Pending"
	CustomMailFromStatusSuccess          CustomMailFromStatus = "Success"
	CustomMailFromStatusFailed           CustomMailFromStatus = "Failed"
	CustomMailFromStatusTemporaryFailure CustomMailFromStatus = "TemporaryFailure"
)

Enum values for CustomMailFromStatus

func (CustomMailFromStatus) Values added in v0.29.0 

func (CustomMailFromStatus) Values() []CustomMailFromStatus

Values returns all known values for CustomMailFromStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomVerificationEmailInvalidContentException 

type CustomVerificationEmailInvalidContentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that custom verification email template provided content is invalid.

func (*CustomVerificationEmailInvalidContentException) Error 

func (e *CustomVerificationEmailInvalidContentException) Error() string

func (*CustomVerificationEmailInvalidContentException) ErrorCode 

func (e *CustomVerificationEmailInvalidContentException) ErrorCode() string

func (*CustomVerificationEmailInvalidContentException) ErrorFault 

func (e *CustomVerificationEmailInvalidContentException) ErrorFault() smithy.ErrorFault

func (*CustomVerificationEmailInvalidContentException) ErrorMessage 

func (e *CustomVerificationEmailInvalidContentException) ErrorMessage() string

type CustomVerificationEmailTemplate 

type CustomVerificationEmailTemplate struct {

	// The URL that the recipient of the verification email is sent to if his or her
	// address is not successfully verified.
	FailureRedirectionURL *string

	// The email address that the custom verification email is sent from.
	FromEmailAddress *string

	// The URL that the recipient of the verification email is sent to if his or her
	// address is successfully verified.
	SuccessRedirectionURL *string

	// The name of the custom verification email template.
	TemplateName *string

	// The subject line of the custom verification email.
	TemplateSubject *string
	// contains filtered or unexported fields
}

Contains information about a custom verification email template.

type CustomVerificationEmailTemplateAlreadyExistsException 

type CustomVerificationEmailTemplateAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	CustomVerificationEmailTemplateName *string
	// contains filtered or unexported fields
}

Indicates that a custom verification email template with the name you specified already exists.

func (*CustomVerificationEmailTemplateAlreadyExistsException) Error 

func (e *CustomVerificationEmailTemplateAlreadyExistsException) Error() string

func (*CustomVerificationEmailTemplateAlreadyExistsException) ErrorCode 

func (e *CustomVerificationEmailTemplateAlreadyExistsException) ErrorCode() string

func (*CustomVerificationEmailTemplateAlreadyExistsException) ErrorFault 

func (e *CustomVerificationEmailTemplateAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*CustomVerificationEmailTemplateAlreadyExistsException) ErrorMessage 

func (e *CustomVerificationEmailTemplateAlreadyExistsException) ErrorMessage() string

type CustomVerificationEmailTemplateDoesNotExistException 

type CustomVerificationEmailTemplateDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	CustomVerificationEmailTemplateName *string
	// contains filtered or unexported fields
}

Indicates that a custom verification email template with the name you specified does not exist.

func (*CustomVerificationEmailTemplateDoesNotExistException) Error 

func (e *CustomVerificationEmailTemplateDoesNotExistException) Error() string

func (*CustomVerificationEmailTemplateDoesNotExistException) ErrorCode 

func (e *CustomVerificationEmailTemplateDoesNotExistException) ErrorCode() string

func (*CustomVerificationEmailTemplateDoesNotExistException) ErrorFault 

func (e *CustomVerificationEmailTemplateDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*CustomVerificationEmailTemplateDoesNotExistException) ErrorMessage 

func (e *CustomVerificationEmailTemplateDoesNotExistException) ErrorMessage() string

type DeliveryOptions 

type DeliveryOptions struct {

	// Specifies whether messages that use the configuration set are required to use
	// Transport Layer Security (TLS). If the value is Require , messages are only
	// delivered if a TLS connection can be established. If the value is Optional ,
	// messages can be delivered in plain text if a TLS connection can't be
	// established.
	TlsPolicy TlsPolicy
	// contains filtered or unexported fields
}

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

type Destination 

type Destination struct {

	// The recipients to place on the BCC: line of the message.
	BccAddresses []string

	// The recipients to place on the CC: line of the message.
	CcAddresses []string

	// The recipients to place on the To: line of the message.
	ToAddresses []string
	// contains filtered or unexported fields
}

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

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

type DimensionValueSource 

type DimensionValueSource string
const (
	DimensionValueSourceMessageTag  DimensionValueSource = "messageTag"
	DimensionValueSourceEmailHeader DimensionValueSource = "emailHeader"
	DimensionValueSourceLinkTag     DimensionValueSource = "linkTag"
)

Enum values for DimensionValueSource

func (DimensionValueSource) Values added in v0.29.0 

func (DimensionValueSource) Values() []DimensionValueSource

Values returns all known values for DimensionValueSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DsnAction 

type DsnAction string
const (
	DsnActionFailed    DsnAction = "failed"
	DsnActionDelayed   DsnAction = "delayed"
	DsnActionDelivered DsnAction = "delivered"
	DsnActionRelayed   DsnAction = "relayed"
	DsnActionExpanded  DsnAction = "expanded"
)

Enum values for DsnAction

func (DsnAction) Values added in v0.29.0 

func (DsnAction) Values() []DsnAction

Values returns all known values for DsnAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EventDestination 

type EventDestination struct {

	// The type of email sending events to publish to the event destination.
	//
	//   - send - The call was successful and Amazon SES is attempting to deliver the
	//   email.
	//
	//   - reject - Amazon SES determined that the email contained a virus and rejected
	//   it.
	//
	//   - bounce - The recipient's mail server permanently rejected the email. This
	//   corresponds to a hard bounce.
	//
	//   - complaint - The recipient marked the email as spam.
	//
	//   - delivery - Amazon SES successfully delivered the email to the recipient's
	//   mail server.
	//
	//   - open - The recipient received the email and opened it in their email client.
	//
	//   - click - The recipient clicked one or more links in the email.
	//
	//   - renderingFailure - Amazon SES did not send the email because of a template
	//   rendering issue.
	//
	// This member is required.
	MatchingEventTypes []EventType

	// The name of the event destination. The name must meet the following
	// requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
	//   dashes (-).
	//
	//   - Contain 64 characters or fewer.
	//
	// This member is required.
	Name *string

	// An object that contains the names, default values, and sources of the
	// dimensions associated with an Amazon CloudWatch event destination.
	CloudWatchDestination *CloudWatchDestination

	// Sets whether Amazon SES publishes events to this destination when you send an
	// email with the associated configuration set. Set to true to enable publishing
	// to this destination; set to false to prevent publishing to this destination.
	// The default value is false .
	Enabled bool

	// An object that contains the delivery stream ARN and the IAM role ARN associated
	// with an Amazon Kinesis Firehose event destination.
	KinesisFirehoseDestination *KinesisFirehoseDestination

	// An object that contains the topic ARN associated with an Amazon Simple
	// Notification Service (Amazon SNS) event destination.
	SNSDestination *SNSDestination
	// contains filtered or unexported fields
}

Contains information about an event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.

type EventDestinationAlreadyExistsException 

type EventDestinationAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	EventDestinationName *string
	// contains filtered or unexported fields
}

Indicates that the event destination could not be created because of a naming conflict.

func (*EventDestinationAlreadyExistsException) Error 

func (e *EventDestinationAlreadyExistsException) Error() string

func (*EventDestinationAlreadyExistsException) ErrorCode 

func (e *EventDestinationAlreadyExistsException) ErrorCode() string

func (*EventDestinationAlreadyExistsException) ErrorFault 

func (e *EventDestinationAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*EventDestinationAlreadyExistsException) ErrorMessage 

func (e *EventDestinationAlreadyExistsException) ErrorMessage() string

type EventDestinationDoesNotExistException 

type EventDestinationDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	EventDestinationName *string
	// contains filtered or unexported fields
}

Indicates that the event destination does not exist.

func (*EventDestinationDoesNotExistException) Error 

func (e *EventDestinationDoesNotExistException) Error() string

func (*EventDestinationDoesNotExistException) ErrorCode 

func (e *EventDestinationDoesNotExistException) ErrorCode() string

func (*EventDestinationDoesNotExistException) ErrorFault 

func (e *EventDestinationDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*EventDestinationDoesNotExistException) ErrorMessage 

func (e *EventDestinationDoesNotExistException) ErrorMessage() string

type EventType 

type EventType string
const (
	EventTypeSend             EventType = "send"
	EventTypeReject           EventType = "reject"
	EventTypeBounce           EventType = "bounce"
	EventTypeComplaint        EventType = "complaint"
	EventTypeDelivery         EventType = "delivery"
	EventTypeOpen             EventType = "open"
	EventTypeClick            EventType = "click"
	EventTypeRenderingFailure EventType = "renderingFailure"
)

Enum values for EventType

func (EventType) Values added in v0.29.0 

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExtensionField 

type ExtensionField struct {

	// The name of the header to add. Must be between 1 and 50 characters, inclusive,
	// and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
	//
	// This member is required.
	Name *string

	// The value of the header to add. Must contain 2048 characters or fewer, and must
	// not contain newline characters ("\r" or "\n").
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

type FromEmailAddressNotVerifiedException 

type FromEmailAddressNotVerifiedException struct {
	Message *string

	ErrorCodeOverride *string

	FromEmailAddress *string
	// contains filtered or unexported fields
}

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

func (*FromEmailAddressNotVerifiedException) Error 

func (e *FromEmailAddressNotVerifiedException) Error() string

func (*FromEmailAddressNotVerifiedException) ErrorCode 

func (e *FromEmailAddressNotVerifiedException) ErrorCode() string

func (*FromEmailAddressNotVerifiedException) ErrorFault 

func (e *FromEmailAddressNotVerifiedException) ErrorFault() smithy.ErrorFault

func (*FromEmailAddressNotVerifiedException) ErrorMessage 

func (e *FromEmailAddressNotVerifiedException) ErrorMessage() string

type IdentityDkimAttributes 

type IdentityDkimAttributes struct {

	// Is true if DKIM signing is enabled for email sent from the identity. It's false
	// otherwise. The default value is true.
	//
	// This member is required.
	DkimEnabled bool

	// Describes whether Amazon SES has successfully verified the DKIM DNS records
	// (tokens) published in the domain name's DNS. (This only applies to domain
	// identities, not email address identities.)
	//
	// This member is required.
	DkimVerificationStatus VerificationStatus

	// A set of character strings that represent the domain's identity. Using these
	// tokens, you need to create DNS CNAME records that point to DKIM public keys that
	// are hosted by Amazon SES. Amazon Web Services eventually detects that you've
	// updated your DNS records. This detection process might take up to 72 hours.
	// After successful detection, Amazon SES is able to DKIM-sign email originating
	// from that domain. (This only applies to domain identities, not email address
	// identities.)
	//
	// For more information about creating DNS records using DKIM tokens, see the [Amazon SES Developer Guide].
	//
	// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
	DkimTokens []string
	// contains filtered or unexported fields
}

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

type IdentityMailFromDomainAttributes 

type IdentityMailFromDomainAttributes struct {

	// The action that Amazon SES takes if it cannot successfully read the required MX
	// record when you send an email. A value of UseDefaultValue indicates that if
	// Amazon SES cannot read the required MX record, it uses amazonses.com (or a
	// subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates
	// that if Amazon SES cannot read the required MX record, Amazon SES returns a
	// MailFromDomainNotVerified error and does not send the email.
	//
	// The custom MAIL FROM setup states that result in this behavior are Pending ,
	// Failed , and TemporaryFailure .
	//
	// This member is required.
	BehaviorOnMXFailure BehaviorOnMXFailure

	// The custom MAIL FROM domain that the identity is configured to use.
	//
	// This member is required.
	MailFromDomain *string

	// The state that indicates whether Amazon SES has successfully read the MX record
	// required for custom MAIL FROM domain setup. If the state is Success , Amazon SES
	// uses the specified custom MAIL FROM domain when the verified identity sends an
	// email. All other states indicate that Amazon SES takes the action described by
	// BehaviorOnMXFailure .
	//
	// This member is required.
	MailFromDomainStatus CustomMailFromStatus
	// contains filtered or unexported fields
}

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

type IdentityNotificationAttributes 

type IdentityNotificationAttributes struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
	// publishes bounce notifications.
	//
	// This member is required.
	BounceTopic *string

	// The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
	// publishes complaint notifications.
	//
	// This member is required.
	ComplaintTopic *string

	// The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
	// publishes delivery notifications.
	//
	// This member is required.
	DeliveryTopic *string

	// Describes whether Amazon SES forwards bounce and complaint notifications as
	// email. true indicates that Amazon SES forwards bounce and complaint
	// notifications as email, while false indicates that bounce and complaint
	// notifications are published only to the specified bounce and complaint Amazon
	// SNS topics.
	//
	// This member is required.
	ForwardingEnabled bool

	// Describes whether Amazon SES includes the original email headers in Amazon SNS
	// notifications of type Bounce . A value of true specifies that Amazon SES
	// includes headers in bounce notifications, and a value of false specifies that
	// Amazon SES does not include headers in bounce notifications.
	HeadersInBounceNotificationsEnabled bool

	// Describes whether Amazon SES includes the original email headers in Amazon SNS
	// notifications of type Complaint . A value of true specifies that Amazon SES
	// includes headers in complaint notifications, and a value of false specifies
	// that Amazon SES does not include headers in complaint notifications.
	HeadersInComplaintNotificationsEnabled bool

	// Describes whether Amazon SES includes the original email headers in Amazon SNS
	// notifications of type Delivery . A value of true specifies that Amazon SES
	// includes headers in delivery notifications, and a value of false specifies that
	// Amazon SES does not include headers in delivery notifications.
	HeadersInDeliveryNotificationsEnabled bool
	// contains filtered or unexported fields
}

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.

type IdentityType 

type IdentityType string
const (
	IdentityTypeEmailAddress IdentityType = "EmailAddress"
	IdentityTypeDomain       IdentityType = "Domain"
)

Enum values for IdentityType

func (IdentityType) Values added in v0.29.0 

func (IdentityType) Values() []IdentityType

Values returns all known values for IdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IdentityVerificationAttributes 

type IdentityVerificationAttributes struct {

	// The verification status of the identity: "Pending", "Success", "Failed", or
	// "TemporaryFailure".
	//
	// This member is required.
	VerificationStatus VerificationStatus

	// The verification token for a domain identity. Null for email address identities.
	VerificationToken *string
	// contains filtered or unexported fields
}

Represents the verification attributes of a single identity.

type InvalidCloudWatchDestinationException 

type InvalidCloudWatchDestinationException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	EventDestinationName *string
	// contains filtered or unexported fields
}

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

func (*InvalidCloudWatchDestinationException) Error 

func (e *InvalidCloudWatchDestinationException) Error() string

func (*InvalidCloudWatchDestinationException) ErrorCode 

func (e *InvalidCloudWatchDestinationException) ErrorCode() string

func (*InvalidCloudWatchDestinationException) ErrorFault 

func (e *InvalidCloudWatchDestinationException) ErrorFault() smithy.ErrorFault

func (*InvalidCloudWatchDestinationException) ErrorMessage 

func (e *InvalidCloudWatchDestinationException) ErrorMessage() string

type InvalidConfigurationSetException 

type InvalidConfigurationSetException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the configuration set is invalid. See the error message for details.

func (*InvalidConfigurationSetException) Error 

func (e *InvalidConfigurationSetException) Error() string

func (*InvalidConfigurationSetException) ErrorCode 

func (e *InvalidConfigurationSetException) ErrorCode() string

func (*InvalidConfigurationSetException) ErrorFault 

func (e *InvalidConfigurationSetException) ErrorFault() smithy.ErrorFault

func (*InvalidConfigurationSetException) ErrorMessage 

func (e *InvalidConfigurationSetException) ErrorMessage() string

type InvalidDeliveryOptionsException 

type InvalidDeliveryOptionsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that provided delivery option is invalid.

func (*InvalidDeliveryOptionsException) Error 

func (e *InvalidDeliveryOptionsException) Error() string

func (*InvalidDeliveryOptionsException) ErrorCode 

func (e *InvalidDeliveryOptionsException) ErrorCode() string

func (*InvalidDeliveryOptionsException) ErrorFault 

func (e *InvalidDeliveryOptionsException) ErrorFault() smithy.ErrorFault

func (*InvalidDeliveryOptionsException) ErrorMessage 

func (e *InvalidDeliveryOptionsException) ErrorMessage() string

type InvalidFirehoseDestinationException 

type InvalidFirehoseDestinationException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	EventDestinationName *string
	// contains filtered or unexported fields
}

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

func (*InvalidFirehoseDestinationException) Error 

func (e *InvalidFirehoseDestinationException) Error() string

func (*InvalidFirehoseDestinationException) ErrorCode 

func (e *InvalidFirehoseDestinationException) ErrorCode() string

func (*InvalidFirehoseDestinationException) ErrorFault 

func (e *InvalidFirehoseDestinationException) ErrorFault() smithy.ErrorFault

func (*InvalidFirehoseDestinationException) ErrorMessage 

func (e *InvalidFirehoseDestinationException) ErrorMessage() string

type InvalidLambdaFunctionException 

type InvalidLambdaFunctionException struct {
	Message *string

	ErrorCodeOverride *string

	FunctionArn *string
	// contains filtered or unexported fields
}

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

func (*InvalidLambdaFunctionException) Error 

func (e *InvalidLambdaFunctionException) Error() string

func (*InvalidLambdaFunctionException) ErrorCode 

func (e *InvalidLambdaFunctionException) ErrorCode() string

func (*InvalidLambdaFunctionException) ErrorFault 

func (e *InvalidLambdaFunctionException) ErrorFault() smithy.ErrorFault

func (*InvalidLambdaFunctionException) ErrorMessage 

func (e *InvalidLambdaFunctionException) ErrorMessage() string

type InvalidPolicyException 

type InvalidPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

func (*InvalidPolicyException) Error 

func (e *InvalidPolicyException) Error() string

func (*InvalidPolicyException) ErrorCode 

func (e *InvalidPolicyException) ErrorCode() string

func (*InvalidPolicyException) ErrorFault 

func (e *InvalidPolicyException) ErrorFault() smithy.ErrorFault

func (*InvalidPolicyException) ErrorMessage 

func (e *InvalidPolicyException) ErrorMessage() string

type InvalidRenderingParameterException 

type InvalidRenderingParameterException struct {
	Message *string

	ErrorCodeOverride *string

	TemplateName *string
	// contains filtered or unexported fields
}

Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

func (*InvalidRenderingParameterException) Error 

func (e *InvalidRenderingParameterException) Error() string

func (*InvalidRenderingParameterException) ErrorCode 

func (e *InvalidRenderingParameterException) ErrorCode() string

func (*InvalidRenderingParameterException) ErrorFault 

func (e *InvalidRenderingParameterException) ErrorFault() smithy.ErrorFault

func (*InvalidRenderingParameterException) ErrorMessage 

func (e *InvalidRenderingParameterException) ErrorMessage() string

type InvalidS3ConfigurationException 

type InvalidS3ConfigurationException struct {
	Message *string

	ErrorCodeOverride *string

	Bucket *string
	// contains filtered or unexported fields
}

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

func (*InvalidS3ConfigurationException) Error 

func (e *InvalidS3ConfigurationException) Error() string

func (*InvalidS3ConfigurationException) ErrorCode 

func (e *InvalidS3ConfigurationException) ErrorCode() string

func (*InvalidS3ConfigurationException) ErrorFault 

func (e *InvalidS3ConfigurationException) ErrorFault() smithy.ErrorFault

func (*InvalidS3ConfigurationException) ErrorMessage 

func (e *InvalidS3ConfigurationException) ErrorMessage() string

type InvalidSNSDestinationException 

type InvalidSNSDestinationException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	EventDestinationName *string
	// contains filtered or unexported fields
}

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

func (*InvalidSNSDestinationException) Error 

func (e *InvalidSNSDestinationException) Error() string

func (*InvalidSNSDestinationException) ErrorCode 

func (e *InvalidSNSDestinationException) ErrorCode() string

func (*InvalidSNSDestinationException) ErrorFault 

func (e *InvalidSNSDestinationException) ErrorFault() smithy.ErrorFault

func (*InvalidSNSDestinationException) ErrorMessage 

func (e *InvalidSNSDestinationException) ErrorMessage() string

type InvalidSnsTopicException 

type InvalidSnsTopicException struct {
	Message *string

	ErrorCodeOverride *string

	Topic *string
	// contains filtered or unexported fields
}

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

func (*InvalidSnsTopicException) Error 

func (e *InvalidSnsTopicException) Error() string

func (*InvalidSnsTopicException) ErrorCode 

func (e *InvalidSnsTopicException) ErrorCode() string

func (*InvalidSnsTopicException) ErrorFault 

func (e *InvalidSnsTopicException) ErrorFault() smithy.ErrorFault

func (*InvalidSnsTopicException) ErrorMessage 

func (e *InvalidSnsTopicException) ErrorMessage() string

type InvalidTemplateException 

type InvalidTemplateException struct {
	Message *string

	ErrorCodeOverride *string

	TemplateName *string
	// contains filtered or unexported fields
}

Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

func (*InvalidTemplateException) Error 

func (e *InvalidTemplateException) Error() string

func (*InvalidTemplateException) ErrorCode 

func (e *InvalidTemplateException) ErrorCode() string

func (*InvalidTemplateException) ErrorFault 

func (e *InvalidTemplateException) ErrorFault() smithy.ErrorFault

func (*InvalidTemplateException) ErrorMessage 

func (e *InvalidTemplateException) ErrorMessage() string

type InvalidTrackingOptionsException 

type InvalidTrackingOptionsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

  • When the tracking domain you specified is not verified in Amazon SES.

  • When the tracking domain you specified is not a valid domain or subdomain.

func (*InvalidTrackingOptionsException) Error 

func (e *InvalidTrackingOptionsException) Error() string

func (*InvalidTrackingOptionsException) ErrorCode 

func (e *InvalidTrackingOptionsException) ErrorCode() string

func (*InvalidTrackingOptionsException) ErrorFault 

func (e *InvalidTrackingOptionsException) ErrorFault() smithy.ErrorFault

func (*InvalidTrackingOptionsException) ErrorMessage 

func (e *InvalidTrackingOptionsException) ErrorMessage() string

type InvocationType 

type InvocationType string
const (
	InvocationTypeEvent           InvocationType = "Event"
	InvocationTypeRequestResponse InvocationType = "RequestResponse"
)

Enum values for InvocationType

func (InvocationType) Values added in v0.29.0 

func (InvocationType) Values() []InvocationType

Values returns all known values for InvocationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KinesisFirehoseDestination 

type KinesisFirehoseDestination struct {

	// The ARN of the Amazon Kinesis Firehose stream that email sending events should
	// be published to.
	//
	// This member is required.
	DeliveryStreamARN *string

	// The ARN of the IAM role under which Amazon SES publishes email sending events
	// to the Amazon Kinesis Firehose stream.
	//
	// This member is required.
	IAMRoleARN *string
	// contains filtered or unexported fields
}

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

Event destinations, such as Amazon Kinesis Firehose, 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.

type LambdaAction 

type LambdaAction struct {

	// The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An
	// example of an Amazon Web Services Lambda function ARN is
	// arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information
	// about Amazon Web Services Lambda, see the [Amazon Web Services Lambda Developer Guide].
	//
	// [Amazon Web Services Lambda Developer Guide]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html
	//
	// This member is required.
	FunctionArn *string

	// The invocation type of the Amazon Web Services Lambda function. An invocation
	// type of RequestResponse means that the execution of the function immediately
	// results in a response, and a value of Event means that the function is invoked
	// asynchronously. The default value is Event . For information about Amazon Web
	// Services Lambda invocation types, see the [Amazon Web Services Lambda Developer Guide].
	//
	// There is a 30-second timeout on RequestResponse invocations. You should use
	// Event invocation in most cases. Use RequestResponse only to make a mail flow
	// decision, such as whether to stop the receipt rule or the receipt rule set.
	//
	// [Amazon Web Services Lambda Developer Guide]: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html
	InvocationType InvocationType

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
	// Lambda action is executed. You can find the ARN of a topic by using the [ListTopics]
	// operation in Amazon SNS.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	TopicArn *string
	// contains filtered or unexported fields
}

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

To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES Developer Guide.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type MailFromDomainNotVerifiedException 

type MailFromDomainNotVerifiedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
Indicates that the message could not be sent because Amazon SES could not read

the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

func (*MailFromDomainNotVerifiedException) Error 

func (e *MailFromDomainNotVerifiedException) Error() string

func (*MailFromDomainNotVerifiedException) ErrorCode 

func (e *MailFromDomainNotVerifiedException) ErrorCode() string

func (*MailFromDomainNotVerifiedException) ErrorFault 

func (e *MailFromDomainNotVerifiedException) ErrorFault() smithy.ErrorFault

func (*MailFromDomainNotVerifiedException) ErrorMessage 

func (e *MailFromDomainNotVerifiedException) ErrorMessage() string

type Message 

type Message struct {

	// The message body.
	//
	// This member is required.
	Body *Body

	// The subject of the message: A short summary of the content, which appears in
	// the recipient's inbox.
	//
	// This member is required.
	Subject *Content
	// contains filtered or unexported fields
}

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

type MessageDsn 

type MessageDsn struct {

	// The reporting MTA that attempted to deliver the message, formatted as specified
	// in [RFC 3464]( mta-name-type; mta-name ). The default value is dns;
	// inbound-smtp.[region].amazonaws.com .
	//
	// [RFC 3464]: https://tools.ietf.org/html/rfc3464
	//
	// This member is required.
	ReportingMta *string

	// When the message was received by the reporting mail transfer agent (MTA), in [RFC 822]
	// date-time format.
	//
	// [RFC 822]: https://www.ietf.org/rfc/rfc0822.txt
	ArrivalDate *time.Time

	// Additional X-headers to include in the DSN.
	ExtensionFields []ExtensionField
	// contains filtered or unexported fields
}

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

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

type MessageRejected 

type MessageRejected struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

func (*MessageRejected) Error 

func (e *MessageRejected) Error() string

func (*MessageRejected) ErrorCode 

func (e *MessageRejected) ErrorCode() string

func (*MessageRejected) ErrorFault 

func (e *MessageRejected) ErrorFault() smithy.ErrorFault

func (*MessageRejected) ErrorMessage 

func (e *MessageRejected) ErrorMessage() string

type MessageTag 

type MessageTag struct {

	// The name of the tag. The name must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
	//   dashes (-).
	//
	//   - Contain 256 characters or fewer.
	//
	// This member is required.
	Name *string

	// The value of the tag. The value must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
	//   dashes (-).
	//
	//   - Contain 256 characters or fewer.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

type MissingRenderingAttributeException 

type MissingRenderingAttributeException struct {
	Message *string

	ErrorCodeOverride *string

	TemplateName *string
	// contains filtered or unexported fields
}

Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

func (*MissingRenderingAttributeException) Error 

func (e *MissingRenderingAttributeException) Error() string

func (*MissingRenderingAttributeException) ErrorCode 

func (e *MissingRenderingAttributeException) ErrorCode() string

func (*MissingRenderingAttributeException) ErrorFault 

func (e *MissingRenderingAttributeException) ErrorFault() smithy.ErrorFault

func (*MissingRenderingAttributeException) ErrorMessage 

func (e *MissingRenderingAttributeException) ErrorMessage() string

type NotificationType 

type NotificationType string
const (
	NotificationTypeBounce    NotificationType = "Bounce"
	NotificationTypeComplaint NotificationType = "Complaint"
	NotificationTypeDelivery  NotificationType = "Delivery"
)

Enum values for NotificationType

func (NotificationType) Values added in v0.29.0 

func (NotificationType) Values() []NotificationType

Values returns all known values for NotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProductionAccessNotGrantedException 

type ProductionAccessNotGrantedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the account has not been granted production access.

func (*ProductionAccessNotGrantedException) Error 

func (e *ProductionAccessNotGrantedException) Error() string

func (*ProductionAccessNotGrantedException) ErrorCode 

func (e *ProductionAccessNotGrantedException) ErrorCode() string

func (*ProductionAccessNotGrantedException) ErrorFault 

func (e *ProductionAccessNotGrantedException) ErrorFault() smithy.ErrorFault

func (*ProductionAccessNotGrantedException) ErrorMessage 

func (e *ProductionAccessNotGrantedException) ErrorMessage() string

type RawMessage 

type RawMessage struct {

	// The raw data of the message. This data needs to base64-encoded if you are
	// accessing Amazon SES directly through the HTTPS interface. If you are accessing
	// Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base
	// 64-encoding for you. In all cases, the client must ensure that the message
	// format complies with Internet email standards regarding email header fields,
	// MIME types, and MIME encoding.
	//
	// The To:, CC:, and BCC: headers in the raw message can contain a group list.
	//
	// If you are using SendRawEmail with sending authorization, you can include
	// X-headers in the raw message to specify the "Source," "From," and "Return-Path"
	// addresses. For more information, see the documentation for SendRawEmail .
	//
	// Do not include these X-headers in the DKIM signature, because they are removed
	// by Amazon SES before sending the email.
	//
	// For more information, go to the [Amazon SES Developer Guide].
	//
	// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
	//
	// This member is required.
	Data []byte
	// contains filtered or unexported fields
}

Represents the raw data of the message.

type ReceiptAction 

type ReceiptAction struct {

	// Adds a header to the received email.
	AddHeaderAction *AddHeaderAction

	// Rejects the received email by returning a bounce response to the sender and,
	// optionally, publishes a notification to Amazon Simple Notification Service
	// (Amazon SNS).
	BounceAction *BounceAction

	// Parses the received message and starts an email contact in Amazon Connect on
	// your behalf.
	ConnectAction *ConnectAction

	// Calls an Amazon Web Services Lambda function, and optionally, publishes a
	// notification to Amazon SNS.
	LambdaAction *LambdaAction

	// Saves the received message to an Amazon Simple Storage Service (Amazon S3)
	// bucket and, optionally, publishes a notification to Amazon SNS.
	S3Action *S3Action

	// Publishes the email content within a notification to Amazon SNS.
	SNSAction *SNSAction

	// Terminates the evaluation of the receipt rule set and optionally publishes a
	// notification to Amazon SNS.
	StopAction *StopAction

	// Calls Amazon WorkMail and, optionally, publishes a notification to Amazon
	// Amazon SNS.
	WorkmailAction *WorkmailAction
	// contains filtered or unexported fields
}

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.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

type ReceiptFilter 

type ReceiptFilter struct {

	// A structure that provides the IP addresses to block or allow, and whether to
	// block or allow incoming mail from them.
	//
	// This member is required.
	IpFilter *ReceiptIpFilter

	// The name of the IP address filter. The name must meet the following
	// requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
	//   dashes (-).
	//
	//   - Start and end with a letter or number.
	//
	//   - Contain 64 characters or fewer.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

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.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

type ReceiptFilterPolicy 

type ReceiptFilterPolicy string
const (
	ReceiptFilterPolicyBlock ReceiptFilterPolicy = "Block"
	ReceiptFilterPolicyAllow ReceiptFilterPolicy = "Allow"
)

Enum values for ReceiptFilterPolicy

func (ReceiptFilterPolicy) Values added in v0.29.0 

func (ReceiptFilterPolicy) Values() []ReceiptFilterPolicy

Values returns all known values for ReceiptFilterPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReceiptIpFilter 

type ReceiptIpFilter struct {

	// A single IP address or a range of IP addresses to block or allow, specified in
	// Classless Inter-Domain Routing (CIDR) notation. An example of a single email
	// address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For
	// more information about CIDR notation, see [RFC 2317].
	//
	// [RFC 2317]: https://tools.ietf.org/html/rfc2317
	//
	// This member is required.
	Cidr *string

	// Indicates whether to block or allow incoming mail from the specified IP
	// addresses.
	//
	// This member is required.
	Policy ReceiptFilterPolicy
	// contains filtered or unexported fields
}

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.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

type ReceiptRule 

type ReceiptRule struct {

	// The name of the receipt rule. The name must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
	//   dashes (-), or periods (.).
	//
	//   - Start and end with a letter or number.
	//
	//   - Contain 64 characters or fewer.
	//
	// This member is required.
	Name *string

	// An ordered list of actions to perform on messages that match at least one of
	// the recipient email addresses or domains specified in the receipt rule.
	Actions []ReceiptAction

	// If true , the receipt rule is active. The default value is false .
	Enabled bool

	// The recipient domains and email addresses that the receipt rule applies to. If
	// this field is not specified, this rule matches all recipients on all verified
	// domains.
	Recipients []string

	// If true , then messages that this receipt rule applies to are scanned for spam
	// and viruses. The default value is false .
	ScanEnabled bool

	// Specifies whether Amazon SES should require that incoming email is delivered
	// over a connection encrypted with Transport Layer Security (TLS). If this
	// parameter is set to Require , Amazon SES bounces emails that are not received
	// over TLS. The default is Optional .
	TlsPolicy TlsPolicy
	// contains filtered or unexported fields
}

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.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

type ReceiptRuleSetMetadata 

type ReceiptRuleSetMetadata struct {

	// The date and time the receipt rule set was created.
	CreatedTimestamp *time.Time

	// The name of the receipt rule set. The name must meet the following requirements:
	//
	//   - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
	//   dashes (-).
	//
	//   - Start and end with a letter or number.
	//
	//   - Contain 64 characters or fewer.
	Name *string
	// contains filtered or unexported fields
}

Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

type RecipientDsnFields 

type RecipientDsnFields struct {

	// The action performed by the reporting mail transfer agent (MTA) as a result of
	// its attempt to deliver the message to the recipient address. This is required by
	// [RFC 3464].
	//
	// [RFC 3464]: https://tools.ietf.org/html/rfc3464
	//
	// This member is required.
	Action DsnAction

	// The status code that indicates what went wrong. This is required by [RFC 3464].
	//
	// [RFC 3464]: https://tools.ietf.org/html/rfc3464
	//
	// This member is required.
	Status *string

	// An extended explanation of what went wrong; this is usually an SMTP response.
	// See [RFC 3463]for the correct formatting of this parameter.
	//
	// [RFC 3463]: https://tools.ietf.org/html/rfc3463
	DiagnosticCode *string

	// Additional X-headers to include in the DSN.
	ExtensionFields []ExtensionField

	// The email address that the message was ultimately delivered to. This
	// corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient
	// is set to the Recipient specified in the BouncedRecipientInfo structure. Either
	// FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of
	// the original bounced message.
	//
	// Do not prepend the FinalRecipient email address with rfc 822; , as described in [RFC 3798]
	// .
	//
	// [RFC 3798]: https://tools.ietf.org/html/rfc3798
	FinalRecipient *string

	// The time the final delivery attempt was made, in [RFC 822] date-time format.
	//
	// [RFC 822]: https://www.ietf.org/rfc/rfc0822.txt
	LastAttemptDate *time.Time

	// The MTA to which the remote MTA attempted to deliver the message, formatted as
	// specified in [RFC 3464]( mta-name-type; mta-name ). This parameter typically applies only
	// to propagating synchronous bounces.
	//
	// [RFC 3464]: https://tools.ietf.org/html/rfc3464
	RemoteMta *string
	// contains filtered or unexported fields
}

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

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

type ReputationOptions 

type ReputationOptions struct {

	// The date and time at which the reputation metrics for the configuration set
	// were last reset. Resetting these metrics is known as a fresh start.
	//
	// When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later
	// re-enable it, the reputation metrics for the configuration set (but not for the
	// entire Amazon SES account) are reset.
	//
	// If email sending for the configuration set has never been disabled and later
	// re-enabled, the value of this attribute is null .
	LastFreshStart *time.Time

	// Describes whether or not Amazon SES publishes reputation metrics for the
	// configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
	//
	// If the value is true , reputation metrics are published. If the value is false ,
	// reputation metrics are not published. The default value is false .
	ReputationMetricsEnabled bool

	// Describes whether email sending is enabled or disabled for the configuration
	// set. If the value is true , then Amazon SES sends emails that use the
	// configuration set. If the value is false , Amazon SES does not send emails that
	// use the configuration set. The default value is true . You can change this
	// setting using UpdateConfigurationSetSendingEnabled.
	SendingEnabled bool
	// contains filtered or unexported fields
}

Contains information about the reputation settings for a configuration set.

type RuleDoesNotExistException 

type RuleDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	Name *string
	// contains filtered or unexported fields
}

Indicates that the provided receipt rule does not exist.

func (*RuleDoesNotExistException) Error 

func (e *RuleDoesNotExistException) Error() string

func (*RuleDoesNotExistException) ErrorCode 

func (e *RuleDoesNotExistException) ErrorCode() string

func (*RuleDoesNotExistException) ErrorFault 

func (e *RuleDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*RuleDoesNotExistException) ErrorMessage 

func (e *RuleDoesNotExistException) ErrorMessage() string

type RuleSetDoesNotExistException 

type RuleSetDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	Name *string
	// contains filtered or unexported fields
}

Indicates that the provided receipt rule set does not exist.

func (*RuleSetDoesNotExistException) Error 

func (e *RuleSetDoesNotExistException) Error() string

func (*RuleSetDoesNotExistException) ErrorCode 

func (e *RuleSetDoesNotExistException) ErrorCode() string

func (*RuleSetDoesNotExistException) ErrorFault 

func (e *RuleSetDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*RuleSetDoesNotExistException) ErrorMessage 

func (e *RuleSetDoesNotExistException) ErrorMessage() string

type S3Action 

type S3Action struct {

	// The name of the Amazon S3 bucket for incoming email.
	//
	// This member is required.
	BucketName *string

	//  The ARN of the IAM role to be used by Amazon Simple Email Service while
	// writing to the Amazon S3 bucket, optionally encrypting your mail via the
	// provided customer managed key, and publishing to the Amazon SNS topic. This role
	// should have access to the following APIs:
	//
	//   - s3:PutObject , kms:Encrypt and kms:GenerateDataKey for the given Amazon S3
	//   bucket.
	//
	//   - kms:GenerateDataKey for the given Amazon Web Services KMS customer managed
	//   key.
	//
	//   - sns:Publish for the given Amazon SNS topic.
	//
	// If an IAM role ARN is provided, the role (and only the role) is used to access
	// all the given resources (Amazon S3 bucket, Amazon Web Services KMS customer
	// managed key and Amazon SNS topic). Therefore, setting up individual resource
	// access permissions is not required.
	IamRoleArn *string

	// The customer managed key that Amazon SES should use to encrypt your emails
	// before saving them to the Amazon S3 bucket. You can use the Amazon Web Services
	// managed key or a customer managed key that you created in Amazon Web Services
	// KMS as follows:
	//
	//   - To use the Amazon Web Services managed key, provide an ARN in the form of
	//   arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses . For example, if
	//   your Amazon Web Services account ID is 123456789012 and you want to use the
	//   Amazon Web Services managed key in the US West (Oregon) Region, the ARN of the
	//   Amazon Web Services managed key would be
	//   arn:aws:kms:us-west-2:123456789012:alias/aws/ses . If you use the Amazon Web
	//   Services managed key, you don't need to perform any extra steps to give Amazon
	//   SES permission to use the key.
	//
	//   - To use a customer managed key that you created in Amazon Web Services KMS,
	//   provide the ARN of the customer managed key and ensure that you add a statement
	//   to your key's policy to give Amazon SES permission to use it. For more
	//   information about giving permissions, see the [Amazon SES Developer Guide].
	//
	// For more information about key policies, see the [Amazon Web Services KMS Developer Guide]. If you do not specify an
	// Amazon Web Services KMS key, Amazon SES does not encrypt your emails.
	//
	// Your mail is encrypted by Amazon SES using the Amazon S3 encryption client
	// before the mail is submitted to Amazon S3 for storage. It is not encrypted using
	// Amazon S3 server-side encryption. This means that you must use the Amazon S3
	// encryption client to decrypt the email after retrieving it from Amazon S3, as
	// the service has no access to use your Amazon Web Services KMS keys for
	// decryption. This encryption client is currently available with the [Amazon Web Services SDK for Java]and [Amazon Web Services SDK for Ruby] only.
	// For more information about client-side encryption using Amazon Web Services KMS
	// managed keys, see the [Amazon S3 Developer Guide].
	//
	// [Amazon Web Services KMS Developer Guide]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
	// [Amazon Web Services SDK for Ruby]: http://aws.amazon.com/sdk-for-ruby/
	// [Amazon S3 Developer Guide]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
	// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html
	// [Amazon Web Services SDK for Java]: http://aws.amazon.com/sdk-for-java/
	KmsKeyArn *string

	// The key prefix of the Amazon S3 bucket. The key prefix is similar to a
	// directory name that enables you to store similar data under the same directory
	// in a bucket.
	ObjectKeyPrefix *string

	// The ARN of the Amazon SNS topic to notify when the message is saved to the
	// Amazon S3 bucket. You can find the ARN of a topic by using the [ListTopics]operation in
	// Amazon SNS.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	TopicArn *string
	// contains filtered or unexported fields
}

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).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide.

When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

type SNSAction 

type SNSAction struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find
	// the ARN of a topic by using the [ListTopics]operation in Amazon SNS.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	//
	// This member is required.
	TopicArn *string

	// The encoding to use for the email within the Amazon SNS notification. UTF-8 is
	// easier to use, but may not preserve all special characters when a message was
	// encoded with a different encoding format. Base64 preserves all special
	// characters. The default value is UTF-8.
	Encoding SNSActionEncoding
	// contains filtered or unexported fields
}

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.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

type SNSActionEncoding 

type SNSActionEncoding string
const (
	SNSActionEncodingUtf8   SNSActionEncoding = "UTF-8"
	SNSActionEncodingBase64 SNSActionEncoding = "Base64"
)

Enum values for SNSActionEncoding

func (SNSActionEncoding) Values added in v0.29.0 

func (SNSActionEncoding) Values() []SNSActionEncoding

Values returns all known values for SNSActionEncoding. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SNSDestination 

type SNSDestination struct {

	// The ARN of the Amazon SNS topic for email sending events. You can find the ARN
	// of a topic by using the [ListTopics]Amazon SNS operation.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	//
	// This member is required.
	TopicARN *string
	// contains filtered or unexported fields
}

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

Event destinations, such as Amazon SNS, 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.

type SendDataPoint 

type SendDataPoint struct {

	// Number of emails that have bounced.
	Bounces int64

	// Number of unwanted emails that were rejected by recipients.
	Complaints int64

	// Number of emails that have been sent.
	DeliveryAttempts int64

	// Number of emails rejected by Amazon SES.
	Rejects int64

	// Time of the data point.
	Timestamp *time.Time
	// contains filtered or unexported fields
}

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

type StopAction 

type StopAction struct {

	// The scope of the StopAction. The only acceptable value is RuleSet .
	//
	// This member is required.
	Scope StopScope

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop
	// action is taken. You can find the ARN of a topic by using the [ListTopics]Amazon SNS
	// operation.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	TopicArn *string
	// contains filtered or unexported fields
}

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).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

type StopScope 

type StopScope string
const (
	StopScopeRuleSet StopScope = "RuleSet"
)

Enum values for StopScope

func (StopScope) Values added in v0.29.0 

func (StopScope) Values() []StopScope

Values returns all known values for StopScope. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Template 

type Template struct {

	// The name of the template. You use this name when you send email using the
	// SendTemplatedEmail or SendBulkTemplatedEmail operations.
	//
	// This member is required.
	TemplateName *string

	// The HTML body of the email.
	HtmlPart *string

	// The subject line of the email.
	SubjectPart *string

	// The email body that is visible to recipients whose email clients do not display
	// HTML content.
	TextPart *string
	// contains filtered or unexported fields
}

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

type TemplateDoesNotExistException 

type TemplateDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	TemplateName *string
	// contains filtered or unexported fields
}

Indicates that the Template object you specified does not exist in your Amazon SES account.

func (*TemplateDoesNotExistException) Error 

func (e *TemplateDoesNotExistException) Error() string

func (*TemplateDoesNotExistException) ErrorCode 

func (e *TemplateDoesNotExistException) ErrorCode() string

func (*TemplateDoesNotExistException) ErrorFault 

func (e *TemplateDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*TemplateDoesNotExistException) ErrorMessage 

func (e *TemplateDoesNotExistException) ErrorMessage() string

type TemplateMetadata 

type TemplateMetadata struct {

	// The time and date the template was created.
	CreatedTimestamp *time.Time

	// The name of the template.
	Name *string
	// contains filtered or unexported fields
}

Contains information about an email template.

type TlsPolicy 

type TlsPolicy string
const (
	TlsPolicyRequire  TlsPolicy = "Require"
	TlsPolicyOptional TlsPolicy = "Optional"
)

Enum values for TlsPolicy

func (TlsPolicy) Values added in v0.29.0 

func (TlsPolicy) Values() []TlsPolicy

Values returns all known values for TlsPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TrackingOptions 

type TrackingOptions struct {

	// The custom subdomain that is used to redirect email recipients to the Amazon
	// SES event tracking domain.
	CustomRedirectDomain *string
	// contains filtered or unexported fields
}

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.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

type TrackingOptionsAlreadyExistsException 

type TrackingOptionsAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Indicates that the configuration set you specified already contains a TrackingOptions object.

func (*TrackingOptionsAlreadyExistsException) Error 

func (e *TrackingOptionsAlreadyExistsException) Error() string

func (*TrackingOptionsAlreadyExistsException) ErrorCode 

func (e *TrackingOptionsAlreadyExistsException) ErrorCode() string

func (*TrackingOptionsAlreadyExistsException) ErrorFault 

func (e *TrackingOptionsAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*TrackingOptionsAlreadyExistsException) ErrorMessage 

func (e *TrackingOptionsAlreadyExistsException) ErrorMessage() string

type TrackingOptionsDoesNotExistException 

type TrackingOptionsDoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string

	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Indicates that the TrackingOptions object you specified does not exist.

func (*TrackingOptionsDoesNotExistException) Error 

func (e *TrackingOptionsDoesNotExistException) Error() string

func (*TrackingOptionsDoesNotExistException) ErrorCode 

func (e *TrackingOptionsDoesNotExistException) ErrorCode() string

func (*TrackingOptionsDoesNotExistException) ErrorFault 

func (e *TrackingOptionsDoesNotExistException) ErrorFault() smithy.ErrorFault

func (*TrackingOptionsDoesNotExistException) ErrorMessage 

func (e *TrackingOptionsDoesNotExistException) ErrorMessage() string

type VerificationStatus 

type VerificationStatus string
const (
	VerificationStatusPending          VerificationStatus = "Pending"
	VerificationStatusSuccess          VerificationStatus = "Success"
	VerificationStatusFailed           VerificationStatus = "Failed"
	VerificationStatusTemporaryFailure VerificationStatus = "TemporaryFailure"
	VerificationStatusNotStarted       VerificationStatus = "NotStarted"
)

Enum values for VerificationStatus

func (VerificationStatus) Values added in v0.29.0 

func (VerificationStatus) Values() []VerificationStatus

Values returns all known values for VerificationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkmailAction 

type WorkmailAction struct {

	// The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon
	// WorkMail ARNs use the following format:
	//
	//     arn:aws:workmail:::organization/
	//
	// You can find the ID of your organization by using the [ListOrganizations] operation in Amazon
	// WorkMail. Amazon WorkMail organization IDs begin with " m- ", followed by a
	// string of alphanumeric characters.
	//
	// For information about Amazon WorkMail organizations, see the [Amazon WorkMail Administrator Guide].
	//
	// [ListOrganizations]: https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html
	// [Amazon WorkMail Administrator Guide]: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html
	//
	// This member is required.
	OrganizationArn *string

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
	// WorkMail action is called. You can find the ARN of a topic by using the [ListTopics]
	// operation in Amazon SNS.
	//
	// For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].
	//
	// [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
	// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
	TopicArn *string
	// contains filtered or unexported fields
}

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.