email_pros

Creates, updates, deletes, gets or lists an email_pros resource.

Overview

Name	email_pros
Type	Resource
Id	ovh.xdsl.email_pros

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Account id
task_pending_id	integer	Pending tasks for this account (wire: taskPendingId)
display_name	string	Account display name (wire: displayName)
first_name	string	Account first name (wire: firstName)
last_name	string	Account last name (wire: lastName)
current_usage	object	Mailbox usage (wire: currentUsage)
domain	string	Email domain
iam	object	IAM resource metadata
initial	string	Account initials
last_logoff_date	string (date-time)	Last logoff (wire: lastLogoffDate)
last_logon_date	string (date-time)	Last logon (wire: lastLogonDate)
login	string	Account login
password_last_update	string (date-time)	Time of account's password last update (wire: passwordLastUpdate)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)
quota	object	Account maximum size
state	string	Account state (creating, deleting, ok, reopening, suspended, suspending, unknown)

list

XDSL Email Pro

Name	Datatype	Description
id	integer	Account id
task_pending_id	integer	Pending tasks for this account (wire: taskPendingId)
display_name	string	Account display name (wire: displayName)
first_name	string	Account first name (wire: firstName)
last_name	string	Account last name (wire: lastName)
current_usage	object	Mailbox usage (wire: currentUsage)
domain	string	Email domain
iam	object	IAM resource metadata
initial	string	Account initials
last_logoff_date	string (date-time)	Last logoff (wire: lastLogoffDate)
last_logon_date	string (date-time)	Last logon (wire: lastLogonDate)
login	string	Account login
password_last_update	string (date-time)	Time of account's password last update (wire: passwordLastUpdate)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)
quota	object	Account maximum size
state	string	Account state (creating, deleting, ok, reopening, suspended, suspending, unknown)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	email		Returns the login, names, primary address, quota and usage, state and last logon and logoff dates of an Email Pro account.
list	select		iam_tags, x_pagination_mode	Returns the email addresses of the Email Pro accounts provided with the xDSL accesses.
update	update	email		Changes the first name, last name, initials and display name of the Email Pro account.
delete	delete	email		Deletes the Email Pro account and its mailbox.
change_password	exec	email, password		Sets a new password for the Email Pro account. Returns the task that performs the change.

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
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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

Returns the login, names, primary address, quota and usage, state and last logon and logoff dates of an Email Pro account.

SELECT
id,
task_pending_id,
display_name,
first_name,
last_name,
current_usage,
domain,
iam,
initial,
last_logoff_date,
last_logon_date,
login,
password_last_update,
primary_email_address,
quota,
state
FROM ovh.xdsl.email_pros
WHERE email = '{{ email }}' -- required
;

list

Returns the email addresses of the Email Pro accounts provided with the xDSL accesses.

SELECT
id,
task_pending_id,
display_name,
first_name,
last_name,
current_usage,
domain,
iam,
initial,
last_logoff_date,
last_logon_date,
login,
password_last_update,
primary_email_address,
quota,
state
FROM ovh.xdsl.email_pros
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Changes the first name, last name, initials and display name of the Email Pro account.

UPDATE ovh.xdsl.email_pros
SET 
display_name = '{{ display_name }}',
first_name = '{{ first_name }}',
initial = '{{ initial }}',
last_name = '{{ last_name }}'
WHERE 
email = '{{ email }}' --required;

DELETE examples

delete

Deletes the Email Pro account and its mailbox.

DELETE FROM ovh.xdsl.email_pros
WHERE email = '{{ email }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Sets a new password for the Email Pro account. Returns the task that performs the change.

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