Amazon Web Services, Inc.

MailManager

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…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 60

Addon instance

  • POSTCreate addon instance/#X-Amz-Target=MailManagerSvc.CreateAddonInstanceCreates 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…
  • POSTDelete addon instance/#X-Amz-Target=MailManagerSvc.DeleteAddonInstanceDeletes an Add On instance.
  • POSTGet addon instance/#X-Amz-Target=MailManagerSvc.GetAddonInstanceGets detailed information about an Add On instance.
  • POSTList addon instances/#X-Amz-Target=MailManagerSvc.ListAddonInstancesLists all Add On instances in your account.

Addon subscription

  • POSTCreate addon subscription/#X-Amz-Target=MailManagerSvc.CreateAddonSubscriptionCreates 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…
  • POSTDelete addon subscription/#X-Amz-Target=MailManagerSvc.DeleteAddonSubscriptionDeletes an Add On subscription.
  • POSTGet addon subscription/#X-Amz-Target=MailManagerSvc.GetAddonSubscriptionGets detailed information about an Add On subscription.
  • POSTList addon subscriptions/#X-Amz-Target=MailManagerSvc.ListAddonSubscriptionsLists all Add On subscriptions in your account.

Address list

  • POSTCreate address list/#X-Amz-Target=MailManagerSvc.CreateAddressListCreates a new address list.
  • POSTDelete address list/#X-Amz-Target=MailManagerSvc.DeleteAddressListDeletes an address list.
  • POSTGet address list/#X-Amz-Target=MailManagerSvc.GetAddressListFetch attributes of an address list.
  • POSTList address lists/#X-Amz-Target=MailManagerSvc.ListAddressListsLists address lists for this account.

Archive

  • POSTCreate archive/#X-Amz-Target=MailManagerSvc.CreateArchiveCreates a new email archive resource for storing and retaining emails.
  • POSTDelete archive/#X-Amz-Target=MailManagerSvc.DeleteArchiveInitiates 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…
  • POSTGet archive/#X-Amz-Target=MailManagerSvc.GetArchiveRetrieves the full details and current state of a specified email archive.
  • POSTList archives/#X-Amz-Target=MailManagerSvc.ListArchivesReturns a list of all email archives in your account.
  • POSTUpdate archive/#X-Amz-Target=MailManagerSvc.UpdateArchiveUpdates the attributes of an existing email archive.

Ingress point

  • POSTCreate ingress point/#X-Amz-Target=MailManagerSvc.CreateIngressPointProvision a new ingress endpoint resource.
  • POSTDelete ingress point/#X-Amz-Target=MailManagerSvc.DeleteIngressPointDelete an ingress endpoint resource.
  • POSTGet ingress point/#X-Amz-Target=MailManagerSvc.GetIngressPointFetch ingress endpoint resource attributes.
  • POSTList ingress points/#X-Amz-Target=MailManagerSvc.ListIngressPointsList all ingress endpoint resources.
  • POSTUpdate ingress point/#X-Amz-Target=MailManagerSvc.UpdateIngressPointUpdate attributes of a provisioned ingress endpoint resource.

Relay

  • POSTCreate relay/#X-Amz-Target=MailManagerSvc.CreateRelayCreates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
  • POSTDelete relay/#X-Amz-Target=MailManagerSvc.DeleteRelayDeletes an existing relay resource.
  • POSTGet relay/#X-Amz-Target=MailManagerSvc.GetRelayFetch the relay resource and it's attributes.
  • POSTList relays/#X-Amz-Target=MailManagerSvc.ListRelaysLists all the existing relay resources.
  • POSTUpdate relay/#X-Amz-Target=MailManagerSvc.UpdateRelayUpdates the attributes of an existing relay resource.

Rule set

  • POSTCreate rule set/#X-Amz-Target=MailManagerSvc.CreateRuleSetProvision a new rule set.
  • POSTDelete rule set/#X-Amz-Target=MailManagerSvc.DeleteRuleSetDelete a rule set.
  • POSTGet rule set/#X-Amz-Target=MailManagerSvc.GetRuleSetFetch attributes of a rule set.
  • POSTList rule sets/#X-Amz-Target=MailManagerSvc.ListRuleSetsList rule sets for this account.
  • POSTUpdate rule set/#X-Amz-Target=MailManagerSvc.UpdateRuleSetUpdate attributes of an already provisioned rule set.

Traffic policy

  • POSTCreate traffic policy/#X-Amz-Target=MailManagerSvc.CreateTrafficPolicyProvision a new traffic policy resource.
  • POSTDelete traffic policy/#X-Amz-Target=MailManagerSvc.DeleteTrafficPolicyDelete a traffic policy resource.
  • POSTGet traffic policy/#X-Amz-Target=MailManagerSvc.GetTrafficPolicyFetch attributes of a traffic policy resource.
  • POSTList traffic policies/#X-Amz-Target=MailManagerSvc.ListTrafficPoliciesList traffic policy resources.
  • POSTUpdate traffic policy/#X-Amz-Target=MailManagerSvc.UpdateTrafficPolicyUpdate attributes of an already provisioned traffic policy resource.
  • POSTCreate address list import job/#X-Amz-Target=MailManagerSvc.CreateAddressListImportJobCreates an import job for an address list.
  • POSTDeregister member from address list/#X-Amz-Target=MailManagerSvc.DeregisterMemberFromAddressListRemoves a member from an address list.
  • POSTGet address list import job/#X-Amz-Target=MailManagerSvc.GetAddressListImportJobFetch attributes of an import job.
  • POSTGet archive export/#X-Amz-Target=MailManagerSvc.GetArchiveExportRetrieves the details and current status of a specific email archive export job.
  • POSTGet archive message/#X-Amz-Target=MailManagerSvc.GetArchiveMessageReturns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
  • POSTGet archive message content/#X-Amz-Target=MailManagerSvc.GetArchiveMessageContentReturns the textual content of a specific email message stored in the archive. Attachments are not included.
  • POSTGet archive search/#X-Amz-Target=MailManagerSvc.GetArchiveSearchRetrieves the details and current status of a specific email archive search job.
  • POSTGet archive search results/#X-Amz-Target=MailManagerSvc.GetArchiveSearchResultsReturns the results of a completed email archive search job.
  • POSTGet member of address list/#X-Amz-Target=MailManagerSvc.GetMemberOfAddressListFetch attributes of a member in an address list.
  • POSTList address list import jobs/#X-Amz-Target=MailManagerSvc.ListAddressListImportJobsLists jobs for an address list.
  • POSTList archive exports/#X-Amz-Target=MailManagerSvc.ListArchiveExportsReturns a list of email archive export jobs.
  • POSTList archive searches/#X-Amz-Target=MailManagerSvc.ListArchiveSearchesReturns a list of email archive search jobs.
  • POSTList members of address list/#X-Amz-Target=MailManagerSvc.ListMembersOfAddressListLists members of an address list.
  • POSTList tags for resource/#X-Amz-Target=MailManagerSvc.ListTagsForResourceRetrieves the list of tags (keys and values) assigned to the resource.
  • POSTRegister member to address list/#X-Amz-Target=MailManagerSvc.RegisterMemberToAddressListAdds a member to an address list.
  • POSTStart address list import job/#X-Amz-Target=MailManagerSvc.StartAddressListImportJobStarts an import job for an address list.
  • POSTStart archive export/#X-Amz-Target=MailManagerSvc.StartArchiveExportInitiates an export of emails from the specified archive.
  • POSTStart archive search/#X-Amz-Target=MailManagerSvc.StartArchiveSearchInitiates a search across emails in the specified archive.
  • POSTStop address list import job/#X-Amz-Target=MailManagerSvc.StopAddressListImportJobStops an ongoing import job for an address list.
  • POSTStop archive export/#X-Amz-Target=MailManagerSvc.StopArchiveExportStops an in-progress export of emails from an archive.
  • POSTStop archive search/#X-Amz-Target=MailManagerSvc.StopArchiveSearchStops an in-progress archive search job.
  • POSTTag resource/#X-Amz-Target=MailManagerSvc.TagResourceAdds one or more tags (keys and values) to a specified resource.
  • POSTUntag resource/#X-Amz-Target=MailManagerSvc.UntagResourceRemove one or more tags (keys and values) from a specified resource.

API details

Base URL
https://mail-manager.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
60 operations on 60 pathsPOST 60
Main resources
Archive 5Ingress point 5Relay 5Rule set 5Traffic policy 5Addon instance 4Addon subscription 4Address list 4
Description format
AWS Smithy model, API version 2023-10-17

How to test the MailManager in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the MailManager collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create addon instance” (POST /#X-Amz-Target=MailManagerSvc.CreateAddonInstance), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the MailManager?

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… It is listed under Developer tools and has 60 endpoints.

Who publishes the MailManager?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the MailManager?

Requests go to https://mail-manager.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the MailManager?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the MailManager have?

60 operations on 60 paths (60 POST). The largest groups are Archive, Ingress point, Relay, Rule set.

Is forking the MailManager free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.