SmtpCredentialSummary¶
-
class
oci.identity.models.
SmtpCredentialSummary
(**kwargs)¶ Bases:
object
As the name suggests, an SmtpCredentialSummary object contains information about an SmtpCredential. The SMTP credential is used for SMTP authentication with the Email Delivery Service.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. description
Gets the description of this SmtpCredentialSummary. id
Gets the id of this SmtpCredentialSummary. inactive_status
Gets the inactive_status of this SmtpCredentialSummary. lifecycle_state
Gets the lifecycle_state of this SmtpCredentialSummary. time_created
Gets the time_created of this SmtpCredentialSummary. time_expires
Gets the time_expires of this SmtpCredentialSummary. user_id
Gets the user_id of this SmtpCredentialSummary. username
Gets the username of this SmtpCredentialSummary. Methods
__init__
(**kwargs)Initializes a new SmtpCredentialSummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. This constant has a value of “INACTIVE”
-
__init__
(**kwargs)¶ Initializes a new SmtpCredentialSummary 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 SmtpCredentialSummary.
- id (str) – The value to assign to the id property of this SmtpCredentialSummary.
- user_id (str) – The value to assign to the user_id property of this SmtpCredentialSummary.
- description (str) – The value to assign to the description property of this SmtpCredentialSummary.
- time_created (datetime) – The value to assign to the time_created property of this SmtpCredentialSummary.
- time_expires (datetime) – The value to assign to the time_expires property of this SmtpCredentialSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this SmtpCredentialSummary. 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 SmtpCredentialSummary.
-
description
¶ Gets the description of this SmtpCredentialSummary. The description you assign to the SMTP credential. Does not have to be unique, and it’s changeable.
Returns: The description of this SmtpCredentialSummary. Return type: str
-
id
¶ Gets the id of this SmtpCredentialSummary. The OCID of the SMTP credential.
Returns: The id of this SmtpCredentialSummary. Return type: str
-
inactive_status
¶ Gets the inactive_status of this SmtpCredentialSummary. The detailed status of INACTIVE lifecycleState.
Returns: The inactive_status of this SmtpCredentialSummary. Return type: int
-
lifecycle_state
¶ Gets the lifecycle_state of this SmtpCredentialSummary. 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 SmtpCredentialSummary. Return type: str
-
time_created
¶ Gets the time_created of this SmtpCredentialSummary. 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 SmtpCredentialSummary. Return type: datetime
-
time_expires
¶ Gets the time_expires of this SmtpCredentialSummary. 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 SmtpCredentialSummary. Return type: datetime
-
user_id
¶ Gets the user_id of this SmtpCredentialSummary. The OCID of the user the SMTP credential belongs to.
Returns: The user_id of this SmtpCredentialSummary. Return type: str
-
username
¶ Gets the username of this SmtpCredentialSummary. The SMTP user name.
Returns: The username of this SmtpCredentialSummary. Return type: str
-