java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.email.EmailClient

All Implemented Interfaces:: Email, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public class EmailClient
extends BaseSyncClient
implements Email

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EmailClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for Email.

Constructor Summary

Constructors
Constructor	Description
`EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static EmailClient.Builder`	`builder()`	Create a builder for this client.
`ChangeEmailDomainCompartmentResponse`	`changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request)`	Moves an email domain into a different compartment.
`ChangeSenderCompartmentResponse`	`changeSenderCompartment(ChangeSenderCompartmentRequest request)`	Moves a sender into a different compartment.
`void`	`close()`
`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`.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`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()`
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`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`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`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)`
`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’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`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 useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.email.Email
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Email.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - EmailClient
```
@Deprecated
public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - EmailClient
```
@Deprecated
public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - EmailClient
```
@Deprecated
public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - EmailClient
```
@Deprecated
public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - EmailClient
```
@Deprecated
public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - EmailClient
```
@Deprecated
public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - EmailClient
```
@Deprecated
public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - EmailClient
```
@Deprecated
public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint,
                   ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - EmailClient.Builder.executorService
- Method Detail
  - builder
```
public static EmailClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    setRegion in interface Email
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    setRegion in interface Email
    
    Parameters:
    
    regionId - The public region ID.
  - addEmailDomainLock
```
public AddEmailDomainLockResponse addEmailDomainLock(AddEmailDomainLockRequest request)
```
    Description copied from interface: Email
    
    Adds a lock to a resource.
    
    Specified by:
    
    addEmailDomainLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addReturnPathLock
```
public AddReturnPathLockResponse addReturnPathLock(AddReturnPathLockRequest request)
```
    Description copied from interface: Email
    
    Adds a lock to a resource.
    
    Specified by:
    
    addReturnPathLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addSenderLock
```
public AddSenderLockResponse addSenderLock(AddSenderLockRequest request)
```
    Description copied from interface: Email
    
    Adds a lock to a resource.
    
    Specified by:
    
    addSenderLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeEmailDomainCompartment
```
public ChangeEmailDomainCompartmentResponse changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    changeEmailDomainCompartment in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeSenderCompartment
```
public ChangeSenderCompartmentResponse changeSenderCompartment(ChangeSenderCompartmentRequest request)
```
    Description copied from interface: Email
    
    Moves a sender into a different compartment.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeSenderCompartment in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDkim
```
public CreateDkimResponse createDkim(CreateDkimRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    createDkim in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createEmailDomain
```
public CreateEmailDomainResponse createEmailDomain(CreateEmailDomainRequest request)
```
    Description copied from interface: Email
    
    Creates a new email domain.
    Avoid entering confidential information.
    
    Specified by:
    
    createEmailDomain in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createEmailReturnPath
```
public CreateEmailReturnPathResponse createEmailReturnPath(CreateEmailReturnPathRequest request)
```
    Description copied from interface: Email
    
    Creates a new email return path.
    Avoid entering confidential information.
    
    Specified by:
    
    createEmailReturnPath in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSender
```
public CreateSenderResponse createSender(CreateSenderRequest request)
```
    Description copied from interface: Email
    
    Creates a sender for a tenancy in a given compartment.
    
    Specified by:
    
    createSender in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSuppression
```
public CreateSuppressionResponse createSuppression(CreateSuppressionRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    createSuppression in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDkim
```
public DeleteDkimResponse deleteDkim(DeleteDkimRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    deleteDkim in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteEmailDomain
```
public DeleteEmailDomainResponse deleteEmailDomain(DeleteEmailDomainRequest request)
```
    Description copied from interface: Email
    
    Deletes an email domain.
    
    Specified by:
    
    deleteEmailDomain in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteEmailReturnPath
```
public DeleteEmailReturnPathResponse deleteEmailReturnPath(DeleteEmailReturnPathRequest request)
```
    Description copied from interface: Email
    
    Deletes an email return path.
    
    Specified by:
    
    deleteEmailReturnPath in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSender
```
public DeleteSenderResponse deleteSender(DeleteSenderRequest request)
```
    Description copied from interface: Email
    
    Deletes an approved sender for a tenancy in a given compartment for a provided senderId.
    
    Specified by:
    
    deleteSender in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSuppression
```
public DeleteSuppressionResponse deleteSuppression(DeleteSuppressionRequest request)
```
    Description copied from interface: Email
    
    Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided suppressionId.
    
    Specified by:
    
    deleteSuppression in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDkim
```
public GetDkimResponse getDkim(GetDkimRequest request)
```
    Description copied from interface: Email
    
    Retrieves the specified DKIM.
    
    Specified by:
    
    getDkim in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getEmailConfiguration
```
public GetEmailConfigurationResponse getEmailConfiguration(GetEmailConfigurationRequest request)
```
    Description copied from interface: Email
    
    Returns email configuration associated with the specified compartment.
    
    Specified by:
    
    getEmailConfiguration in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getEmailDomain
```
public GetEmailDomainResponse getEmailDomain(GetEmailDomainRequest request)
```
    Description copied from interface: Email
    
    Retrieves the specified email domain.
    
    Specified by:
    
    getEmailDomain in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getEmailReturnPath
```
public GetEmailReturnPathResponse getEmailReturnPath(GetEmailReturnPathRequest request)
```
    Description copied from interface: Email
    
    Retrieves the specified email return path.
    
    Specified by:
    
    getEmailReturnPath in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSender
```
public GetSenderResponse getSender(GetSenderRequest request)
```
    Description copied from interface: Email
    
    Gets an approved sender for a given senderId.
    
    Specified by:
    
    getSender in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSuppression
```
public GetSuppressionResponse getSuppression(GetSuppressionRequest request)
```
    Description copied from interface: Email
    
    Gets the details of a suppressed recipient email address for a given suppressionId.
    Each suppression is given a unique OCID.
    
    Specified by:
    
    getSuppression in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: Email
    
    Gets the status of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDkims
```
public ListDkimsResponse listDkims(ListDkimsRequest request)
```
    Description copied from interface: Email
    
    Lists DKIMs for an email domain.
    
    Specified by:
    
    listDkims in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listEmailDomains
```
public ListEmailDomainsResponse listEmailDomains(ListEmailDomainsRequest request)
```
    Description copied from interface: Email
    
    Lists email domains in the specified compartment.
    
    Specified by:
    
    listEmailDomains in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listEmailReturnPaths
```
public ListEmailReturnPathsResponse listEmailReturnPaths(ListEmailReturnPathsRequest request)
```
    Description copied from interface: Email
    
    Lists email return paths in the specified compartment or emaildomain.
    
    Specified by:
    
    listEmailReturnPaths in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSenders
```
public ListSendersResponse listSenders(ListSendersRequest request)
```
    Description copied from interface: Email
    
    Gets a collection of approved sender email addresses and sender IDs.
    
    Specified by:
    
    listSenders in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSuppressions
```
public ListSuppressionsResponse listSuppressions(ListSuppressionsRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    listSuppressions in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: Email
    
    Return a (paginated) list of errors for a given work request.
    
    Specified by:
    
    listWorkRequestErrors in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: Email
    
    Return a (paginated) list of logs for a given work request.
    
    Specified by:
    
    listWorkRequestLogs in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: Email
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeEmailDomainLock
```
public RemoveEmailDomainLockResponse removeEmailDomainLock(RemoveEmailDomainLockRequest request)
```
    Description copied from interface: Email
    
    Remove a lock to a resource.
    
    Specified by:
    
    removeEmailDomainLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeReturnPathLock
```
public RemoveReturnPathLockResponse removeReturnPathLock(RemoveReturnPathLockRequest request)
```
    Description copied from interface: Email
    
    Remove a lock to a resource.
    
    Specified by:
    
    removeReturnPathLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeSenderLock
```
public RemoveSenderLockResponse removeSenderLock(RemoveSenderLockRequest request)
```
    Description copied from interface: Email
    
    Remove a lock to a resource.
    
    Specified by:
    
    removeSenderLock in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDkim
```
public UpdateDkimResponse updateDkim(UpdateDkimRequest request)
```
    Description copied from interface: Email
    
    Modifies a DKIM.
    
    Specified by:
    
    updateDkim in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateEmailDomain
```
public UpdateEmailDomainResponse updateEmailDomain(UpdateEmailDomainRequest request)
```
    Description copied from interface: Email
    
    Modifies an email domain.
    
    Specified by:
    
    updateEmailDomain in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateEmailReturnPath
```
public UpdateEmailReturnPathResponse updateEmailReturnPath(UpdateEmailReturnPathRequest request)
```
    Description copied from interface: Email
    
    Modifies an email return path.
    
    Specified by:
    
    updateEmailReturnPath in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateSender
```
public UpdateSenderResponse updateSender(UpdateSenderRequest request)
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    updateSender in interface Email
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public EmailWaiters getWaiters()
```
    Description copied from interface: Email
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface Email
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public EmailPaginators getPaginators()
```
    Description copied from interface: Email
    
    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.
    
    Specified by:
    
    getPaginators in interface Email
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class EmailClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.email.Email

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

EmailClient

EmailClient

EmailClient

EmailClient

EmailClient

EmailClient

EmailClient

EmailClient

Method Detail

builder

setRegion

setRegion

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

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient