@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public interface EmailAsync extends AutoCloseable
API for the Email Delivery service. Use this API to send high-volume, application-generated emails. For more information, see Overview of the Email Delivery Service.
Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API. If a subsequent read request fails to reflect your changes, wait a few minutes and try again.
Modifier and Type | Method and Description |
---|---|
Future<ChangeSenderCompartmentResponse> |
changeSenderCompartment(ChangeSenderCompartmentRequest request,
AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler)
Moves a sender into a different compartment.
|
Future<CreateSenderResponse> |
createSender(CreateSenderRequest request,
AsyncHandler<CreateSenderRequest,CreateSenderResponse> handler)
Creates a sender for a tenancy in a given compartment.
|
Future<CreateSuppressionResponse> |
createSuppression(CreateSuppressionRequest request,
AsyncHandler<CreateSuppressionRequest,CreateSuppressionResponse> handler)
Adds recipient email addresses to the suppression list for a tenancy.
|
Future<DeleteSenderResponse> |
deleteSender(DeleteSenderRequest request,
AsyncHandler<DeleteSenderRequest,DeleteSenderResponse> handler)
Deletes an approved sender for a tenancy in a given compartment for a
provided
senderId . |
Future<DeleteSuppressionResponse> |
deleteSuppression(DeleteSuppressionRequest request,
AsyncHandler<DeleteSuppressionRequest,DeleteSuppressionResponse> handler)
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided
suppressionId . |
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
Future<GetSenderResponse> |
getSender(GetSenderRequest request,
AsyncHandler<GetSenderRequest,GetSenderResponse> handler)
Gets an approved sender for a given
senderId . |
Future<GetSuppressionResponse> |
getSuppression(GetSuppressionRequest request,
AsyncHandler<GetSuppressionRequest,GetSuppressionResponse> handler)
Gets the details of a suppressed recipient email address for a given
suppressionId . |
Future<ListSendersResponse> |
listSenders(ListSendersRequest request,
AsyncHandler<ListSendersRequest,ListSendersResponse> handler)
Gets a collection of approved sender email addresses and sender IDs.
|
Future<ListSuppressionsResponse> |
listSuppressions(ListSuppressionsRequest request,
AsyncHandler<ListSuppressionsRequest,ListSuppressionsResponse> handler)
Gets a list of suppressed recipient email addresses for a user.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
Future<UpdateSenderResponse> |
updateSender(UpdateSenderRequest request,
AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler)
Replaces the set of tags for a sender with the tags provided.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<ChangeSenderCompartmentResponse> changeSenderCompartment(ChangeSenderCompartmentRequest request, AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler)
Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateSenderResponse> createSender(CreateSenderRequest request, AsyncHandler<CreateSenderRequest,CreateSenderResponse> handler)
Creates a sender for a tenancy in a given compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateSuppressionResponse> createSuppression(CreateSuppressionRequest request, AsyncHandler<CreateSuppressionRequest,CreateSuppressionResponse> handler)
Adds recipient email addresses to the suppression list for a tenancy.
Addresses added to the suppression list via the API are denoted as
"MANUAL" in the reason
field. Note: All email addresses added to the
suppression list are normalized to include only lowercase letters.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteSenderResponse> deleteSender(DeleteSenderRequest request, AsyncHandler<DeleteSenderRequest,DeleteSenderResponse> handler)
Deletes an approved sender for a tenancy in a given compartment for a
provided senderId
.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteSuppressionResponse> deleteSuppression(DeleteSuppressionRequest request, AsyncHandler<DeleteSuppressionRequest,DeleteSuppressionResponse> handler)
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided suppressionId
.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSenderResponse> getSender(GetSenderRequest request, AsyncHandler<GetSenderRequest,GetSenderResponse> handler)
Gets an approved sender for a given senderId
.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSuppressionResponse> getSuppression(GetSuppressionRequest request, AsyncHandler<GetSuppressionRequest,GetSuppressionResponse> handler)
Gets the details of a suppressed recipient email address for a given
suppressionId
. Each suppression is given a unique OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSendersResponse> listSenders(ListSendersRequest request, AsyncHandler<ListSendersRequest,ListSendersResponse> handler)
Gets a collection of approved sender email addresses and sender IDs.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSuppressionsResponse> listSuppressions(ListSuppressionsRequest request, AsyncHandler<ListSuppressionsRequest,ListSuppressionsResponse> handler)
Gets a list of suppressed recipient email addresses for a user. The
compartmentId
for suppressions must be a tenancy OCID. The returned list
is sorted by creation time in descending order.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateSenderResponse> updateSender(UpdateSenderRequest request, AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler)
Replaces the set of tags for a sender with the tags provided. If either freeform or defined tags are omitted, the tags for that set remain the same. Each set must include the full set of tags for the sender, partial updates are not permitted. For more information about tagging, see Resource Tags.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.