com.amazonaws.services.workmailmessageflow

Interface AmazonWorkMailMessageFlow

All Known Subinterfaces:

AmazonWorkMailMessageFlowAsync

All Known Implementing Classes:

AbstractAmazonWorkMailMessageFlow, AbstractAmazonWorkMailMessageFlowAsync, AmazonWorkMailMessageFlowAsyncClient, AmazonWorkMailMessageFlowClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkMailMessageFlow

Interface for accessing Amazon WorkMail Message Flow.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkMailMessageFlow instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetRawMessageContentResult	getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest) Retrieves the raw content of an in-transit email message, in MIME format.
PutRawMessageContentResult	putRawMessageContent(PutRawMessageContentRequest putRawMessageContentRequest) Updates the raw content of an in-transit email message, in MIME format.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getRawMessageContent

GetRawMessageContentResult getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest)

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

Parameters:

getRawMessageContentRequest -

Returns:

Result of the GetRawMessageContent operation returned by the service.

Throws:

ResourceNotFoundException - The requested email message is not found.

See Also:

AWS API Documentation

putRawMessageContent

PutRawMessageContentResult putRawMessageContent(PutRawMessageContentRequest putRawMessageContentRequest)

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.

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.

Parameters:

putRawMessageContentRequest -

Returns:

Result of the PutRawMessageContent operation returned by the service.

Throws:

ResourceNotFoundException - The requested email message is not found.

InvalidContentLocationException - WorkMail could not access the updated email content. Possible reasons:

• You made the request in a region other than your S3 bucket region.

• The S3 bucket owner is not the same as the calling AWS account.

• You have an incomplete or missing S3 bucket policy. For more information about policies, see Updating message content with AWS Lambda in the WorkMail Administrator Guide.

MessageRejectedException - The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error.

MessageFrozenException - The requested email is not eligible for update. This is usually the case for a redirected email.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.