com.oracle.bmc.email

Interface Email

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EmailClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public interface Email
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.

Method Summary

Modifier and Type	Method and Description
ChangeSenderCompartmentResponse	changeSenderCompartment(ChangeSenderCompartmentRequest request) Moves a sender into a different compartment.
CreateSenderResponse	createSender(CreateSenderRequest request) Creates a sender for a tenancy in a given compartment.
CreateSuppressionResponse	createSuppression(CreateSuppressionRequest request) Adds recipient email addresses to the suppression list for a tenancy.
DeleteSenderResponse	deleteSender(DeleteSenderRequest request) Deletes an approved sender for a tenancy in a given compartment for a provided senderId.
DeleteSuppressionResponse	deleteSuppression(DeleteSuppressionRequest request) 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)
EmailPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSenderResponse	getSender(GetSenderRequest request) Gets an approved sender for a given senderId.
GetSuppressionResponse	getSuppression(GetSuppressionRequest request) Gets the details of a suppressed recipient email address for a given suppressionId.
EmailWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListSendersResponse	listSenders(ListSendersRequest request) Gets a collection of approved sender email addresses and sender IDs.
ListSuppressionsResponse	listSuppressions(ListSuppressionsRequest request) 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’).
UpdateSenderResponse	updateSender(UpdateSenderRequest request) Replaces the set of tags for a sender with the tags provided.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

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.

Parameters:

region - The region of the service.

setRegion

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.

Parameters:

regionId - The public region ID.

changeSenderCompartment

ChangeSenderCompartmentResponse changeSenderCompartment(ChangeSenderCompartmentRequest request)

Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeSenderCompartment API.

createSender

CreateSenderResponse createSender(CreateSenderRequest request)

Creates a sender for a tenancy in a given compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateSender API.

createSuppression

CreateSuppressionResponse createSuppression(CreateSuppressionRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateSuppression API.

deleteSender

DeleteSenderResponse deleteSender(DeleteSenderRequest request)

Deletes an approved sender for a tenancy in a given compartment for a provided senderId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteSender API.

deleteSuppression

DeleteSuppressionResponse deleteSuppression(DeleteSuppressionRequest request)

Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided suppressionId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteSuppression API.

getSender

GetSenderResponse getSender(GetSenderRequest request)

Gets an approved sender for a given senderId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetSender API.

getSuppression

GetSuppressionResponse getSuppression(GetSuppressionRequest request)

Gets the details of a suppressed recipient email address for a given suppressionId. Each suppression is given a unique OCID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetSuppression API.

listSenders

ListSendersResponse listSenders(ListSendersRequest request)

Gets a collection of approved sender email addresses and sender IDs.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListSenders API.

listSuppressions

ListSuppressionsResponse listSuppressions(ListSuppressionsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListSuppressions API.

updateSender

UpdateSenderResponse updateSender(UpdateSenderRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateSender API.

getWaiters

EmailWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

EmailPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.