View Source AWS.MailManager (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

Creates an Add On instance for the subscription indicated in the request.

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

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

Provision a new ingress endpoint resource.

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

Provision a new traffic policy resource.

Initiates deletion of an email archive.

Delete an ingress endpoint resource.

Deletes an existing relay resource.

Delete a traffic policy resource.

Gets detailed information about an Add On instance.

Gets detailed information about an Add On subscription.

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

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

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

Returns the textual content of a specific email message stored in the archive.

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

Returns the results of a completed email archive search job.

Fetch ingress endpoint resource attributes.

Fetch the relay resource and it's attributes.

Fetch attributes of a rule set.

Fetch attributes of a traffic policy resource.

Lists all Add On instances in your account.

Lists all Add On subscriptions in your account.

Returns a list of email archive export jobs.

Returns a list of email archive search jobs.

Returns a list of all email archives in your account.

List all ingress endpoint resources.

Lists all the existing relay resources.

List rule sets for this account.

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

Initiates an export of emails from the specified archive.

Initiates a search across emails in the specified archive.

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

Stops an in-progress archive search job.

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

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

Updates the attributes of an existing email archive.

Update attributes of a provisioned ingress endpoint resource.

Updates the attributes of an existing relay resource.

Update attributes of an already provisioned rule set.

Update attributes of an already provisioned traffic policy resource.

Link to this section Functions

Link to this function

create_addon_instance(client, input, options \\ [])

View Source

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.

Link to this function

create_addon_subscription(client, input, options \\ [])

View Source

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.

Link to this function

create_archive(client, input, options \\ [])

View Source

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

Link to this function

create_ingress_point(client, input, options \\ [])

View Source

Provision a new ingress endpoint resource.

Link to this function

create_relay(client, input, options \\ [])

View Source

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

Link to this function

create_rule_set(client, input, options \\ [])

View Source

Provision a new rule set.

Link to this function

create_traffic_policy(client, input, options \\ [])

View Source

Provision a new traffic policy resource.

Link to this function

delete_addon_instance(client, input, options \\ [])

View Source

Deletes an Add On instance.

Link to this function

delete_addon_subscription(client, input, options \\ [])

View Source

Deletes an Add On subscription.

Link to this function

delete_archive(client, input, options \\ [])

View Source

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.

Link to this function

delete_ingress_point(client, input, options \\ [])

View Source

Delete an ingress endpoint resource.

Link to this function

delete_relay(client, input, options \\ [])

View Source

Deletes an existing relay resource.

Link to this function

delete_rule_set(client, input, options \\ [])

View Source

Delete a rule set.

Link to this function

delete_traffic_policy(client, input, options \\ [])

View Source

Delete a traffic policy resource.

Link to this function

get_addon_instance(client, input, options \\ [])

View Source

Gets detailed information about an Add On instance.

Link to this function

get_addon_subscription(client, input, options \\ [])

View Source

Gets detailed information about an Add On subscription.

Link to this function

get_archive(client, input, options \\ [])

View Source

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

Link to this function

get_archive_export(client, input, options \\ [])

View Source

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

Link to this function

get_archive_message(client, input, options \\ [])

View Source

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

Link to this function

get_archive_message_content(client, input, options \\ [])

View Source

Returns the textual content of a specific email message stored in the archive.

Attachments are not included.

Link to this function

get_archive_search(client, input, options \\ [])

View Source

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

Link to this function

get_archive_search_results(client, input, options \\ [])

View Source

Returns the results of a completed email archive search job.

Link to this function

get_ingress_point(client, input, options \\ [])

View Source

Fetch ingress endpoint resource attributes.

Link to this function

get_relay(client, input, options \\ [])

View Source

Fetch the relay resource and it's attributes.

Link to this function

get_rule_set(client, input, options \\ [])

View Source

Fetch attributes of a rule set.

Link to this function

get_traffic_policy(client, input, options \\ [])

View Source

Fetch attributes of a traffic policy resource.

Link to this function

list_addon_instances(client, input, options \\ [])

View Source

Lists all Add On instances in your account.

Link to this function

list_addon_subscriptions(client, input, options \\ [])

View Source

Lists all Add On subscriptions in your account.

Link to this function

list_archive_exports(client, input, options \\ [])

View Source

Returns a list of email archive export jobs.

Link to this function

list_archive_searches(client, input, options \\ [])

View Source

Returns a list of email archive search jobs.

Link to this function

list_archives(client, input, options \\ [])

View Source

Returns a list of all email archives in your account.

Link to this function

list_ingress_points(client, input, options \\ [])

View Source

List all ingress endpoint resources.

Link to this function

list_relays(client, input, options \\ [])

View Source

Lists all the existing relay resources.

Link to this function

list_rule_sets(client, input, options \\ [])

View Source

List rule sets for this account.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

list_traffic_policies(client, input, options \\ [])

View Source

List traffic policy resources.

Link to this function

start_archive_export(client, input, options \\ [])

View Source

Initiates an export of emails from the specified archive.

Link to this function

start_archive_search(client, input, options \\ [])

View Source

Initiates a search across emails in the specified archive.

Link to this function

stop_archive_export(client, input, options \\ [])

View Source

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

Link to this function

stop_archive_search(client, input, options \\ [])

View Source

Stops an in-progress archive search job.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, input, options \\ [])

View Source

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

Link to this function

update_archive(client, input, options \\ [])

View Source

Updates the attributes of an existing email archive.

Link to this function

update_ingress_point(client, input, options \\ [])

View Source

Update attributes of a provisioned ingress endpoint resource.

Link to this function

update_relay(client, input, options \\ [])

View Source

Updates the attributes of an existing relay resource.

Link to this function

update_rule_set(client, input, options \\ [])

View Source

Update attributes of an already provisioned rule set.

Link to this function

update_traffic_policy(client, input, options \\ [])

View Source

Update attributes of an already provisioned traffic policy resource.