Sender

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

Bases: object

The full information representing an approved sender.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a Sender.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Sender.

compartment_id

[Required] Gets the compartment_id of this Sender.

defined_tags

Gets the defined_tags of this Sender.

email_address

[Required] Gets the email_address of this Sender.

email_domain_id

Gets the email_domain_id of this Sender.

email_ip_pool_id

Gets the email_ip_pool_id of this Sender.

freeform_tags

Gets the freeform_tags of this Sender.

id

[Required] Gets the id of this Sender.

is_spf

Gets the is_spf of this Sender.

lifecycle_state

Gets the lifecycle_state of this Sender.

locks

Gets the locks of this Sender.

system_tags

Gets the system_tags of this Sender.

time_created

Gets the time_created of this Sender.

Methods:

__init__(**kwargs)

Initializes a new Sender object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Sender. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Sender 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 Sender.

  • email_address (str) – The value to assign to the email_address property of this Sender.

  • id (str) – The value to assign to the id property of this Sender.

  • is_spf (bool) – The value to assign to the is_spf property of this Sender.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Sender. Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”, ‘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 Sender.

  • email_domain_id (str) – The value to assign to the email_domain_id property of this Sender.

  • email_ip_pool_id (str) – The value to assign to the email_ip_pool_id property of this Sender.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Sender.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Sender.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Sender.

  • locks (list[oci.email.models.ResourceLock]) – The value to assign to the locks property of this Sender.

property compartment_id

[Required] Gets the compartment_id of this Sender. The OCID for the compartment.

Returns

The compartment_id of this Sender.

Return type

str

property defined_tags

Gets the defined_tags of this Sender. 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 Sender.

Return type

dict(str, dict(str, object))

property email_address

[Required] Gets the email_address of this Sender. Email address of the sender.

Returns

The email_address of this Sender.

Return type

str

property email_domain_id

Gets the email_domain_id of this Sender. The email domain used to assert responsibility for emails sent from this sender.

Returns

The email_domain_id of this Sender.

Return type

str

property email_ip_pool_id

Gets the email_ip_pool_id of this Sender. The IpPool OCID used to submit an email by Email Delivery when sent from this sender.

Returns

The email_ip_pool_id of this Sender.

Return type

str

property freeform_tags

Gets the freeform_tags of this Sender. 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 Sender.

Return type

dict(str, str)

property id

[Required] Gets the id of this Sender. The unique OCID of the sender.

Returns

The id of this Sender.

Return type

str

property is_spf

Gets the is_spf of this Sender. Value of the SPF field. For more information about SPF, please see SPF Authentication.

Returns

The is_spf of this Sender.

Return type

bool

property lifecycle_state

Gets the lifecycle_state of this Sender. The sender’s current lifecycle state.

Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Sender.

Return type

str

property locks

Gets the locks of this Sender. Locks associated with this resource.

Returns

The locks of this Sender.

Return type

list[oci.email.models.ResourceLock]

property system_tags

Gets the system_tags of this Sender. 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 Sender.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Sender. The date and 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 Sender.

Return type

datetime