@Generated(value="software.amazon.awssdk:codegen") public interface WorkMailMessageFlowAsyncClient extends SdkClient
builder()
method.
The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static WorkMailMessageFlowAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailMessageFlowAsyncClient . |
static WorkMailMessageFlowAsyncClient |
create()
Create a
WorkMailMessageFlowAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default <ReturnT> CompletableFuture<ReturnT> |
getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest,
AsyncResponseTransformer<GetRawMessageContentResponse,ReturnT> asyncResponseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default CompletableFuture<GetRawMessageContentResponse> |
getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest,
Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default <ReturnT> CompletableFuture<ReturnT> |
getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest,
AsyncResponseTransformer<GetRawMessageContentResponse,ReturnT> asyncResponseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default CompletableFuture<GetRawMessageContentResponse> |
getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest,
Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default CompletableFuture<PutRawMessageContentResponse> |
putRawMessageContent(Consumer<PutRawMessageContentRequest.Builder> putRawMessageContentRequest)
Updates the raw content of an in-transit email message, in MIME format.
|
default CompletableFuture<PutRawMessageContentResponse> |
putRawMessageContent(PutRawMessageContentRequest putRawMessageContentRequest)
Updates the raw content of an in-transit email message, in MIME format.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static WorkMailMessageFlowAsyncClient create()
WorkMailMessageFlowAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WorkMailMessageFlowAsyncClientBuilder builder()
WorkMailMessageFlowAsyncClient
.default <ReturnT> CompletableFuture<ReturnT> getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest, AsyncResponseTransformer<GetRawMessageContentResponse,ReturnT> asyncResponseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
getRawMessageContentRequest
- asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The raw content of the email message, in MIME format.
'.default <ReturnT> CompletableFuture<ReturnT> getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest, AsyncResponseTransformer<GetRawMessageContentResponse,ReturnT> asyncResponseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
This is a convenience which creates an instance of the GetRawMessageContentRequest.Builder
avoiding the
need to create one manually via GetRawMessageContentRequest.builder()
getRawMessageContentRequest
- A Consumer
that will call methods on GetRawMessageContentRequest.Builder
to create a
request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The raw content of the email message, in MIME format.
'.default CompletableFuture<GetRawMessageContentResponse> getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest, Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
getRawMessageContentRequest
- destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The raw content of the email message, in MIME format.
'.default CompletableFuture<GetRawMessageContentResponse> getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest, Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
This is a convenience which creates an instance of the GetRawMessageContentRequest.Builder
avoiding the
need to create one manually via GetRawMessageContentRequest.builder()
getRawMessageContentRequest
- A Consumer
that will call methods on GetRawMessageContentRequest.Builder
to create a
request.destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The raw content of the email message, in MIME format.
'.default CompletableFuture<PutRawMessageContentResponse> 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.
putRawMessageContentRequest
- 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.
default CompletableFuture<PutRawMessageContentResponse> putRawMessageContent(Consumer<PutRawMessageContentRequest.Builder> 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.
This is a convenience which creates an instance of the PutRawMessageContentRequest.Builder
avoiding the
need to create one manually via PutRawMessageContentRequest.builder()
putRawMessageContentRequest
- A Consumer
that will call methods on PutRawMessageContentRequest.Builder
to create a
request.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.