CreateSenderDetails¶
- class oci.email.models.CreateSenderDetails(**kwargs)¶
Bases:
objectThe details needed for creating a sender.
Methods:
__init__(**kwargs)Initializes a new CreateSenderDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this CreateSenderDetails.
Gets the defined_tags of this CreateSenderDetails.
[Required] Gets the email_address of this CreateSenderDetails.
Gets the email_ip_pool_id of this CreateSenderDetails.
Gets the freeform_tags of this CreateSenderDetails.
- __init__(**kwargs)¶
Initializes a new CreateSenderDetails 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 CreateSenderDetails.
email_address (str) – The value to assign to the email_address property of this CreateSenderDetails.
email_ip_pool_id (str) – The value to assign to the email_ip_pool_id property of this CreateSenderDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSenderDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSenderDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateSenderDetails. The OCID of the compartment that contains the sender.
- Returns
The compartment_id of this CreateSenderDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateSenderDetails. 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 CreateSenderDetails.
- Return type
dict(str, dict(str, object))
- property email_address¶
[Required] Gets the email_address of this CreateSenderDetails. The email address of the sender.
- Returns
The email_address of this CreateSenderDetails.
- Return type
str
- property email_ip_pool_id¶
Gets the email_ip_pool_id of this CreateSenderDetails. An optional field. The IpPool OCID used to submit an email by Email Delivery when sent from this sender.
- Returns
The email_ip_pool_id of this CreateSenderDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateSenderDetails. 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 CreateSenderDetails.
- Return type
dict(str, str)