Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SmtpCredential

Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. A user can have up to 2 SMTP credentials at a time.

*Note:** The credential set is always an Oracle-generated SMTP user name and password pair; you cannot designate the SMTP user name or the SMTP password.

For more information, see [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm#SMTP).

Properties

Optional description

description: undefined | string

The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.

(For tenancies that support identity domains) You can have an empty description.

Optional id

id: undefined | string

The OCID of the SMTP credential.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional lifecycleState

lifecycleState: LifecycleState

The credential's current state. After creating a SMTP credential, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

Optional password

password: undefined | string

The SMTP password.

Optional timeCreated

timeCreated: Date

Date and time the {@code SmtpCredential} object was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeExpires

timeExpires: Date

Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional userId

userId: undefined | string

The OCID of the user the SMTP credential belongs to.

Optional username

username: undefined | string

The SMTP user name.

Functions

getDeserializedJsonObj

getJsonObj