Get the endpoint that is being used to call (ex, https://www.example.com).
Sets the endpoint to call (ex, https://www.example.com).
The endpoint of the service.
Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
The region of the service.
Sets the regionId to call (ex, 'us-phoenix-1').
Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.
The public region ID.
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"
flag to enable the use of realm specific endpoint template
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.
This operation does not retry by default if the user has not defined a retry configuration.
ChangeEmailDomainCompartmentResponse
Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation does not retry by default if the user has not defined a retry configuration.
ChangeSenderCompartmentResponse
Close the client once it is no longer needed
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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateDkimResponse
Creates a new email domain. Avoid entering confidential information. This operation does not retry by default if the user has not defined a retry configuration.
CreateEmailDomainResponse
Creates a sender for a tenancy in a given compartment. This operation does not retry by default if the user has not defined a retry configuration.
CreateSenderResponse
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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateSuppressionResponse
Creates a new EmailWaiter for resources for this service.
The waiter configuration for termination and delay strategy
The service waiters.
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.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteDkimResponse
Deletes an email domain. This operation does not retry by default if the user has not defined a retry configuration.
DeleteEmailDomainResponse
Deletes an approved sender for a tenancy in a given compartment for a
provided senderId.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteSenderResponse
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided suppressionId.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteSuppressionResponse
Retrieves the specified DKIM. This operation does not retry by default if the user has not defined a retry configuration.
GetDkimResponse
Returns email configuration associated with the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
GetEmailConfigurationResponse
Retrieves the specified email domain. This operation does not retry by default if the user has not defined a retry configuration.
GetEmailDomainResponse
Gets an approved sender for a given senderId.
This operation does not retry by default if the user has not defined a retry configuration.
GetSenderResponse
Gets the details of a suppressed recipient email address for a given
suppressionId. Each suppression is given a unique OCID.
This operation does not retry by default if the user has not defined a retry configuration.
GetSuppressionResponse
Gets the waiters available for resources for this service.
The service waiters.
Gets the status of the work request with the given ID. This operation does not retry by default if the user has not defined a retry configuration.
GetWorkRequestResponse
NOTE: This function is deprecated in favor of listSendersRecordIterator function. Creates a new async iterator which will iterate over the models.SenderSummary objects contained in responses from the listSenders operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listSendersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSenders operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listSuppressionsRecordIterator function. Creates a new async iterator which will iterate over the models.SuppressionSummary objects contained in responses from the listSuppressions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listSuppressionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSuppressions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists DKIMs for an email domain. This operation does not retry by default if the user has not defined a retry configuration.
ListDkimsResponse
Lists email domains in the specified compartment. This operation does not retry by default if the user has not defined a retry configuration.
ListEmailDomainsResponse
Gets a collection of approved sender email addresses and sender IDs.
This operation does not retry by default if the user has not defined a retry configuration.
ListSendersResponse
Creates a new async iterator which will iterate over the models.SenderSummary objects contained in responses from the listSenders operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listSenders operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
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.
This operation does not retry by default if the user has not defined a retry configuration.
ListSuppressionsResponse
Creates a new async iterator which will iterate over the models.SuppressionSummary objects contained in responses from the listSuppressions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listSuppressions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Return a (paginated) list of errors for a given work request.
This operation does not retry by default if the user has not defined a retry configuration.
ListWorkRequestErrorsResponse
Return a (paginated) list of logs for a given work request.
This operation does not retry by default if the user has not defined a retry configuration.
ListWorkRequestLogsResponse
Lists the work requests in a compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListWorkRequestsResponse
Shutdown the circuit breaker used by the client when it is no longer needed
Modifies a DKIM. This operation does not retry by default if the user has not defined a retry configuration.
UpdateDkimResponse
Modifies an email domain. This operation does not retry by default if the user has not defined a retry configuration.
UpdateEmailDomainResponse
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.
This operation does not retry by default if the user has not defined a retry configuration.
UpdateSenderResponse
This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.