@Generated(value="software.amazon.awssdk:codegen") public interface WorkMailMessageFlowClient 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 WorkMailMessageFlowClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailMessageFlowClient . |
static WorkMailMessageFlowClient |
create()
Create a
WorkMailMessageFlowClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default ResponseInputStream<GetRawMessageContentResponse> |
getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default GetRawMessageContentResponse |
getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest,
Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default <ReturnT> ReturnT |
getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest,
ResponseTransformer<GetRawMessageContentResponse,ReturnT> responseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default ResponseInputStream<GetRawMessageContentResponse> |
getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default GetRawMessageContentResponse |
getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest,
Path destinationPath)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default <ReturnT> ReturnT |
getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest,
ResponseTransformer<GetRawMessageContentResponse,ReturnT> responseTransformer)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default ResponseBytes<GetRawMessageContentResponse> |
getRawMessageContentAsBytes(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default ResponseBytes<GetRawMessageContentResponse> |
getRawMessageContentAsBytes(GetRawMessageContentRequest getRawMessageContentRequest)
Retrieves the raw content of an in-transit email message, in MIME format.
|
default PutRawMessageContentResponse |
putRawMessageContent(Consumer<PutRawMessageContentRequest.Builder> putRawMessageContentRequest)
Updates the raw content of an in-transit email message, in MIME format.
|
default PutRawMessageContentResponse |
putRawMessageContent(PutRawMessageContentRequest putRawMessageContentRequest)
Updates the raw content of an in-transit email message, in MIME format.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static WorkMailMessageFlowClient create()
WorkMailMessageFlowClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WorkMailMessageFlowClientBuilder builder()
WorkMailMessageFlowClient
.default <ReturnT> ReturnT getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest, ResponseTransformer<GetRawMessageContentResponse,ReturnT> responseTransformer) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
Retrieves the raw content of an in-transit email message, in MIME format.
getRawMessageContentRequest
- responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled
GetRawMessageContentResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer
for details on implementing this interface
and for links to pre-canned 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.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default <ReturnT> ReturnT getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest, ResponseTransformer<GetRawMessageContentResponse,ReturnT> responseTransformer) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled
GetRawMessageContentResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer
for details on implementing this interface
and for links to pre-canned 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.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRawMessageContentResponse getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest, Path destinationPath) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRawMessageContent(GetRawMessageContentRequest, ResponseTransformer)
,
AWS API Documentationdefault GetRawMessageContentResponse getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest, Path destinationPath) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRawMessageContent(GetRawMessageContentRequest, ResponseTransformer)
,
AWS API Documentationdefault ResponseInputStream<GetRawMessageContentResponse> getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
Retrieves the raw content of an in-transit email message, in MIME format.
getRawMessageContentRequest
- ResponseInputStream
containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response()
. The service documentation for the response content is as follows
'
The raw content of the email message, in MIME format.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
#getObject(getRawMessageContent, ResponseTransformer)
,
AWS API Documentationdefault ResponseInputStream<GetRawMessageContentResponse> getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.ResponseInputStream
containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response()
. The service documentation for the response content is as follows
'
The raw content of the email message, in MIME format.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
#getObject(getRawMessageContent, ResponseTransformer)
,
AWS API Documentationdefault ResponseBytes<GetRawMessageContentResponse> getRawMessageContentAsBytes(GetRawMessageContentRequest getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
Retrieves the raw content of an in-transit email message, in MIME format.
getRawMessageContentRequest
- ResponseBytes
that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response()
. The service documentation for the response content is
as follows '
The raw content of the email message, in MIME format.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
#getObject(getRawMessageContent, ResponseTransformer)
,
AWS API Documentationdefault ResponseBytes<GetRawMessageContentResponse> getRawMessageContentAsBytes(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.ResponseBytes
that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response()
. The service documentation for the response content is
as follows '
The raw content of the email message, in MIME format.
'.ResourceNotFoundException
- The requested email message is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
#getObject(getRawMessageContent, ResponseTransformer)
,
AWS API Documentationdefault PutRawMessageContentResponse putRawMessageContent(PutRawMessageContentRequest putRawMessageContentRequest) throws ResourceNotFoundException, InvalidContentLocationException, MessageRejectedException, MessageFrozenException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutRawMessageContentResponse putRawMessageContent(Consumer<PutRawMessageContentRequest.Builder> putRawMessageContentRequest) throws ResourceNotFoundException, InvalidContentLocationException, MessageRejectedException, MessageFrozenException, AwsServiceException, SdkClientException, WorkMailMessageFlowException
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailMessageFlowException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()