SmtpCredential¶
- class oci.identity.models.SmtpCredential(**kwargs)¶
Bases:
objectSimple 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.
Attributes:
A constant which can be used with the lifecycle_state property of a SmtpCredential.
A constant which can be used with the lifecycle_state property of a SmtpCredential.
A constant which can be used with the lifecycle_state property of a SmtpCredential.
A constant which can be used with the lifecycle_state property of a SmtpCredential.
A constant which can be used with the lifecycle_state property of a SmtpCredential.
Gets the description of this SmtpCredential.
Gets the id of this SmtpCredential.
Gets the inactive_status of this SmtpCredential.
Gets the lifecycle_state of this SmtpCredential.
Gets the password of this SmtpCredential.
Gets the time_created of this SmtpCredential.
Gets the time_expires of this SmtpCredential.
Gets the user_id of this SmtpCredential.
Gets the username of this SmtpCredential.
Methods:
__init__(**kwargs)Initializes a new SmtpCredential object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a SmtpCredential. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a SmtpCredential. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SmtpCredential. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a SmtpCredential. This constant has a value of “DELETING”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a SmtpCredential. This constant has a value of “INACTIVE”
- __init__(**kwargs)¶
Initializes a new SmtpCredential object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
username (str) – The value to assign to the username property of this SmtpCredential.
password (str) – The value to assign to the password property of this SmtpCredential.
id (str) – The value to assign to the id property of this SmtpCredential.
user_id (str) – The value to assign to the user_id property of this SmtpCredential.
description (str) – The value to assign to the description property of this SmtpCredential.
time_created (datetime) – The value to assign to the time_created property of this SmtpCredential.
time_expires (datetime) – The value to assign to the time_expires property of this SmtpCredential.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SmtpCredential. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this SmtpCredential.
- property description¶
Gets the description of this SmtpCredential. 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.
- Returns
The description of this SmtpCredential.
- Return type
str
- property id¶
Gets the id of this SmtpCredential. The OCID of the SMTP credential.
- Returns
The id of this SmtpCredential.
- Return type
str
- property inactive_status¶
Gets the inactive_status of this SmtpCredential. The detailed status of INACTIVE lifecycleState.
- Returns
The inactive_status of this SmtpCredential.
- Return type
int
- property lifecycle_state¶
Gets the lifecycle_state of this SmtpCredential. The credential’s current state. After creating a SMTP credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this SmtpCredential.
- Return type
str
- property password¶
Gets the password of this SmtpCredential. The SMTP password.
- Returns
The password of this SmtpCredential.
- Return type
str
- property time_created¶
Gets the time_created of this SmtpCredential. Date and time the SmtpCredential object was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this SmtpCredential.
- Return type
datetime
- property time_expires¶
Gets the time_expires of this SmtpCredential. Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_expires of this SmtpCredential.
- Return type
datetime
- property user_id¶
Gets the user_id of this SmtpCredential. The OCID of the user the SMTP credential belongs to.
- Returns
The user_id of this SmtpCredential.
- Return type
str
- property username¶
Gets the username of this SmtpCredential. The SMTP user name.
- Returns
The username of this SmtpCredential.
- Return type
str