Package-level declarations

Types

Link copied to clipboard
sealed class AcceptAction
Link copied to clipboard

Occurs when a user is denied access to a specific resource or action.

Link copied to clipboard
sealed class ActionFailurePolicy
Link copied to clipboard

The action to add a header to a message. When executed, this action will add the given header to the message.

Link copied to clipboard

An Add On instance represents a specific configuration of an Add On.

Link copied to clipboard

A subscription for an Add On representing the acceptance of its terms of use and additional pricing.

Link copied to clipboard

Filtering options for ListMembersOfAddressList operation.

Link copied to clipboard

An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.

Link copied to clipboard
class Analysis

The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.

Link copied to clipboard
class Archive

An archive resource for storing and retaining emails.

Link copied to clipboard

The action to archive the email by delivering the email to an Amazon SES archive.

Link copied to clipboard
Link copied to clipboard

A boolean expression to evaluate email attribute values.

Link copied to clipboard
Link copied to clipboard

The attribute to evaluate in a boolean expression.

Link copied to clipboard

A filter condition used to include or exclude emails when exporting from or searching an archive.

Link copied to clipboard

A set of filter conditions to include and/or exclude emails.

Link copied to clipboard
sealed class ArchiveRetention

The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.

Link copied to clipboard
sealed class ArchiveState
Link copied to clipboard
Link copied to clipboard

A string expression to evaluate an email attribute value against one or more string values.

Link copied to clipboard
Link copied to clipboard

Specifies the email attribute to evaluate in a string expression.

Link copied to clipboard

The request configuration has conflicts. For details, see the accompanying error message.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to create a new email archive.

Link copied to clipboard

The response from creating a new email archive.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to initiate deletion of an email archive.

Link copied to clipboard

The response indicating if the archive deletion was successfully initiated.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This action to delivers an email to a mailbox.

Link copied to clipboard

The action to deliver incoming emails to an Amazon Q Business application for indexing.

Link copied to clipboard

This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.

Link copied to clipboard
class Envelope

The SMTP envelope information of the email.

Link copied to clipboard

The destination configuration for delivering exported email data.

Link copied to clipboard
sealed class ExportState
Link copied to clipboard

The current status of an archive export job.

Link copied to clipboard

Summary statuses of an archive export job.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to retrieve details of a specific archive export job.

Link copied to clipboard

The response containing details of the specified archive export job.

Link copied to clipboard

The request to get the textual content of a specific email message stored in an archive.

Link copied to clipboard

The response containing the textual content of the requested archived email message.

Link copied to clipboard

The request to get details of a specific email message stored in an archive.

Link copied to clipboard

The response containing details about the requested archived email message.

Link copied to clipboard

The request to retrieve details of an email archive.

Link copied to clipboard

The response containing details of the requested archive.

Link copied to clipboard

The request to retrieve details of a specific archive search job.

Link copied to clipboard

The response containing details of the specified archive search job.

Link copied to clipboard

The request to retrieve results from a completed archive search job.

Link copied to clipboard

The response containing search results from a completed archive search.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The import data format contains the specifications of the input file that would be passed to the address list import job.

Link copied to clipboard
sealed class ImportDataType
Link copied to clipboard
class ImportJob

Details about an import job.

Link copied to clipboard
sealed class ImportJobStatus
Link copied to clipboard

The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.

Link copied to clipboard

The structure for a boolean condition matching on the incoming mail.

Link copied to clipboard
Link copied to clipboard

The union type representing the allowed types of operands for a boolean condition.

Link copied to clipboard
sealed class IngressIpOperator
Link copied to clipboard
sealed class IngressIpToEvaluate

The structure for an IP based condition matching on the incoming mail.

Link copied to clipboard
Link copied to clipboard

The union type representing the allowed types for the left hand side of an IP condition.

Link copied to clipboard
Link copied to clipboard

The union type representing the allowed types for the left hand side of an IPv6 condition.

Link copied to clipboard

The structure for an IPv6 based condition matching on the incoming mail.

Link copied to clipboard

The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.

Link copied to clipboard

The structure of an ingress endpoint resource.

Link copied to clipboard

The authentication configuration for the ingress endpoint resource.

Link copied to clipboard

The configuration of the ingress endpoint resource.

Link copied to clipboard

The password configuration of the ingress endpoint resource.

Link copied to clipboard
sealed class IngressPointStatus
Link copied to clipboard
Link copied to clipboard
sealed class IngressPointType
Link copied to clipboard
Link copied to clipboard

The structure for a string based condition matching on the incoming mail.

Link copied to clipboard
Link copied to clipboard

The union type representing the allowed types for the left hand side of a string condition.

Link copied to clipboard
sealed class IngressTlsAttribute
Link copied to clipboard
Link copied to clipboard

The structure for a TLS related condition matching on the incoming mail.

Link copied to clipboard
Link copied to clipboard

The union type representing the allowed types for the left hand side of a TLS condition.

Link copied to clipboard
sealed class IpType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to list archive export jobs in your account.

Link copied to clipboard

The response containing a list of archive export jobs and their statuses.

Link copied to clipboard

The request to list archive search jobs in your account.

Link copied to clipboard

The response containing a list of archive search jobs and their statuses.

Link copied to clipboard

The request to list email archives in your account.

Link copied to clipboard

The response containing a list of your email archives.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class MailFrom
Link copied to clipboard

Base class for all service related exceptions thrown by the MailManager client

Link copied to clipboard

The textual body content of an email message.

Link copied to clipboard
class Metadata

The metadata about the email.

Link copied to clipboard

The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

Link copied to clipboard

Explicitly indicate that the relay destination server does not require SMTP credential authentication.

Link copied to clipboard
sealed class PolicyCondition

The email traffic filtering conditions which are contained in a traffic policy resource.

Link copied to clipboard

The structure containing traffic policy conditions and actions.

Link copied to clipboard

Specifies the network configuration for the private ingress point.

Link copied to clipboard

Specifies the network configuration for the public ingress point.

Link copied to clipboard
class Relay

The relay resource that can be used as a rule to relay receiving emails to the destination relay server.

Link copied to clipboard

The action relays the email via SMTP to another specific SMTP server.

Link copied to clipboard
sealed class RelayAuthentication

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.

Link copied to clipboard

This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.

Link copied to clipboard

Occurs when a requested resource is not found.

Link copied to clipboard
sealed class RetentionPeriod
Link copied to clipboard
class Row

A result row containing metadata for an archived email message.

Link copied to clipboard
class Rule

A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions".

Link copied to clipboard
sealed class RuleAction

The action for a rule to take. Only one of the contained actions can be set.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A boolean expression to be used in a rule condition.

Link copied to clipboard
sealed class RuleBooleanOperator
Link copied to clipboard

The union type representing the allowed types of operands for a boolean condition.

Link copied to clipboard
sealed class RuleCondition

The conditional expression used to evaluate an email for determining if a rule action should be taken.

Link copied to clipboard

A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.

Link copied to clipboard
sealed class RuleDmarcOperator
Link copied to clipboard
sealed class RuleDmarcPolicy
Link copied to clipboard
Link copied to clipboard

An IP address expression matching certain IP addresses within a given range of IP addresses.

Link copied to clipboard
sealed class RuleIpOperator
Link copied to clipboard
sealed class RuleIpToEvaluate

The IP address to evaluate for this condition.

Link copied to clipboard

The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.

Link copied to clipboard
Link copied to clipboard

A number expression to match numeric conditions with integers from the incoming email.

Link copied to clipboard
sealed class RuleNumberOperator
Link copied to clipboard

The number to evaluate in a numeric condition expression.

Link copied to clipboard
class RuleSet

A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.

Link copied to clipboard
Link copied to clipboard

A string expression is evaluated against strings or substrings of the email.

Link copied to clipboard
sealed class RuleStringOperator
Link copied to clipboard

The string to evaluate in a string condition expression.

Link copied to clipboard
sealed class RuleVerdict
Link copied to clipboard
Link copied to clipboard

A verdict expression is evaluated against verdicts of the email.

Link copied to clipboard
sealed class RuleVerdictOperator
Link copied to clipboard

The verdict to evaluate in a verdict condition expression.

Link copied to clipboard
class S3Action

Writes the MIME content of the email to an S3 bucket.

Link copied to clipboard

The configuration for exporting email data to an Amazon S3 bucket.

Link copied to clipboard

An address that is a member of an address list.

Link copied to clipboard
sealed class SearchState
Link copied to clipboard

The current status of an archive search job.

Link copied to clipboard

Summary details of an archive search job.

Link copied to clipboard

Sends the email to the internet using the ses:SendRawEmail API.

Link copied to clipboard

Occurs when an operation exceeds a predefined service quota or limit.

Link copied to clipboard
class SnsAction

The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to initiate an export of emails from an archive.

Link copied to clipboard

The response from initiating an archive export.

Link copied to clipboard

The request to initiate a search across emails in an archive.

Link copied to clipboard

The response from initiating an archive search.

Link copied to clipboard

The request to stop an in-progress archive export job.

Link copied to clipboard

The response indicating if the request to stop the export job succeeded.

Link copied to clipboard

The request to stop an in-progress archive search job.

Link copied to clipboard

The response indicating if the request to stop the search job succeeded.

Link copied to clipboard
class Tag

A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

Link copied to clipboard

The structure of a traffic policy resource which is a container for policy statements.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to update properties of an existing email archive.

Link copied to clipboard

The response indicating if the archive update succeeded or failed.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request validation has failed. For details, see the accompanying error message.