@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public interface Email extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
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 . |
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.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.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.CreateSenderResponse createSender(CreateSenderRequest request)
Creates a sender for a tenancy in a given compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteSenderResponse deleteSender(DeleteSenderRequest request)
Deletes an approved sender for a tenancy in a given compartment for a provided senderId
.
request
- The request object containing the details to sendBmcException
- when an error occurs.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
.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetSenderResponse getSender(GetSenderRequest request)
Gets an approved sender for a given senderId
.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetSuppressionResponse getSuppression(GetSuppressionRequest request)
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 sendBmcException
- when an error occurs.ListSendersResponse listSenders(ListSendersRequest request)
Gets a collection of approved sender email addresses and sender IDs.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.EmailWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2019. All rights reserved.