email_options

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

Overview

Name	email_options
Type	Resource
Id	ovh.hosting_web.email_options

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Account id
creation_date	string (date-time)	Creation date (wire: creationDate)
domain	string	Email service domain

list

Mail service linked to webhosting

Name	Datatype	Description
id	integer	Account id
creation_date	string (date-time)	Creation date (wire: creationDate)
domain	string	Email service domain

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get an email option. Returns the domain and creation date of the email option. Its billing information is returned by serviceInfos.
list	select	service_name	x_pagination_mode	List email options. Returns the IDs of the email options of the hosting. Each option is a mail service linked to the hosting.
terminate	exec	id, serviceName		Terminate an email option. Requests the termination of the email option. A link to confirm it is sent by email to the administrator contact.

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	Id of the object
serviceName	string	The internal name of your hosting
service_name	string	The internal name of your hosting (wire: serviceName)
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 an email option. Returns the domain and creation date of the email option. Its billing information is returned by serviceInfos.

SELECT
id,
creation_date,
domain
FROM ovh.hosting_web.email_options
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List email options. Returns the IDs of the email options of the hosting. Each option is a mail service linked to the hosting.

SELECT
id,
creation_date,
domain
FROM ovh.hosting_web.email_options
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

terminate

Terminate an email option. Requests the termination of the email option. A link to confirm it is sent by email to the administrator contact.

EXEC ovh.hosting_web.email_options.terminate 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;