com.oracle.bmc.identity.model

Class SmtpCredential

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identity.model.SmtpCredential

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class SmtpCredential
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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).
Note: Objects should always be created or deserialized using the SmtpCredential.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SmtpCredential.Builder, which maintain a set of all explicitly set fields called SmtpCredential.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmtpCredential.Builder
static class	SmtpCredential.LifecycleState The credential’s current state.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
SmtpCredential(String username, String password, String id, String userId, String description, Date timeCreated, Date timeExpires, SmtpCredential.LifecycleState lifecycleState, Long inactiveStatus) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SmtpCredential.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDescription() The description you assign to the SMTP credential.
String	getId() The OCID of the SMTP credential.
Long	getInactiveStatus() The detailed status of INACTIVE lifecycleState.
SmtpCredential.LifecycleState	getLifecycleState() The credential’s current state.
String	getPassword() The SMTP password.
Date	getTimeCreated() Date and time the SmtpCredential object was created, in the format defined by RFC3339.
Date	getTimeExpires() Date and time when this credential will expire, in the format defined by RFC3339.
String	getUserId() The OCID of the user the SMTP credential belongs to.
String	getUsername() The SMTP user name.
int	hashCode()
SmtpCredential.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SmtpCredential

@Deprecated
 @ConstructorProperties(value={"username","password","id","userId","description","timeCreated","timeExpires","lifecycleState","inactiveStatus"})
public SmtpCredential(String username,
                                                                                                                                                                                   String password,
                                                                                                                                                                                   String id,
                                                                                                                                                                                   String userId,
                                                                                                                                                                                   String description,
                                                                                                                                                                                   Date timeCreated,
                                                                                                                                                                                   Date timeExpires,
                                                                                                                                                                                   SmtpCredential.LifecycleState lifecycleState,
                                                                                                                                                                                   Long inactiveStatus)

Deprecated.

Method Detail

builder

public static SmtpCredential.Builder builder()

Create a new builder.

toBuilder

public SmtpCredential.Builder toBuilder()

getUsername

public String getUsername()

The SMTP user name.

Returns:

the value

getPassword

public String getPassword()

The SMTP password.

Returns:

the value

getId

public String getId()

The OCID of the SMTP credential.

Returns:

the value

getUserId

public String getUserId()

The OCID of the user the SMTP credential belongs to.

Returns:

the value

getDescription

public String getDescription()

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 value

getTimeCreated

public Date getTimeCreated()

Date and time the SmtpCredential object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getTimeExpires

public Date getTimeExpires()

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 value

getLifecycleState

public SmtpCredential.LifecycleState getLifecycleState()

The credential’s current state. After creating a SMTP credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

the value

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel