@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public class EmailClient extends Object implements Email
Modifier and Type | Class and Description |
---|---|
static class |
EmailClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Email.
|
Modifier | Constructor and Description |
---|---|
|
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static EmailClient.Builder |
builder()
Create a builder for this client.
|
ChangeSenderCompartmentResponse |
changeSenderCompartment(ChangeSenderCompartmentRequest request)
Moves a sender into a different compartment.
|
void |
close() |
CreateSenderResponse |
createSender(CreateSenderRequest request)
Creates a sender for a tenancy in a given compartment.
|
CreateSuppressionResponse |
createSuppression(CreateSuppressionRequest request)
Adds recipient email addresses to the suppression list for a tenancy.
|
DeleteSenderResponse |
deleteSender(DeleteSenderRequest request)
Deletes an approved sender for a tenancy in a given compartment for a
provided
senderId . |
DeleteSuppressionResponse |
deleteSuppression(DeleteSuppressionRequest request)
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided
suppressionId . |
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
EmailPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
GetSenderResponse |
getSender(GetSenderRequest request)
Gets an approved sender for a given
senderId . |
GetSuppressionResponse |
getSuppression(GetSuppressionRequest request)
Gets the details of a suppressed recipient email address for a given
suppressionId . |
EmailWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListSendersResponse |
listSenders(ListSendersRequest request)
Gets a collection of approved sender email addresses and sender IDs.
|
ListSuppressionsResponse |
listSuppressions(ListSuppressionsRequest request)
Gets a list of suppressed recipient email addresses for a user.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateSenderResponse |
updateSender(UpdateSenderRequest request)
Replaces the set of tags for a sender with the tags provided.
|
public static final Service SERVICE
Service instance for Email.
public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public EmailClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected EmailClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the EmailClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static EmailClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Email
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Email
endpoint
- The endpoint of the service.public String getEndpoint()
Email
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Email
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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
.
public void close()
close
in interface AutoCloseable
public ChangeSenderCompartmentResponse changeSenderCompartment(ChangeSenderCompartmentRequest request)
Email
Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeSenderCompartment
in interface Email
request
- The request object containing the details to sendpublic CreateSenderResponse createSender(CreateSenderRequest request)
Email
Creates a sender for a tenancy in a given compartment.
createSender
in interface Email
request
- The request object containing the details to sendpublic CreateSuppressionResponse createSuppression(CreateSuppressionRequest request)
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.
createSuppression
in interface Email
request
- The request object containing the details to sendpublic DeleteSenderResponse deleteSender(DeleteSenderRequest request)
Email
Deletes an approved sender for a tenancy in a given compartment for a
provided senderId
.
deleteSender
in interface Email
request
- The request object containing the details to sendpublic DeleteSuppressionResponse deleteSuppression(DeleteSuppressionRequest request)
Email
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided suppressionId
.
deleteSuppression
in interface Email
request
- The request object containing the details to sendpublic GetSenderResponse getSender(GetSenderRequest request)
Email
Gets an approved sender for a given senderId
.
public GetSuppressionResponse getSuppression(GetSuppressionRequest request)
Email
Gets the details of a suppressed recipient email address for a given
suppressionId
. Each suppression is given a unique OCID.
getSuppression
in interface Email
request
- The request object containing the details to sendpublic ListSendersResponse listSenders(ListSendersRequest request)
Email
Gets a collection of approved sender email addresses and sender IDs.
listSenders
in interface Email
request
- The request object containing the details to sendpublic ListSuppressionsResponse listSuppressions(ListSuppressionsRequest request)
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.
listSuppressions
in interface Email
request
- The request object containing the details to sendpublic UpdateSenderResponse updateSender(UpdateSenderRequest request)
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.
updateSender
in interface Email
request
- The request object containing the details to sendpublic EmailWaiters getWaiters()
Email
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Email
public EmailPaginators getPaginators()
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.
getPaginators
in interface Email
Copyright © 2016–2021. All rights reserved.