delegated_accounts

Creates, updates, deletes, gets or lists a delegated_accounts resource.

Overview

Name	delegated_accounts
Type	Resource
Id	ovh.email_domain.delegated_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
account_name	string	Name of account (wire: accountName)
allowed_account_size	array	List of allowed sizes for this account in bytes (wire: allowedAccountSize)
description	string	Account description
domain	string	Name of domain
email	string	Email
is_blocked	boolean	If true your account is blocked (wire: isBlocked)
size	integer	Size of your account in bytes

list

Account List

Name	Datatype	Description
account_name	string	Name of account (wire: accountName)
allowed_account_size	array	List of allowed sizes for this account in bytes (wire: allowedAccountSize)
description	string	Account description
domain	string	Name of domain
email	string	Email
is_blocked	boolean	If true your account is blocked (wire: isBlocked)
size	integer	Size of your account in bytes

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	email		Get a delegated account. Returns the email address, description, size in bytes, allowed sizes and blocked state of the delegated email account.
list	select		account_name, domain, x_pagination_mode	List delegated accounts. Returns the email addresses of the email accounts delegated to the customer account. Filter them by domain or accountName.
update	update	email		Update a delegated account. Updates the description or the size in bytes of the delegated email account. The allowed sizes are in allowedAccountSize.
change_password	exec	email, password		Change a delegated account password. Sets a new password and returns the task. The password needs 8 to 30 characters and no accents.
update_usage	exec	email		Refresh delegated account usage. Asks for the figures returned by usage to be recomputed; they are updated asynchronously.
usage	exec	email		Get delegated account usage. Returns the number of emails, the maximum size in bytes of the mailbox (quota) and the date of the measure.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
email	string	Email
account_name	string	Name of email address (wire: accountName)
domain	string	Domain of email address
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a delegated account. Returns the email address, description, size in bytes, allowed sizes and blocked state of the delegated email account.

SELECT
account_name,
allowed_account_size,
description,
domain,
email,
is_blocked,
size
FROM ovh.email_domain.delegated_accounts
WHERE email = '{{ email }}' -- required
;

list

List delegated accounts. Returns the email addresses of the email accounts delegated to the customer account. Filter them by domain or accountName.

SELECT
account_name,
allowed_account_size,
description,
domain,
email,
is_blocked,
size
FROM ovh.email_domain.delegated_accounts
WHERE account_name = '{{ account_name }}'
AND domain = '{{ domain }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a delegated account. Updates the description or the size in bytes of the delegated email account. The allowed sizes are in allowedAccountSize.

UPDATE ovh.email_domain.delegated_accounts
SET 
description = '{{ description }}',
size = {{ size }}
WHERE 
email = '{{ email }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change a delegated account password. Sets a new password and returns the task. The password needs 8 to 30 characters and no accents.

EXEC ovh.email_domain.delegated_accounts.change_password 
@email='{{ email }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;

update_usage

Refresh delegated account usage. Asks for the figures returned by usage to be recomputed; they are updated asynchronously.

EXEC ovh.email_domain.delegated_accounts.update_usage 
@email='{{ email }}' --required
;

usage

Get delegated account usage. Returns the number of emails, the maximum size in bytes of the mailbox (quota) and the date of the measure.

EXEC ovh.email_domain.delegated_accounts.usage 
@email='{{ email }}' --required
;