task_responders

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

Overview

Name	task_responders
Type	Resource
Id	ovh.email_domain.task_responders

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Id of task
account	string	Account name of task
action	string	Action of task (add, change, delete)
date	string (date-time)	Creation date of task
domain	string	Domain name of task
type	string	Type of action filter (25g, alias, delete, filter, forward, responder)

list

Task special account List

Name	Datatype	Description
id	string	Id of task
account	string	Account name of task
action	string	Action of task (add, change, delete)
date	string (date-time)	Creation date of task
domain	string	Domain name of task
type	string	Type of action filter (25g, alias, delete, filter, forward, responder)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, id		Get a responder or redirection task. Returns the account, type, action and creation date of the task.
list	select	domain	account, x_pagination_mode	List responder tasks. Returns the IDs of the pending responder tasks of the domain. Filter them by account.

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"}})
domain	string	Name of your domain name
id	integer	Id of task
account	string	Name of responder
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 responder or redirection task. Returns the account, type, action and creation date of the task.

SELECT
id,
account,
action,
date,
domain,
type
FROM ovh.email_domain.task_responders
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;

list

List responder tasks. Returns the IDs of the pending responder tasks of the domain. Filter them by account.

SELECT
id,
account,
action,
date,
domain,
type
FROM ovh.email_domain.task_responders
WHERE domain = '{{ domain }}' -- required
AND account = '{{ account }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;