Oracle Cloud Infrastructure Documentation
Try Free Tier

Email Common Types

DBMS_CLOUD_OCI_EMAIL_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_CHANGE_EMAIL_DOMAIN_COMPARTMENT_DETAILS_T Type

The configuration details for the move operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_change_email_domain_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_change_email_domain_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_change_email_domain_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the specified resource to.

DBMS_CLOUD_OCI_EMAIL_CHANGE_SENDER_COMPARTMENT_DETAILS_T Type

The OCID of the compartment into which the resource should be moved.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_change_sender_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_change_sender_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_change_sender_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the sender should be moved.

DBMS_CLOUD_OCI_EMAIL_CREATE_DKIM_DETAILS_T Type

Properties to create a new DKIM. The new object will be created in the same compartment as the EmailDomain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_create_dkim_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  email_domain_id varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_dkim_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_dkim_details_t (
    name varchar2,
    email_domain_id varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The DKIM selector. This selector is required to be globally unique for this email domain. If you do not provide the selector, we will generate one for you. If you do provide the selector, we suggest adding a short region indicator to differentiate from your signing of emails in other regions you may be subscribed to. Selectors limited to ASCII characters may use alphanumeric, dash (\"-\"), and dot (\".\") characters. Non-ASCII selector names should adopt IDNA2008 normalization (RFC 5891-5892). Avoid entering confidential information. Example: `mydomain-phx-20210228`

email_domain_id

(required) The OCID of the EmailDomain for this DKIM.

description

(optional) A string that describes the details about the DKIM. It does not have to be unique, and you can change it. Avoid entering confidential information.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_CREATE_EMAIL_DOMAIN_DETAILS_T Type

The configuration details for creating a new email domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_create_email_domain_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_email_domain_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_email_domain_details_t (
    name varchar2,
    compartment_id varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash (\"-\"), and dot (\".\") characters. The dash and dot are only allowed between alphanumeric characters. For details, please see: https://tools.ietf.org/html/rfc5321#section-4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

compartment_id

(required) The OCID of the compartment for this email domain.

description

(optional) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_CREATE_SENDER_DETAILS_T Type

The details needed for creating a sender.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_create_sender_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_sender_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_sender_details_t (
    compartment_id varchar2,
    email_address varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment that contains the sender.

email_address

(required) The email address of the sender.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_CREATE_SUPPRESSION_DETAILS_T Type

The details needed for creating a single suppression.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_create_suppression_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_suppression_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_create_suppression_details_t (
    compartment_id varchar2,
    email_address varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

email_address

(required) The recipient email address of the suppression.

DBMS_CLOUD_OCI_EMAIL_DKIM_T Type

The properties that define a DKIM.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_dkim_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  email_domain_id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  dns_subdomain_name varchar2(32767),
  cname_record_value varchar2(32767),
  txt_record_value varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_t (
    name varchar2,
    id varchar2,
    email_domain_id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    dns_subdomain_name varchar2,
    cname_record_value varchar2,
    txt_record_value varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.

id

(required) The OCID of the DKIM.

email_domain_id

(required) The OCID of the email domain that this DKIM belongs to.

compartment_id

(optional) The OCID of the compartment that contains this DKIM.

lifecycle_state

(optional) The current state of the DKIM.

Allowed values are: 'ACTIVE', 'CREATING', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE', 'NEEDS_ATTENTION', 'UPDATING'

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.

description

(optional) The description of the DKIM. Avoid entering confidential information.

time_created

(optional) The time the DKIM was created. Times are expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\". Example: `2021-02-12T22:47:12.613Z`

time_updated

(optional) The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\".

dns_subdomain_name

(optional) The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures. It is usually created with a CNAME record set to the cnameRecordValue

cname_record_value

(optional) The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).

txt_record_value

(optional) The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record. This is used in cases where a CNAME can not be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. This can also be used by customers who have an existing procedure to directly provision TXT records for DKIM. Be aware that many DNS APIs will require you to break this string into segments of less than 255 characters.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_EMAIL_DKIM_SUMMARY_T Type

The properties that define a DKIM.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_dkim_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  email_domain_id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_summary_t (
    name varchar2,
    id varchar2,
    email_domain_id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The DKIM selector. This selector is required to be globally unique for this email domain.

id

(required) The OCID of the DKIM.

email_domain_id

(required) The OCID of the email domain that this DKIM belongs to.

compartment_id

(optional) The OCID of the compartment that contains this DKIM.

lifecycle_state

(optional) The current state of the DKIM.

description

(optional) The description of a DKIM. Avoid entering confidential information.

time_created

(optional) The time the DKIM was created. Times are expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\". Example: `2021-02-12T22:47:12.613Z`

time_updated

(optional) The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\".

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_EMAIL_DKIM_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_email_dkim_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_dkim_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_dkim_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_DKIM_COLLECTION_T Type

Results of a search. Contains boh DkimSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_dkim_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_email_dkim_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_dkim_collection_t (
    items dbms_cloud_oci_email_dkim_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of dkims.

DBMS_CLOUD_OCI_EMAIL_EMAIL_DOMAIN_T Type

The properties that define a email domain. A Email Domain contains configuration used to assert responsibility for emails sent from that domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_email_domain_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  active_dkim_id varchar2(32767),
  is_spf number,
  description varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_t (
    name varchar2,
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    active_dkim_id varchar2,
    is_spf number,
    description varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the email domain in the Internet Domain Name System (DNS). Example: `example.net`

id

(required) The OCID of the email domain.

compartment_id

(optional) The OCID of the compartment that contains this email domain.

lifecycle_state

(optional) The current state of the email domain.

Allowed values are: 'ACTIVE', 'CREATING', 'DELETING', 'DELETED', 'FAILED', 'UPDATING'

active_dkim_id

(optional) The OCID of the DKIM key that will be used to sign mail sent from this email domain.

is_spf

(optional) Value of the SPF field. For more information about SPF, please see SPF Authentication.

description

(optional) The description of a email domain.

time_created

(optional) The time the email domain was created, expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\". Example: `2021-02-12T22:47:12.613Z`

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_EMAIL_EMAIL_DOMAIN_SUMMARY_T Type

The properties that define a email domain. A Email Domain contains configuration used to assert responsibility for emails sent from that domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_email_domain_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  active_dkim_id varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_summary_t (
    name varchar2,
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    active_dkim_id varchar2,
    description varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the email domain in the Internet Domain Name System (DNS). Example: `example.net`

id

(required) The OCID of the email domain.

compartment_id

(optional) The OCID of the compartment that contains this email domain.

lifecycle_state

(optional) The current state of the email domain.

active_dkim_id

(optional) The OCID of the DKIM key that is adding the DKIM signature for this email domain.

description

(optional) The description of a email domain.

time_created

(optional) The time the email domain was created, expressed in RFC 3339 timestamp format, \"YYYY-MM-ddThh:mmZ\". Example: `2021-02-12T22:47:12.613Z`

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_EMAIL_EMAIL_DOMAIN_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_email_email_domain_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_email_domain_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_email_domain_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_EMAIL_DOMAIN_COLLECTION_T Type

Results of an EmailDomain search. Contains boh EmailDomainSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_email_domain_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_email_email_domain_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_email_domain_collection_t (
    items dbms_cloud_oci_email_email_domain_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of email domains.

DBMS_CLOUD_OCI_EMAIL_ERROR_T Type

An error has occurred.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_EMAIL_SENDER_T Type

The full information representing an approved sender.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_sender_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  id varchar2(32767),
  is_spf number,
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  email_domain_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_sender_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_sender_t (
    compartment_id varchar2,
    email_address varchar2,
    id varchar2,
    is_spf number,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    email_domain_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID for the compartment.

email_address

(required) Email address of the sender.

id

(required) The unique OCID of the sender.

is_spf

(optional) Value of the SPF field. For more information about SPF, please see SPF Authentication.

lifecycle_state

(optional) The sender's current lifecycle state.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED'

time_created

(optional) The date and time the approved sender was added in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.

email_domain_id

(optional) The email domain used to assert responsibility for emails sent from this sender.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_SENDER_SUMMARY_T Type

The email addresses and `senderId` representing an approved sender.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_sender_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_sender_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_sender_summary_t (
    compartment_id varchar2,
    email_address varchar2,
    id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID for the compartment.

email_address

(required) The email address of the sender.

id

(required) The unique ID of the sender.

lifecycle_state

(optional) The current status of the approved sender.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED'

time_created

(optional) Date time the approved sender was added, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_SUPPRESSION_T Type

The full information representing an email suppression.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_suppression_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  id varchar2(32767),
  reason varchar2(32767),
  time_created timestamp with time zone,
  time_last_suppressed timestamp with time zone,
  message_id varchar2(32767),
  error_detail varchar2(32767),
  error_source varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_suppression_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_suppression_t (
    compartment_id varchar2,
    email_address varchar2,
    id varchar2,
    reason varchar2,
    time_created timestamp with time zone,
    time_last_suppressed timestamp with time zone,
    message_id varchar2,
    error_detail varchar2,
    error_source varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

email_address

(required) Email address of the suppression.

id

(required) The unique ID of the suppression.

reason

(optional) The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.

Allowed values are: 'UNKNOWN', 'HARDBOUNCE', 'COMPLAINT', 'MANUAL', 'SOFTBOUNCE', 'UNSUBSCRIBE'

time_created

(optional) The date and time the suppression was added in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.

time_last_suppressed

(optional) The last date and time the suppression prevented submission in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.

message_id

(optional) The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.

error_detail

(optional) The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.

error_source

(optional) DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known. Note: Most SMTP errors that cause suppressions come from software run by email receiving systems rather than from OCI email delivery itself.

DBMS_CLOUD_OCI_EMAIL_SUPPRESSION_SUMMARY_T Type

The full information representing a suppression.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_suppression_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  email_address varchar2(32767),
  id varchar2(32767),
  reason varchar2(32767),
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_suppression_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_suppression_summary_t (
    compartment_id varchar2,
    email_address varchar2,
    id varchar2,
    reason varchar2,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID for the compartment.

email_address

(required) The email address of the suppression.

id

(required) The unique OCID of the suppression.

reason

(optional) The reason that the email address was suppressed.

Allowed values are: 'UNKNOWN', 'HARDBOUNCE', 'COMPLAINT', 'MANUAL', 'SOFTBOUNCE', 'UNSUBSCRIBE'

time_created

(optional) The date and time a recipient's email address was added to the suppression list, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.

DBMS_CLOUD_OCI_EMAIL_UPDATE_DKIM_DETAILS_T Type

The attributes to update in the DKIM.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_update_dkim_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_dkim_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_dkim_details_t (
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) A string that describes the details about the DKIM. It does not have to be unique, and you can change it. Avoid entering confidential information.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_UPDATE_EMAIL_DOMAIN_DETAILS_T Type

The attributes to update in the email domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_update_email_domain_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_email_domain_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_email_domain_details_t (
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_UPDATE_SENDER_DETAILS_T Type

The details allowed for updating a sender.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_update_sender_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_sender_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_update_sender_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_email_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_email_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_email_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_DKIM', 'DELETE_DKIM', 'MOVE_DKIM', 'UPDATE_DKIM', 'CREATE_EMAIL_DOMAIN', 'DELETE_EMAIL_DOMAIN', 'MOVE_EMAIL_DOMAIN', 'UPDATE_EMAIL_DOMAIN'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_email_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_ERROR_COLLECTION_T Type

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_email_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_error_collection_t (
    items dbms_cloud_oci_email_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_email_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_email_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_log_entry_collection_t (
    items dbms_cloud_oci_email_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_email_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_email_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_DKIM', 'DELETE_DKIM', 'MOVE_DKIM', 'UPDATE_DKIM', 'CREATE_EMAIL_DOMAIN', 'DELETE_EMAIL_DOMAIN', 'MOVE_EMAIL_DOMAIN', 'UPDATE_EMAIL_DOMAIN'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_email_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_email_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_EMAIL_WORK_REQUEST_SUMMARY_COLLECTION_T Type

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_email_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_email_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_email_work_request_summary_collection_t (
    items dbms_cloud_oci_email_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?