MailManagerClient

Amazon SES Mail Manager API

The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES) .

Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter  in the Amazon SES Developer Guide.

Installation

NPM
npm install @aws-sdk/client-mailmanager
Yarn
yarn add @aws-sdk/client-mailmanager
pnpm
pnpm add @aws-sdk/client-mailmanager

MailManagerClient Operations

Command
Summary
CreateAddonInstanceCommand

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

CreateAddonSubscriptionCommand

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.

CreateAddressListCommand

Creates a new address list.

CreateAddressListImportJobCommand

Creates an import job for an address list.

CreateArchiveCommand

Creates a new email archive resource for storing and retaining emails.

CreateIngressPointCommand

Provision a new ingress endpoint resource.

CreateRelayCommand

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

CreateRuleSetCommand

Provision a new rule set.

CreateTrafficPolicyCommand

Provision a new traffic policy resource.

DeleteAddonInstanceCommand

Deletes an Add On instance.

DeleteAddonSubscriptionCommand

Deletes an Add On subscription.

DeleteAddressListCommand

Deletes an address list.

DeleteArchiveCommand

Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.

DeleteIngressPointCommand

Delete an ingress endpoint resource.

DeleteRelayCommand

Deletes an existing relay resource.

DeleteRuleSetCommand

Delete a rule set.

DeleteTrafficPolicyCommand

Delete a traffic policy resource.

DeregisterMemberFromAddressListCommand

Removes a member from an address list.

GetAddonInstanceCommand

Gets detailed information about an Add On instance.

GetAddonSubscriptionCommand

Gets detailed information about an Add On subscription.

GetAddressListCommand

Fetch attributes of an address list.

GetAddressListImportJobCommand

Fetch attributes of an import job.

GetArchiveCommand

Retrieves the full details and current state of a specified email archive.

GetArchiveExportCommand

Retrieves the details and current status of a specific email archive export job.

GetArchiveMessageCommand

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

GetArchiveMessageContentCommand

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

GetArchiveSearchCommand

Retrieves the details and current status of a specific email archive search job.

GetArchiveSearchResultsCommand

Returns the results of a completed email archive search job.

GetIngressPointCommand

Fetch ingress endpoint resource attributes.

GetMemberOfAddressListCommand

Fetch attributes of a member in an address list.

GetRelayCommand

Fetch the relay resource and it's attributes.

GetRuleSetCommand

Fetch attributes of a rule set.

GetTrafficPolicyCommand

Fetch attributes of a traffic policy resource.

ListAddonInstancesCommand

Lists all Add On instances in your account.

ListAddonSubscriptionsCommand

Lists all Add On subscriptions in your account.

ListAddressListImportJobsCommand

Lists jobs for an address list.

ListAddressListsCommand

Lists address lists for this account.

ListArchiveExportsCommand

Returns a list of email archive export jobs.

ListArchiveSearchesCommand

Returns a list of email archive search jobs.

ListArchivesCommand

Returns a list of all email archives in your account.

ListIngressPointsCommand

List all ingress endpoint resources.

ListMembersOfAddressListCommand

Lists members of an address list.

ListRelaysCommand

Lists all the existing relay resources.

ListRuleSetsCommand

List rule sets for this account.

ListTagsForResourceCommand

Retrieves the list of tags (keys and values) assigned to the resource.

ListTrafficPoliciesCommand

List traffic policy resources.

RegisterMemberToAddressListCommand

Adds a member to an address list.

StartAddressListImportJobCommand

Starts an import job for an address list.

StartArchiveExportCommand

Initiates an export of emails from the specified archive.

StartArchiveSearchCommand

Initiates a search across emails in the specified archive.

StopAddressListImportJobCommand

Stops an ongoing import job for an address list.

StopArchiveExportCommand

Stops an in-progress export of emails from an archive.

StopArchiveSearchCommand

Stops an in-progress archive search job.

TagResourceCommand

Adds one or more tags (keys and values) to a specified resource.

UntagResourceCommand

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

UpdateArchiveCommand

Updates the attributes of an existing email archive.

UpdateIngressPointCommand

Update attributes of a provisioned ingress endpoint resource.

UpdateRelayCommand

Updates the attributes of an existing relay resource.

UpdateRuleSetCommand

Update attributes of an already provisioned rule set.

UpdateTrafficPolicyCommand

Update attributes of an already provisioned traffic policy resource.

MailManagerClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: MailManagerClientConfig