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
Gets the compartment_id of this Suppression. email_address
Gets the email_address of this Suppression. id
Gets the id of this Suppression. reason
Gets the reason of this Suppression. time_created
Gets the time_created 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.
-
compartment_id
¶ 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
-
email_address
¶ Gets the email_address of this Suppression. Email address of the suppression.
Returns: The email_address of this Suppression. Return type: str
-
id
¶ Gets the id of this Suppression. The unique ID of the suppression.
Returns: The id of this Suppression. Return type: str
-
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
-
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
-