AWS.WorkMailMessageFlow — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.WorkMailMessageFlow show all

Identifier:

workmailmessageflow

API Version:

2019-05-01

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using WorkMailMessageFlow

var workmailmessageflow = new AWS.WorkMailMessageFlow();
workmailmessageflow.getRawMessageContent(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the WorkMailMessageFlow object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var workmailmessageflow = new AWS.WorkMailMessageFlow({apiVersion: '2019-05-01'});

You can also set the API version globally in AWS.config.apiVersions using the workmailmessageflow service identifier:

AWS.config.apiVersions = {
  workmailmessageflow: '2019-05-01',
  // other service API versions
};

var workmailmessageflow = new AWS.WorkMailMessageFlow();

Constructor Summarycollapse

• new AWS.WorkMailMessageFlow(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• getRawMessageContent(params = {}, callback) ⇒ AWS.Request
  Retrieves the raw content of an in-transit email message, in MIME format.
  .
• putRawMessageContent(params = {}, callback) ⇒ AWS.Request
  Updates the raw content of an in-transit email message, in MIME format.
  This example describes how to update in-transit email message.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.WorkMailMessageFlow(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

getRawMessageContent(params = {}, callback) ⇒ AWS.Request

Retrieves the raw content of an in-transit email message, in MIME format.

putRawMessageContent(params = {}, callback) ⇒ AWS.Request

Updates 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 and examples for using this API, see Updating message content with AWS Lambda.

Note: Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message.