Amazon Web Services, Inc.

Amazon WorkMail Message Flow

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

Communication#openapi#cloud

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

The WorkMail Message Flow API provides access to email messages as they are
being
sent and received by
a
WorkMail organization.

Endpoints 2

  • GETGet raw message content/messages/:messageIdRetrieves the raw content of an in-transit email message, in MIME format.
  • POSTPut raw message content/messages/:messageIdUpdates the raw content of an in-transit email message, in MIME format. This example describes how to update in-transit email message. For more information…

API details

Base URL
https://workmailmessageflow.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
2 operations on 1 pathGET 1POST 1
Description format
AWS Smithy model, API version 2019-05-01

How to test the Amazon WorkMail Message Flow 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 Amazon WorkMail Message Flow 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 “Get raw message content” (GET /messages/:messageId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon WorkMail Message Flow?

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization. It is listed under Communication and has 2 endpoints.

Who publishes the Amazon WorkMail Message Flow?

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 Amazon WorkMail Message Flow?

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

How do I authenticate with the Amazon WorkMail Message Flow?

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

How many endpoints does the Amazon WorkMail Message Flow have?

2 operations on 1 path (1 GET, 1 POST).

Is forking the Amazon WorkMail Message Flow 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.