java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.emaildataplane.EmailDPClient

All Implemented Interfaces:: EmailDP, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220926")
public class EmailDPClient
extends BaseSyncClient
implements EmailDP

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EmailDPClient.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 EmailDP.

Constructor Summary

Constructors
Constructor	Description
`EmailDPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`EmailDPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`EmailDPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`EmailDPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`EmailDPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`EmailDPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`EmailDPClient(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
`static EmailDPClient.Builder`	`builder()`	Create a builder for this client.
`void`	`close()`
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`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’).
`SubmitEmailResponse`	`submitEmail(SubmitEmailRequest request)`	Submits a formatted email.
`SubmitRawEmailResponse`	`submitRawEmail(SubmitRawEmailRequest request)`	Submits a raw email.
`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.emaildataplane.EmailDP
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for EmailDP.
  - 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
  - EmailDPClient
```
@Deprecated
public EmailDPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailDPClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - EmailDPClient
```
@Deprecated
public EmailDPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailDPClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - EmailDPClient
```
@Deprecated
public EmailDPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailDPClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - EmailDPClient
```
@Deprecated
public EmailDPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator,
                     RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see EmailDPClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - EmailDPClient
```
@Deprecated
public EmailDPClient(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 EmailDPClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - EmailDPClient
```
@Deprecated
public EmailDPClient(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 EmailDPClient.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)
  - EmailDPClient
```
@Deprecated
public EmailDPClient(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 EmailDPClient.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
- Method Detail
  - builder
```
public static EmailDPClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: EmailDP
    
    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 EmailDP
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: EmailDP
    
    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 EmailDP
    
    Parameters:
    
    regionId - The public region ID.
  - submitEmail
```
public SubmitEmailResponse submitEmail(SubmitEmailRequest request)
```
    Description copied from interface: EmailDP
    
    Submits a formatted email.
    
    Specified by:
    
    submitEmail in interface EmailDP
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - submitRawEmail
```
public SubmitRawEmailResponse submitRawEmail(SubmitRawEmailRequest request)
```
    Description copied from interface: EmailDP
    
    Submits a raw email.
    Note: This operation consumes a stream.
    If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.
    Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.
    If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.
    If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.
    The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.
    
    Specified by:
    
    submitRawEmail in interface EmailDP
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - 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
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - 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 EmailDPClient

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.emaildataplane.EmailDP

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

EmailDPClient

EmailDPClient

EmailDPClient

EmailDPClient

EmailDPClient

EmailDPClient

EmailDPClient

Method Detail

builder

setRegion

setRegion

submitEmail

submitRawEmail

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient