EmailClientCompositeOperations¶

class oci.email.EmailClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around EmailClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

`__init__`(client, **kwargs)	Creates a new EmailClientCompositeOperations object
`add_email_domain_lock_and_wait_for_state`(…)	Calls `add_email_domain_lock()` and waits for the `EmailDomain` acted upon to enter the given state(s).
`add_return_path_lock_and_wait_for_state`(…)	Calls `add_return_path_lock()` and waits for the `EmailReturnPath` acted upon to enter the given state(s).
`add_sender_lock_and_wait_for_state`(…[, …])	Calls `add_sender_lock()` and waits for the `Sender` acted upon to enter the given state(s).
`change_email_domain_compartment_and_wait_for_state`(…)	Calls `change_email_domain_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`create_dkim_and_wait_for_state`(…[, …])	Calls `create_dkim()` and waits for the `WorkRequest` to enter the given state(s).
`create_email_domain_and_wait_for_state`(…)	Calls `create_email_domain()` and waits for the `WorkRequest` to enter the given state(s).
`create_email_return_path_and_wait_for_state`(…)	Calls `create_email_return_path()` and waits for the `WorkRequest` to enter the given state(s).
`create_sender_and_wait_for_state`(…[, …])	Calls `create_sender()` and waits for the `Sender` acted upon to enter the given state(s).
`delete_dkim_and_wait_for_state`(dkim_id[, …])	Calls `delete_dkim()` and waits for the `WorkRequest` to enter the given state(s).
`delete_email_domain_and_wait_for_state`(…)	Calls `delete_email_domain()` and waits for the `WorkRequest` to enter the given state(s).
`delete_email_return_path_and_wait_for_state`(…)	Calls `delete_email_return_path()` and waits for the `WorkRequest` to enter the given state(s).
`delete_sender_and_wait_for_state`(sender_id)	Calls `delete_sender()` and waits for the `Sender` acted upon to enter the given state(s).
`remove_email_domain_lock_and_wait_for_state`(…)	Calls `remove_email_domain_lock()` and waits for the `EmailDomain` acted upon to enter the given state(s).
`remove_return_path_lock_and_wait_for_state`(…)	Calls `remove_return_path_lock()` and waits for the `EmailReturnPath` acted upon to enter the given state(s).
`remove_sender_lock_and_wait_for_state`(…[, …])	Calls `remove_sender_lock()` and waits for the `Sender` acted upon to enter the given state(s).
`update_dkim_and_wait_for_state`(dkim_id, …)	Calls `update_dkim()` and waits for the `WorkRequest` to enter the given state(s).
`update_email_domain_and_wait_for_state`(…)	Calls `update_email_domain()` and waits for the `WorkRequest` to enter the given state(s).
`update_email_return_path_and_wait_for_state`(…)	Calls `update_email_return_path()` and waits for the `WorkRequest` to enter the given state(s).
`update_sender_and_wait_for_state`(sender_id, …)	Calls `update_sender()` and waits for the `Sender` acted upon to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new EmailClientCompositeOperations object

Parameters:	client (EmailClient) – The service client which will be wrapped by this object

add_email_domain_lock_and_wait_for_state(email_domain_id, add_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_email_domain_lock() and waits for the EmailDomain acted upon to enter the given state(s).

Parameters:

email_domain_id (str) –
(required) The OCID of this email domain.
add_lock_details (oci.email.models.AddLockDetails) – (required) Details for adding a lock to a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to add_email_domain_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

add_return_path_lock_and_wait_for_state(email_return_path_id, add_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_return_path_lock() and waits for the EmailReturnPath acted upon to enter the given state(s).

Parameters:

email_return_path_id (str) –
(required) The OCID of this email return path.
add_lock_details (oci.email.models.AddLockDetails) – (required) Details for adding a lock to a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to add_return_path_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

add_sender_lock_and_wait_for_state(sender_id, add_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_sender_lock() and waits for the Sender acted upon to enter the given state(s).

Parameters:

sender_id (str) – (required) The unique OCID of the sender.
add_lock_details (oci.email.models.AddLockDetails) – (required) Details for adding a lock to a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to add_sender_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_email_domain_compartment_and_wait_for_state(email_domain_id, change_email_domain_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls change_email_domain_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:

email_domain_id (str) –
(required) The OCID of this email domain.
change_email_domain_compartment_details (oci.email.models.ChangeEmailDomainCompartmentDetails) – (required) The configuration details for the move operation.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_email_domain_compartment()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_dkim_and_wait_for_state(create_dkim_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_dkim() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_dkim_details (oci.email.models.CreateDkimDetails) – (required) The DKIM details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_dkim()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_email_domain_and_wait_for_state(create_email_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_email_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_email_domain_details (oci.email.models.CreateEmailDomainDetails) – (required) The email domain to create.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_email_domain()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_email_return_path_and_wait_for_state(create_email_return_path_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_email_return_path() and waits for the WorkRequest to enter the given state(s).

Parameters:

create_email_return_path_details (oci.email.models.CreateEmailReturnPathDetails) – (required) The email return path to create.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_email_return_path()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_sender_and_wait_for_state(create_sender_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:

create_sender_details (oci.email.models.CreateSenderDetails) – (required) Create a sender.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_sender()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_dkim_and_wait_for_state(dkim_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_dkim() and waits for the WorkRequest to enter the given state(s).

Parameters:

dkim_id (str) –
(required) The OCID of this DKIM.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_dkim()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_email_domain_and_wait_for_state(email_domain_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_email_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

email_domain_id (str) –
(required) The OCID of this email domain.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_email_domain()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_email_return_path_and_wait_for_state(email_return_path_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_email_return_path() and waits for the WorkRequest to enter the given state(s).

Parameters:

email_return_path_id (str) –
(required) The OCID of this email return path.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_email_return_path()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_sender_and_wait_for_state(sender_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:

sender_id (str) – (required) The unique OCID of the sender.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_sender()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

remove_email_domain_lock_and_wait_for_state(email_domain_id, remove_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_email_domain_lock() and waits for the EmailDomain acted upon to enter the given state(s).

Parameters:

email_domain_id (str) –
(required) The OCID of this email domain.
remove_lock_details (oci.email.models.RemoveLockDetails) – (required) Details for removing a lock from a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to remove_email_domain_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

remove_return_path_lock_and_wait_for_state(email_return_path_id, remove_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_return_path_lock() and waits for the EmailReturnPath acted upon to enter the given state(s).

Parameters:

email_return_path_id (str) –
(required) The OCID of this email return path.
remove_lock_details (oci.email.models.RemoveLockDetails) – (required) Details for removing a lock from a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to remove_return_path_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

remove_sender_lock_and_wait_for_state(sender_id, remove_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_sender_lock() and waits for the Sender acted upon to enter the given state(s).

Parameters:

sender_id (str) – (required) The unique OCID of the sender.
remove_lock_details (oci.email.models.RemoveLockDetails) – (required) Details for removing a lock from a resource.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to remove_sender_lock()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_dkim_and_wait_for_state(dkim_id, update_dkim_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_dkim() and waits for the WorkRequest to enter the given state(s).

Parameters:

dkim_id (str) –
(required) The OCID of this DKIM.
update_dkim_details (oci.email.models.UpdateDkimDetails) – (required) The new DKIM attributes to apply.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_dkim()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_email_domain_and_wait_for_state(email_domain_id, update_email_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_email_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

email_domain_id (str) –
(required) The OCID of this email domain.
update_email_domain_details (oci.email.models.UpdateEmailDomainDetails) – (required) The new email domain attributes to apply.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_email_domain()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_email_return_path_and_wait_for_state(email_return_path_id, update_email_return_path_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_email_return_path() and waits for the WorkRequest to enter the given state(s).

Parameters:

email_return_path_id (str) –
(required) The OCID of this email return path.
update_email_return_path_details (oci.email.models.UpdateEmailReturnPathDetails) – (required) The new email return path attributes to apply.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_email_return_path()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_sender_and_wait_for_state(sender_id, update_sender_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:

sender_id (str) – (required) The unique OCID of the sender.
update_sender_details (oci.email.models.UpdateSenderDetails) – (required) update details for sender.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_sender()
waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait