Interface WorkMailMessageFlowClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aWorkMailMessageFlowClient
.static WorkMailMessageFlowClient
create()
Create aWorkMailMessageFlowClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.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.getRawMessageContentAsBytes
(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest) Retrieves the raw content of an in-transit email message, in MIME format.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getRawMessageContent
default <ReturnT> ReturnT getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest, ResponseTransformer<GetRawMessageContentResponse, ReturnT> responseTransformer) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowExceptionRetrieves the raw content of an in-transit email message, in MIME format.
- Parameters:
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. SeeResponseTransformer
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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getRawMessageContent
default <ReturnT> ReturnT getRawMessageContent(Consumer<GetRawMessageContentRequest.Builder> getRawMessageContentRequest, ResponseTransformer<GetRawMessageContentResponse, ReturnT> responseTransformer) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowExceptionRetrieves 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 viaGetRawMessageContentRequest.builder()
- Parameters:
getRawMessageContentRequest
- AConsumer
that will call methods onGetRawMessageContentRequest.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. SeeResponseTransformer
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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getRawMessageContent
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.
- Parameters:
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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getRawMessageContent
default 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 viaGetRawMessageContentRequest.builder()
- Parameters:
getRawMessageContentRequest
- AConsumer
that will call methods onGetRawMessageContentRequest.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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getRawMessageContent
default ResponseInputStream<GetRawMessageContentResponse> getRawMessageContent(GetRawMessageContentRequest getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException Retrieves the raw content of an in-transit email message, in MIME format.
- Parameters:
getRawMessageContentRequest
-- Returns:
- A
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 viaResponseInputStream.response()
. The service documentation for the response content is as follows 'The raw content of the email message, in MIME format.
'. - See Also:
-
getRawMessageContent
default 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 viaGetRawMessageContentRequest.builder()
- Parameters:
getRawMessageContentRequest
- AConsumer
that will call methods onGetRawMessageContentRequest.Builder
to create a request.- Returns:
- A
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 viaResponseInputStream.response()
. The service documentation for the response content is as follows 'The raw content of the email message, in MIME format.
'. - See Also:
-
getRawMessageContentAsBytes
default ResponseBytes<GetRawMessageContentResponse> getRawMessageContentAsBytes(GetRawMessageContentRequest getRawMessageContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailMessageFlowException Retrieves the raw content of an in-transit email message, in MIME format.
- Parameters:
getRawMessageContentRequest
-- Returns:
- A
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 viaResponseBytes.response()
. The service documentation for the response content is as follows 'The raw content of the email message, in MIME format.
'. - See Also:
-
getRawMessageContentAsBytes
default 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 viaGetRawMessageContentRequest.builder()
- Parameters:
getRawMessageContentRequest
- AConsumer
that will call methods onGetRawMessageContentRequest.Builder
to create a request.- Returns:
- A
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 viaResponseBytes.response()
. The service documentation for the response content is as follows 'The raw content of the email message, in MIME format.
'. - See Also:
-
putRawMessageContent
default 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 callPutRawMessageContent
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.
- See Also:
-
putRawMessageContent
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 callPutRawMessageContent
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 viaPutRawMessageContentRequest.builder()
- Parameters:
putRawMessageContentRequest
- AConsumer
that will call methods onPutRawMessageContentRequest.Builder
to create a request.- Returns:
- Result of the PutRawMessageContent operation returned by the service.
- See Also:
-
create
Create aWorkMailMessageFlowClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkMailMessageFlowClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-