All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EmailClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public interface Email
extends AutoCloseable
```
Use the Email Delivery API to do the necessary set up to send high-volume and application-generated emails through the OCI Email Delivery service.
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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AddEmailDomainLockResponse`	`addEmailDomainLock(AddEmailDomainLockRequest request)`	Adds a lock to a resource.
`AddReturnPathLockResponse`	`addReturnPathLock(AddReturnPathLockRequest request)`	Adds a lock to a resource.
`AddSenderLockResponse`	`addSenderLock(AddSenderLockRequest request)`	Adds a lock to a resource.
`ChangeEmailDomainCompartmentResponse`	`changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request)`	Moves an email domain into a different compartment.
`ChangeSenderCompartmentResponse`	`changeSenderCompartment(ChangeSenderCompartmentRequest request)`	Moves a sender into a different compartment.
`CreateDkimResponse`	`createDkim(CreateDkimRequest request)`	Creates a new DKIM for an email domain.
`CreateEmailDomainResponse`	`createEmailDomain(CreateEmailDomainRequest request)`	Creates a new email domain.
`CreateEmailReturnPathResponse`	`createEmailReturnPath(CreateEmailReturnPathRequest request)`	Creates a new email return path.
`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.
`DeleteDkimResponse`	`deleteDkim(DeleteDkimRequest request)`	Deletes a DKIM.
`DeleteEmailDomainResponse`	`deleteEmailDomain(DeleteEmailDomainRequest request)`	Deletes an email domain.
`DeleteEmailReturnPathResponse`	`deleteEmailReturnPath(DeleteEmailReturnPathRequest request)`	Deletes an email return path.
`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`.
`GetDkimResponse`	`getDkim(GetDkimRequest request)`	Retrieves the specified DKIM.
`GetEmailConfigurationResponse`	`getEmailConfiguration(GetEmailConfigurationRequest request)`	Returns email configuration associated with the specified compartment.
`GetEmailDomainResponse`	`getEmailDomain(GetEmailDomainRequest request)`	Retrieves the specified email domain.
`GetEmailReturnPathResponse`	`getEmailReturnPath(GetEmailReturnPathRequest request)`	Retrieves the specified email return path.
`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.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets the status of the work request with the given ID.
`ListDkimsResponse`	`listDkims(ListDkimsRequest request)`	Lists DKIMs for an email domain.
`ListEmailDomainsResponse`	`listEmailDomains(ListEmailDomainsRequest request)`	Lists email domains in the specified compartment.
`ListEmailReturnPathsResponse`	`listEmailReturnPaths(ListEmailReturnPathsRequest request)`	Lists email return paths in the specified compartment or emaildomain.
`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.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Return a (paginated) list of errors for a given work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Return a (paginated) list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the work requests in a compartment.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`RemoveEmailDomainLockResponse`	`removeEmailDomainLock(RemoveEmailDomainLockRequest request)`	Remove a lock to a resource.
`RemoveReturnPathLockResponse`	`removeReturnPathLock(RemoveReturnPathLockRequest request)`	Remove a lock to a resource.
`RemoveSenderLockResponse`	`removeSenderLock(RemoveSenderLockRequest request)`	Remove a lock to a resource.
`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’).
`UpdateDkimResponse`	`updateDkim(UpdateDkimRequest request)`	Modifies a DKIM.
`UpdateEmailDomainResponse`	`updateEmailDomain(UpdateEmailDomainRequest request)`	Modifies an email domain.
`UpdateEmailReturnPathResponse`	`updateEmailReturnPath(UpdateEmailReturnPathRequest request)`	Modifies an email return path.
`UpdateSenderResponse`	`updateSender(UpdateSenderRequest request)`	Replaces the set of tags for a sender with the tags provided.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch.
    Useful to refresh certificates.
  - 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.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not.
    Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - addEmailDomainLock
```
AddEmailDomainLockResponse addEmailDomainLock(AddEmailDomainLockRequest request)
```
    Adds a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/AddEmailDomainLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddEmailDomainLock API.
  - addReturnPathLock
```
AddReturnPathLockResponse addReturnPathLock(AddReturnPathLockRequest request)
```
    Adds a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/AddReturnPathLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddReturnPathLock API.
  - addSenderLock
```
AddSenderLockResponse addSenderLock(AddSenderLockRequest request)
```
    Adds a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/AddSenderLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddSenderLock API.
  - changeEmailDomainCompartment
```
ChangeEmailDomainCompartmentResponse changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request)
```
    Moves an email domain into a different compartment.
    When provided, If-Match is checked against ETag value of the resource. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    *Note:** All DKIM objects associated with this email domain will also be moved into the provided 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ChangeEmailDomainCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeEmailDomainCompartment API.
  - 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ChangeSenderCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeSenderCompartment API.
  - createDkim
```
CreateDkimResponse createDkim(CreateDkimRequest request)
```
    Creates a new DKIM for an email domain.
    This DKIM signs all approved senders in the tenancy that are in this email domain. Best security practices indicate to periodically rotate the DKIM that is doing the signing. When a second DKIM is applied, all senders seamlessly pick up the new key without interruption in signing.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/CreateDkimExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDkim API.
  - createEmailDomain
```
CreateEmailDomainResponse createEmailDomain(CreateEmailDomainRequest request)
```
    Creates a new email domain.
    Avoid entering confidential information.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/CreateEmailDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEmailDomain API.
  - createEmailReturnPath
```
CreateEmailReturnPathResponse createEmailReturnPath(CreateEmailReturnPathRequest request)
```
    Creates a new email return path.
    Avoid entering confidential information.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/CreateEmailReturnPathExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEmailReturnPath 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/CreateSenderExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/CreateSuppressionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSuppression API.
  - deleteDkim
```
DeleteDkimResponse deleteDkim(DeleteDkimRequest request)
```
    Deletes a DKIM.
    If this key is currently the active key for the email domain, deleting the key will stop signing the domain’s outgoing mail. DKIM keys are left in DELETING state for about a day to allow DKIM signatures on in-transit mail to be validated. Consider creating a new DKIM for this domain so the signing can be rotated to it instead of deletion.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/DeleteDkimExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDkim API.
  - deleteEmailDomain
```
DeleteEmailDomainResponse deleteEmailDomain(DeleteEmailDomainRequest request)
```
    Deletes an email domain.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/DeleteEmailDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEmailDomain API.
  - deleteEmailReturnPath
```
DeleteEmailReturnPathResponse deleteEmailReturnPath(DeleteEmailReturnPathRequest request)
```
    Deletes an email return path.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/DeleteEmailReturnPathExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEmailReturnPath 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/DeleteSenderExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/DeleteSuppressionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSuppression API.
  - getDkim
```
GetDkimResponse getDkim(GetDkimRequest request)
```
    Retrieves the specified DKIM.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetDkimExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDkim API.
  - getEmailConfiguration
```
GetEmailConfigurationResponse getEmailConfiguration(GetEmailConfigurationRequest request)
```
    Returns email configuration associated with the specified 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetEmailConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEmailConfiguration API.
  - getEmailDomain
```
GetEmailDomainResponse getEmailDomain(GetEmailDomainRequest request)
```
    Retrieves the specified email domain.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetEmailDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEmailDomain API.
  - getEmailReturnPath
```
GetEmailReturnPathResponse getEmailReturnPath(GetEmailReturnPathRequest request)
```
    Retrieves the specified email return path.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetEmailReturnPathExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEmailReturnPath 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetSenderExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetSuppressionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSuppression API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Gets the status of the work request with the given ID.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
  - listDkims
```
ListDkimsResponse listDkims(ListDkimsRequest request)
```
    Lists DKIMs for an email domain.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListDkimsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDkims API.
  - listEmailDomains
```
ListEmailDomainsResponse listEmailDomains(ListEmailDomainsRequest request)
```
    Lists email domains in the specified 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListEmailDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEmailDomains API.
  - listEmailReturnPaths
```
ListEmailReturnPathsResponse listEmailReturnPaths(ListEmailReturnPathsRequest request)
```
    Lists email return paths in the specified compartment or emaildomain.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListEmailReturnPathsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEmailReturnPaths 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListSendersExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListSuppressionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSuppressions API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Return a (paginated) list of errors for a given work request.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Return a (paginated) list of logs for a given work request.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the work requests in a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
  - removeEmailDomainLock
```
RemoveEmailDomainLockResponse removeEmailDomainLock(RemoveEmailDomainLockRequest request)
```
    Remove a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/RemoveEmailDomainLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveEmailDomainLock API.
  - removeReturnPathLock
```
RemoveReturnPathLockResponse removeReturnPathLock(RemoveReturnPathLockRequest request)
```
    Remove a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/RemoveReturnPathLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveReturnPathLock API.
  - removeSenderLock
```
RemoveSenderLockResponse removeSenderLock(RemoveSenderLockRequest request)
```
    Remove a lock to a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/RemoveSenderLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveSenderLock API.
  - updateDkim
```
UpdateDkimResponse updateDkim(UpdateDkimRequest request)
```
    Modifies a DKIM.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/UpdateDkimExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDkim API.
  - updateEmailDomain
```
UpdateEmailDomainResponse updateEmailDomain(UpdateEmailDomainRequest request)
```
    Modifies an email domain.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/UpdateEmailDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEmailDomain API.
  - updateEmailReturnPath
```
UpdateEmailReturnPathResponse updateEmailReturnPath(UpdateEmailReturnPathRequest request)
```
    Modifies an email return path.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/UpdateEmailReturnPathExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEmailReturnPath 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/email/UpdateSenderExample.java.html"target=”_blank"rel=“noopener noreferrer”>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.

Interface Email

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

addEmailDomainLock

addReturnPathLock

addSenderLock

changeEmailDomainCompartment

changeSenderCompartment

createDkim

createEmailDomain

createEmailReturnPath

createSender

createSuppression

deleteDkim

deleteEmailDomain

deleteEmailReturnPath

deleteSender

deleteSuppression

getDkim

getEmailConfiguration

getEmailDomain

getEmailReturnPath

getSender

getSuppression

getWorkRequest

listDkims

listEmailDomains

listEmailReturnPaths

listSenders

listSuppressions

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

removeEmailDomainLock

removeReturnPathLock

removeSenderLock

updateDkim

updateEmailDomain

updateEmailReturnPath

updateSender

getWaiters

getPaginators