SenderSummary¶
- class oci.email.models.SenderSummary(**kwargs)¶
Bases:
objectThe email addresses and senderId representing an approved sender.
Methods:
__init__(**kwargs)Initializes a new SenderSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this SenderSummary.
Gets the defined_tags of this SenderSummary.
[Required] Gets the email_address of this SenderSummary.
Gets the email_ip_pool_id of this SenderSummary.
Gets the freeform_tags of this SenderSummary.
[Required] Gets the id of this SenderSummary.
Gets the lifecycle_state of this SenderSummary.
Gets the locks of this SenderSummary.
Gets the system_tags of this SenderSummary.
Gets the time_created of this SenderSummary.
- __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.
email_ip_pool_id (str) – The value to assign to the email_ip_pool_id property of this SenderSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SenderSummary.
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.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SenderSummary.
locks (list[oci.email.models.ResourceLock]) – The value to assign to the locks property of this SenderSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this SenderSummary. The OCID for the compartment.
- Returns
The compartment_id of this SenderSummary.
- Return type
str
- property 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))
- property email_address¶
[Required] Gets the email_address of this SenderSummary. The email address of the sender.
- Returns
The email_address of this SenderSummary.
- Return type
str
- property email_ip_pool_id¶
Gets the email_ip_pool_id of this SenderSummary. The IpPool OCID used to submit an email by Email Delivery when sent from this sender.
- Returns
The email_ip_pool_id of this SenderSummary.
- Return type
str
- property 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)
- property id¶
[Required] Gets the id of this SenderSummary. The unique ID of the sender.
- Returns
The id of this SenderSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this SenderSummary. The current status of the approved sender.
- Returns
The lifecycle_state of this SenderSummary.
- Return type
str
- property locks¶
Gets the locks of this SenderSummary. Locks associated with this resource.
- Returns
The locks of this SenderSummary.
- Return type
- property system_tags¶
Gets the system_tags of this SenderSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this SenderSummary.
- Return type
dict(str, dict(str, object))