task_email_changes

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

Overview

Name	task_email_changes
Type	Resource
Id	ovh.me.task_email_changes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
date_done	string (date-time)	End date of that request (wire: dateDone)
date_request	string (date-time)	Creation date of that request (wire: dateRequest)
new_email	string	The email address to change for (wire: newEmail)
state	string	Current state of the request (aborted, done, refused, todo)

list

Task running an email change on an account

Name	Datatype	Description
id	integer
date_done	string (date-time)	End date of that request (wire: dateDone)
date_request	string (date-time)	Creation date of that request (wire: dateRequest)
new_email	string	The email address to change for (wire: newEmail)
state	string	Current state of the request (aborted, done, refused, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get this object properties
list	select		state, x_pagination_mode	List of email change tasks you are involved in
accept	exec	id, token		Accept this change request
refuse	exec	id, token		Refuse this change request

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"}})
id	integer
state	string	Filter the value of state property (like)
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 this object properties

SELECT
id,
date_done,
date_request,
new_email,
state
FROM ovh.me.task_email_changes
WHERE id = '{{ id }}' -- required
;

list

List of email change tasks you are involved in

SELECT
id,
date_done,
date_request,
new_email,
state
FROM ovh.me.task_email_changes
WHERE state = '{{ state }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

accept

Accept this change request

EXEC ovh.me.task_email_changes.accept 
@id='{{ id }}' --required 
@@json=
'{
"token": "{{ token }}"
}'
;

refuse

Refuse this change request

EXEC ovh.me.task_email_changes.refuse 
@id='{{ id }}' --required 
@@json=
'{
"token": "{{ token }}"
}'
;