Email Functions

CHANGE_EMAIL_DOMAIN_COMPARTMENT Function

Moves a 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.

Syntax

FUNCTION change_email_domain_compartment (
  email_domain_id varchar2,
  change_email_domain_compartment_details dbms_cloud_oci_email_change_email_domain_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_change_email_domain_compartment_response_t;

Parameters

Parameter	Description
`email_domain_id`	(required) The OCID of this email domain.
`change_email_domain_compartment_details`	(required) The configuration details for the move operation.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SENDER_COMPARTMENT Function

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

Syntax

FUNCTION change_sender_compartment (
  sender_id varchar2,
  change_sender_compartment_details dbms_cloud_oci_email_change_sender_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_change_sender_compartment_response_t;

Parameters

Parameter	Description
`sender_id`	(required) The unique OCID of the sender.
`change_sender_compartment_details`	(required) Details for moving a sender into a different compartment.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DKIM Function

Creates a new DKIM for a email domain. This DKIM will sign 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 will seamlessly pick up the new key without interruption in signing.

Syntax

FUNCTION create_dkim (
  create_dkim_details dbms_cloud_oci_email_create_dkim_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_create_dkim_response_t;

Parameters

Parameter	Description
`create_dkim_details`	(required) The DKIM details.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EMAIL_DOMAIN Function

Creates a new email domain. Avoid entering confidential information.

Syntax

FUNCTION create_email_domain (
  create_email_domain_details dbms_cloud_oci_email_create_email_domain_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_create_email_domain_response_t;

Parameters

Parameter	Description
`create_email_domain_details`	(required) The email domain to create.
`opc_request_id`	(optional) The request ID for tracing from the system
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SENDER Function

Creates a sender for a tenancy in a given compartment.

Syntax

FUNCTION create_sender (
  create_sender_details dbms_cloud_oci_email_create_sender_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_create_sender_response_t;

Parameters

Parameter	Description
`create_sender_details`	(required) Create a sender.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SUPPRESSION Function

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.

Syntax

FUNCTION create_suppression (
  create_suppression_details dbms_cloud_oci_email_create_suppression_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_create_suppression_response_t;

Parameters

Parameter	Description
`create_suppression_details`	(required) Adds a single email address to the suppression list for a compartment's tenancy.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DKIM Function

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 instead of deletion creating a new DKIM for this domain so the signing can be rotated to it.

Syntax

FUNCTION delete_dkim (
  dkim_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_delete_dkim_response_t;

Parameters

Parameter	Description
`dkim_id`	(required) The OCID of this DKIM.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EMAIL_DOMAIN Function

Deletes a email domain.

Syntax

FUNCTION delete_email_domain (
  email_domain_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_delete_email_domain_response_t;

Parameters

Parameter	Description
`email_domain_id`	(required) The OCID of this email domain.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SENDER Function

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

Syntax

FUNCTION delete_sender (
  sender_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_delete_sender_response_t;

Parameters

Parameter	Description
`sender_id`	(required) The unique OCID of the sender.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SUPPRESSION Function

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

Syntax

FUNCTION delete_suppression (
  suppression_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_delete_suppression_response_t;

Parameters

Parameter	Description
`suppression_id`	(required) The unique OCID of the suppression.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DKIM Function

Retrieves the specified DKIM.

Syntax

FUNCTION get_dkim (
  dkim_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_get_dkim_response_t;

Parameters

Parameter	Description
`dkim_id`	(required) The OCID of this DKIM.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EMAIL_DOMAIN Function

Retrieves the specified email domain.

Syntax

FUNCTION get_email_domain (
  email_domain_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_get_email_domain_response_t;

Parameters

Parameter	Description
`email_domain_id`	(required) The OCID of this email domain.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SENDER Function

Gets an approved sender for a given `senderId`.

Syntax

FUNCTION get_sender (
  sender_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_get_sender_response_t;

Parameters

Parameter	Description
`sender_id`	(required) The unique OCID of the sender.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SUPPRESSION Function

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

Syntax

FUNCTION get_suppression (
  suppression_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_get_suppression_response_t;

Parameters

Parameter	Description
`suppression_id`	(required) The unique OCID of the suppression.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

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

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DKIMS Function

Lists DKIMs for a email domain.

Syntax

FUNCTION list_dkims (
  email_domain_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_dkims_response_t;

Parameters

Parameter	Description
`email_domain_id`	(required) The OCID of the email domain to which this DKIM belongs.
`opc_request_id`	(optional) The request ID for tracing from the system
`id`	(optional) A filter to only return resources that match the given id exactly.
`name`	(optional) A filter to only return resources that match the given name exactly.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending or descending order. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) Filter returned list by specified lifecycle state. This parameter is case-insensitive.
`sort_by`	(optional) Specifies the attribute with which to sort the DKIMs. Default: `TIMECREATED` * TIMECREATED: Sorts by timeCreated. * NAME: Sorts by name. * ID: Sorts by id. Allowed values are: 'TIMECREATED', 'ID', 'NAME'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EMAIL_DOMAINS Function

Lists email domains in the specified compartment.

Syntax

FUNCTION list_email_domains (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_email_domains_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID for the compartment.
`opc_request_id`	(optional) The request ID for tracing from the system
`id`	(optional) A filter to only return resources that match the given id exactly.
`name`	(optional) A filter to only return resources that match the given name exactly.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending or descending order. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) Filter returned list by specified lifecycle state. This parameter is case-insensitive.
`sort_by`	(optional) Specifies the attribute with which to sort the email domains. Default: `TIMECREATED` * TIMECREATED: Sorts by timeCreated. * NAME: Sorts by name. * ID: Sorts by id. Allowed values are: 'TIMECREATED', 'ID', 'NAME'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENDERS Function

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

Syntax

FUNCTION list_senders (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  domain varchar2 DEFAULT NULL,
  email_address varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_senders_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID for the compartment.
`opc_request_id`	(optional) The request ID for tracing from the system
`lifecycle_state`	(optional) The current state of a sender.
`domain`	(optional) A filter to only return resources that match the given domain exactly.
`email_address`	(optional) The email address of the approved sender.
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The field to sort by. The `TIMECREATED` value returns the list in in descending order by default. The `EMAILADDRESS` value returns the list in ascending order by default. Use the `SortOrderQueryParam` to change the direction of the returned list of items. Allowed values are: 'TIMECREATED', 'EMAILADDRESS'
`sort_order`	(optional) The sort order to use, either ascending or descending order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SUPPRESSIONS Function

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.

Syntax

FUNCTION list_suppressions (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  email_address varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_suppressions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID for the compartment.
`opc_request_id`	(optional) The request ID for tracing from the system
`email_address`	(optional) The email address of the suppression.
`time_created_greater_than_or_equal_to`	(optional) Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding `timeCreatedLessThan` parameter will retrieve suppressions created from the given `timeCreatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all suppressions created before the specified end date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The field to sort by. The `TIMECREATED` value returns the list in in descending order by default. The `EMAILADDRESS` value returns the list in ascending order by default. Use the `SortOrderQueryParam` to change the direction of the returned list of items. Allowed values are: 'TIMECREATED', 'EMAILADDRESS'
`sort_order`	(optional) The sort order to use, either ascending or descending order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

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

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The request ID for tracing from the system
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

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

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The request ID for tracing from the system
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID for the compartment.
`work_request_id`	(optional) The ID of the asynchronous work request.
`opc_request_id`	(optional) The request ID for tracing from the system
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DKIM Function

Modifies a DKIM.

Syntax

FUNCTION update_dkim (
  dkim_id varchar2,
  update_dkim_details dbms_cloud_oci_email_update_dkim_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_update_dkim_response_t;

Parameters

Parameter	Description
`dkim_id`	(required) The OCID of this DKIM.
`update_dkim_details`	(required) The new DKIM attributes to apply.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EMAIL_DOMAIN Function

Modifies a email domain.

Syntax

FUNCTION update_email_domain (
  email_domain_id varchar2,
  update_email_domain_details dbms_cloud_oci_email_update_email_domain_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_update_email_domain_response_t;

Parameters

Parameter	Description
`email_domain_id`	(required) The OCID of this email domain.
`update_email_domain_details`	(required) The new email domain attributes to apply.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SENDER Function

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.

Syntax

FUNCTION update_sender (
  sender_id varchar2,
  update_sender_details dbms_cloud_oci_email_update_sender_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_em_email_update_sender_response_t;

Parameters

Parameter	Description
`sender_id`	(required) The unique OCID of the sender.
`update_sender_details`	(required) update details for sender.
`if_match`	(optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The request ID for tracing from the system
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://ctrl.email.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_EMAIL_DOMAIN_COMPARTMENT Function 🔗

CHANGE_SENDER_COMPARTMENT Function 🔗

CREATE_DKIM Function 🔗

CREATE_EMAIL_DOMAIN Function 🔗

CREATE_SENDER Function 🔗

CREATE_SUPPRESSION Function 🔗

DELETE_DKIM Function 🔗

DELETE_EMAIL_DOMAIN Function 🔗

DELETE_SENDER Function 🔗

DELETE_SUPPRESSION Function 🔗

GET_DKIM Function 🔗

GET_EMAIL_DOMAIN Function 🔗

GET_SENDER Function 🔗

GET_SUPPRESSION Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_DKIMS Function 🔗

LIST_EMAIL_DOMAINS Function 🔗

LIST_SENDERS Function 🔗

LIST_SUPPRESSIONS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_DKIM Function 🔗

UPDATE_EMAIL_DOMAIN Function 🔗

UPDATE_SENDER Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_EMAIL_DOMAIN_COMPARTMENT Function

CHANGE_SENDER_COMPARTMENT Function

CREATE_DKIM Function

CREATE_EMAIL_DOMAIN Function

CREATE_SENDER Function

CREATE_SUPPRESSION Function

DELETE_DKIM Function

DELETE_EMAIL_DOMAIN Function

DELETE_SENDER Function

DELETE_SUPPRESSION Function

GET_DKIM Function

GET_EMAIL_DOMAIN Function

GET_SENDER Function

GET_SUPPRESSION Function

GET_WORK_REQUEST Function

LIST_DKIMS Function

LIST_EMAIL_DOMAINS Function

LIST_SENDERS Function

LIST_SUPPRESSIONS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_DKIM Function

UPDATE_EMAIL_DOMAIN Function

UPDATE_SENDER Function