Suppression

class oci.email.models.Suppression(**kwargs)

Bases: object

The full information representing an email suppression.

Attributes:

REASON_COMPLAINT

A constant which can be used with the reason property of a Suppression.

REASON_HARDBOUNCE

A constant which can be used with the reason property of a Suppression.

REASON_MANUAL

A constant which can be used with the reason property of a Suppression.

REASON_SOFTBOUNCE

A constant which can be used with the reason property of a Suppression.

REASON_UNKNOWN

A constant which can be used with the reason property of a Suppression.

REASON_UNSUBSCRIBE

A constant which can be used with the reason property of a Suppression.

compartment_id

[Required] Gets the compartment_id of this Suppression.

email_address

[Required] Gets the email_address of this Suppression.

error_detail

Gets the error_detail of this Suppression.

error_source

Gets the error_source of this Suppression.

id

[Required] Gets the id of this Suppression.

message_id

Gets the message_id of this Suppression.

reason

Gets the reason of this Suppression.

time_created

Gets the time_created of this Suppression.

time_last_suppressed

Gets the time_last_suppressed of this Suppression.

Methods:

__init__(**kwargs)

Initializes a new Suppression object with values from keyword arguments.

REASON_COMPLAINT = 'COMPLAINT'

A constant which can be used with the reason property of a Suppression. This constant has a value of “COMPLAINT”

REASON_HARDBOUNCE = 'HARDBOUNCE'

A constant which can be used with the reason property of a Suppression. This constant has a value of “HARDBOUNCE”

REASON_MANUAL = 'MANUAL'

A constant which can be used with the reason property of a Suppression. This constant has a value of “MANUAL”

REASON_SOFTBOUNCE = 'SOFTBOUNCE'

A constant which can be used with the reason property of a Suppression. This constant has a value of “SOFTBOUNCE”

REASON_UNKNOWN = 'UNKNOWN'

A constant which can be used with the reason property of a Suppression. This constant has a value of “UNKNOWN”

REASON_UNSUBSCRIBE = 'UNSUBSCRIBE'

A constant which can be used with the reason property of a Suppression. This constant has a value of “UNSUBSCRIBE”

__init__(**kwargs)

Initializes a new Suppression object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this Suppression.

  • email_address (str) – The value to assign to the email_address property of this Suppression.

  • id (str) – The value to assign to the id property of this Suppression.

  • reason (str) – The value to assign to the reason property of this Suppression. Allowed values for this property are: “UNKNOWN”, “HARDBOUNCE”, “COMPLAINT”, “MANUAL”, “SOFTBOUNCE”, “UNSUBSCRIBE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this Suppression.

  • time_last_suppressed (datetime) – The value to assign to the time_last_suppressed property of this Suppression.

  • message_id (str) – The value to assign to the message_id property of this Suppression.

  • error_detail (str) – The value to assign to the error_detail property of this Suppression.

  • error_source (str) – The value to assign to the error_source property of this Suppression.

property compartment_id

[Required] Gets the compartment_id of this Suppression. The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

Returns

The compartment_id of this Suppression.

Return type

str

property email_address

[Required] Gets the email_address of this Suppression. Email address of the suppression.

Returns

The email_address of this Suppression.

Return type

str

property error_detail

Gets the error_detail of this Suppression. 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 error_detail of this Suppression.

Return type

str

property error_source

Gets the error_source of this Suppression. 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 error_source of this Suppression.

Return type

str

property id

[Required] Gets the id of this Suppression. The unique ID of the suppression.

Returns

The id of this Suppression.

Return type

str

property message_id

Gets the message_id of this Suppression. 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 message_id of this Suppression.

Return type

str

property reason

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

Allowed values for this property are: “UNKNOWN”, “HARDBOUNCE”, “COMPLAINT”, “MANUAL”, “SOFTBOUNCE”, “UNSUBSCRIBE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The reason of this Suppression.

Return type

str

property time_created

Gets the time_created of this Suppression. 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 time_created of this Suppression.

Return type

datetime

property time_last_suppressed

Gets the time_last_suppressed of this Suppression. 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 time_last_suppressed of this Suppression.

Return type

datetime