task_mailinglists

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

Overview

Name	task_mailinglists
Type	Resource
Id	ovh.email_domain.task_mailinglists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
account	string
action	string
date	string (date-time)
domain	string
language	string	Possible values for mailing list language (de, en, es, fr, it, nl, pl, pt)

list

Task Mailing List

Name	Datatype	Description
id	integer
account	string
action	string
date	string (date-time)
domain	string
language	string	Possible values for mailing list language (de, en, es, fr, it, nl, pl, pt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, id		Get a mailing list task. Returns the action, the account, the domain, the language and the creation date of the mailing list task.
list	select	domain	account, x_pagination_mode	List mailing list tasks. Returns the IDs of the pending mailing list 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
account	string	Account name
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 mailing list task. Returns the action, the account, the domain, the language and the creation date of the mailing list task.

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

list

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

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