Class EmailClient

Service client instance for Email.

Inheritance

object

ClientBase

RegionalClientBase

EmailClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.EmailService

Assembly: OCI.DotNetSDK.Email.dll

Syntax

public class EmailClient : RegionalClientBase, IDisposable

Constructors

EmailClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public EmailClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public EmailPaginators Paginators { get; }

Property Value

Type	Description
EmailPaginators

Waiters

Declaration

public EmailWaiters Waiters { get; }

Property Value

Type	Description
EmailWaiters

Methods

ChangeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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. <br/> Note: All DKIM objects associated with this email domain will also be moved into the provided compartment.

Declaration

public Task<ChangeEmailDomainCompartmentResponse> ChangeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeEmailDomainCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeEmailDomainCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeEmailDomainCompartment API.

ChangeSenderCompartment(ChangeSenderCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeSenderCompartmentResponse> ChangeSenderCompartment(ChangeSenderCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSenderCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSenderCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSenderCompartment API.

CreateDkim(CreateDkimRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<CreateDkimResponse> CreateDkim(CreateDkimRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDkimRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDkimResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDkim API.

CreateEmailDomain(CreateEmailDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new email domain. Avoid entering confidential information.

Declaration

public Task<CreateEmailDomainResponse> CreateEmailDomain(CreateEmailDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateEmailDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateEmailDomainResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEmailDomain API.

CreateEmailReturnPath(CreateEmailReturnPathRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new email return path. Avoid entering confidential information.

Declaration

public Task<CreateEmailReturnPathResponse> CreateEmailReturnPath(CreateEmailReturnPathRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateEmailReturnPathRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateEmailReturnPathResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEmailReturnPath API.

CreateSender(CreateSenderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a sender for a tenancy in a given compartment.

Declaration

public Task<CreateSenderResponse> CreateSender(CreateSenderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSenderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSenderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSender API.

CreateSuppression(CreateSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<CreateSuppressionResponse> CreateSuppression(CreateSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSuppressionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSuppressionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSuppression API.

DeleteDkim(DeleteDkimRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<DeleteDkimResponse> DeleteDkim(DeleteDkimRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDkimRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDkimResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDkim API.

DeleteEmailDomain(DeleteEmailDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an email domain.

Declaration

public Task<DeleteEmailDomainResponse> DeleteEmailDomain(DeleteEmailDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteEmailDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteEmailDomainResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteEmailDomain API.

DeleteEmailReturnPath(DeleteEmailReturnPathRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an email return path.

Declaration

public Task<DeleteEmailReturnPathResponse> DeleteEmailReturnPath(DeleteEmailReturnPathRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteEmailReturnPathRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteEmailReturnPathResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteEmailReturnPath API.

DeleteSender(DeleteSenderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an approved sender for a tenancy in a given compartment for a provided senderId.

Declaration

public Task<DeleteSenderResponse> DeleteSender(DeleteSenderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSenderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSenderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSender API.

DeleteSuppression(DeleteSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided suppressionId.

Declaration

public Task<DeleteSuppressionResponse> DeleteSuppression(DeleteSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSuppressionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSuppressionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSuppression API.

GetDkim(GetDkimRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the specified DKIM.

Declaration

public Task<GetDkimResponse> GetDkim(GetDkimRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDkimRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDkimResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDkim API.

GetEmailConfiguration(GetEmailConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns email configuration associated with the specified compartment.

Declaration

public Task<GetEmailConfigurationResponse> GetEmailConfiguration(GetEmailConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEmailConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetEmailConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetEmailConfiguration API.

GetEmailDomain(GetEmailDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the specified email domain.

Declaration

public Task<GetEmailDomainResponse> GetEmailDomain(GetEmailDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEmailDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetEmailDomainResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetEmailDomain API.

GetEmailReturnPath(GetEmailReturnPathRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the specified email return path.

Declaration

public Task<GetEmailReturnPathResponse> GetEmailReturnPath(GetEmailReturnPathRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEmailReturnPathRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetEmailReturnPathResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetEmailReturnPath API.

GetSender(GetSenderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an approved sender for a given senderId.

Declaration

public Task<GetSenderResponse> GetSender(GetSenderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSenderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSenderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSender API.

GetSuppression(GetSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a suppressed recipient email address for a given suppressionId. Each suppression is given a unique OCID.

Declaration

public Task<GetSuppressionResponse> GetSuppression(GetSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSuppressionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSuppressionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSuppression API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListDkims(ListDkimsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists DKIMs for an email domain.

Declaration

public Task<ListDkimsResponse> ListDkims(ListDkimsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDkimsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDkimsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDkims API.

ListEmailDomains(ListEmailDomainsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists email domains in the specified compartment.

Declaration

public Task<ListEmailDomainsResponse> ListEmailDomains(ListEmailDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListEmailDomainsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListEmailDomainsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListEmailDomains API.

ListEmailReturnPaths(ListEmailReturnPathsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists email return paths in the specified compartment or emaildomain.

Declaration

public Task<ListEmailReturnPathsResponse> ListEmailReturnPaths(ListEmailReturnPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListEmailReturnPathsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListEmailReturnPathsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListEmailReturnPaths API.

ListSenders(ListSendersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a collection of approved sender email addresses and sender IDs.

Declaration

public Task<ListSendersResponse> ListSenders(ListSendersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSendersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSendersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSenders API.

ListSuppressions(ListSuppressionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListSuppressionsResponse> ListSuppressions(ListSuppressionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSuppressionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSuppressionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSuppressions API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of errors for a given work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of logs for a given work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

UpdateDkim(UpdateDkimRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies a DKIM.

Declaration

public Task<UpdateDkimResponse> UpdateDkim(UpdateDkimRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDkimRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDkimResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDkim API.

UpdateEmailDomain(UpdateEmailDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies an email domain.

Declaration

public Task<UpdateEmailDomainResponse> UpdateEmailDomain(UpdateEmailDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateEmailDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateEmailDomainResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateEmailDomain API.

UpdateEmailReturnPath(UpdateEmailReturnPathRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies an email return path.

Declaration

public Task<UpdateEmailReturnPathResponse> UpdateEmailReturnPath(UpdateEmailReturnPathRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateEmailReturnPathRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateEmailReturnPathResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateEmailReturnPath API.

UpdateSender(UpdateSenderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<UpdateSenderResponse> UpdateSender(UpdateSenderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSenderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSenderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSender API.

Implements

IDisposable