SenderSummary

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

Bases: object

The email addresses and senderId representing an approved sender.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SenderSummary. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SenderSummary. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SenderSummary. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SenderSummary. This constant has a value of "DELETING"

__init__(**kwargs)

Initializes a new SenderSummary 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 SenderSummary.
  • email_address (str) -- The value to assign to the email_address property of this SenderSummary.
  • id (str) -- The value to assign to the id property of this SenderSummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this SenderSummary. Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", '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 SenderSummary.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this SenderSummary.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this SenderSummary.
compartment_id

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

Returns:The compartment_id of this SenderSummary.
Return type:str
defined_tags

Gets the defined_tags of this SenderSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this SenderSummary.
Return type:dict(str, dict(str, object))
email_address

Gets the email_address of this SenderSummary. The email address of the sender.

Returns:The email_address of this SenderSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this SenderSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Returns:The freeform_tags of this SenderSummary.
Return type:dict(str, str)
id

Gets the id of this SenderSummary. The unique ID of the sender.

Returns:The id of this SenderSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this SenderSummary. The current status of the approved sender.

Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this SenderSummary.
Return type:str
time_created

Gets the time_created of this SenderSummary. Date time the approved sender was added, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

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