com.oracle.bmc.email.model

Class Suppression

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.email.model.Suppression

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public final class Suppression
extends ExplicitlySetBmcModel

The full information representing an email suppression.
Note: Objects should always be created or deserialized using the Suppression.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 Suppression.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Suppression.Builder
static class	Suppression.Reason The reason that the email address was suppressed.

Constructor Summary

Constructors

Constructor and Description
Suppression(String compartmentId, String emailAddress, String id, Suppression.Reason reason, Date timeCreated, Date timeLastSuppressed, String messageId, String errorDetail, String errorSource) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Suppression.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the compartment to contain the suppression.
String	getEmailAddress() Email address of the suppression.
String	getErrorDetail() The specific error message returned by a system that resulted in the suppression.
String	getErrorSource() DNS name of the source of the error that caused the suppression.
String	getId() The unique ID of the suppression.
String	getMessageId() The value of the Message-ID header from the email that triggered a suppression.
Suppression.Reason	getReason() The reason that the email address was suppressed.
Date	getTimeCreated() The date and time the suppression was added in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.
Date	getTimeLastSuppressed() The last date and time the suppression prevented submission in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.
int	hashCode()
Suppression.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

Suppression

@Deprecated
 @ConstructorProperties(value={"compartmentId","emailAddress","id","reason","timeCreated","timeLastSuppressed","messageId","errorDetail","errorSource"})
public Suppression(String compartmentId,
                                                                                                                                                                                        String emailAddress,
                                                                                                                                                                                        String id,
                                                                                                                                                                                        Suppression.Reason reason,
                                                                                                                                                                                        Date timeCreated,
                                                                                                                                                                                        Date timeLastSuppressed,
                                                                                                                                                                                        String messageId,
                                                                                                                                                                                        String errorDetail,
                                                                                                                                                                                        String errorSource)

Deprecated.

Method Detail

builder

public static Suppression.Builder builder()

Create a new builder.

toBuilder

public Suppression.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

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

Returns:

the value

getEmailAddress

public String getEmailAddress()

Email address of the suppression.

Returns:

the value

getId

public String getId()

The unique ID of the suppression.

Returns:

the value

getReason

public Suppression.Reason getReason()

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

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the suppression was added in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

Returns:

the value

getTimeLastSuppressed

public Date getTimeLastSuppressed()

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

Returns:

the value

getMessageId

public String getMessageId()

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.

Returns:

the value

getErrorDetail

public String getErrorDetail()

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.

Returns:

the value

getErrorSource

public String getErrorSource()

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel