SuppressionSummary

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

Bases: object

The full information representing a suppression.

Attributes

REASON_COMPLAINT A constant which can be used with the reason property of a SuppressionSummary.
REASON_HARDBOUNCE A constant which can be used with the reason property of a SuppressionSummary.
REASON_MANUAL A constant which can be used with the reason property of a SuppressionSummary.
REASON_SOFTBOUNCE A constant which can be used with the reason property of a SuppressionSummary.
REASON_UNKNOWN A constant which can be used with the reason property of a SuppressionSummary.
REASON_UNSUBSCRIBE A constant which can be used with the reason property of a SuppressionSummary.
compartment_id Gets the compartment_id of this SuppressionSummary.
email_address Gets the email_address of this SuppressionSummary.
id Gets the id of this SuppressionSummary.
reason Gets the reason of this SuppressionSummary.
time_created Gets the time_created of this SuppressionSummary.

Methods

__init__(**kwargs) Initializes a new SuppressionSummary object with values from keyword arguments.
REASON_COMPLAINT = 'COMPLAINT'

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

REASON_HARDBOUNCE = 'HARDBOUNCE'

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

REASON_MANUAL = 'MANUAL'

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

REASON_SOFTBOUNCE = 'SOFTBOUNCE'

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

REASON_UNKNOWN = 'UNKNOWN'

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

REASON_UNSUBSCRIBE = 'UNSUBSCRIBE'

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

__init__(**kwargs)

Initializes a new SuppressionSummary 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 SuppressionSummary.
  • email_address (str) – The value to assign to the email_address property of this SuppressionSummary.
  • id (str) – The value to assign to the id property of this SuppressionSummary.
  • reason (str) – The value to assign to the reason property of this SuppressionSummary. 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 SuppressionSummary.
compartment_id

Gets the compartment_id of this SuppressionSummary. The OCID for the compartment.

Returns:The compartment_id of this SuppressionSummary.
Return type:str
email_address

Gets the email_address of this SuppressionSummary. The email address of the suppression.

Returns:The email_address of this SuppressionSummary.
Return type:str
id

Gets the id of this SuppressionSummary. The unique OCID of the suppression.

Returns:The id of this SuppressionSummary.
Return type:str
reason

Gets the reason of this SuppressionSummary. The reason that the email address was suppressed.

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 SuppressionSummary.
Return type:str
time_created

Gets the time_created of this SuppressionSummary. The date and time a recipient’s email address was added to the suppression list, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

Returns:The time_created of this SuppressionSummary.
Return type:datetime