hosted_email_services_accounts

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

Overview

Name	hosted_email_services_accounts
Type	Resource
Id	ovh.pack_xdsl.hosted_email_services_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
antispam_enabled	boolean	Is the anti-spam enabled ? (wire: antispamEnabled)
antivirus_enabled	boolean	Is the anti-virus enabled ? (wire: antivirusEnabled)
offer	string	Offer name (individual)
primary_email_address	string	Primary email address (wire: primaryEmailAddress)
quota	object	Quota of the mailbox
size	object	Size of the maibox

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, pack_name		Get the account of a hosted email service. Returns the primary address, offer, quota, mailbox size and the anti-spam and anti-virus status of the 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
pack_name	string	The internal name of your pack (wire: packName)

SELECT examples

get

Get the account of a hosted email service. Returns the primary address, offer, quota, mailbox size and the anti-spam and anti-virus status of the account.

SELECT
antispam_enabled,
antivirus_enabled,
offer,
primary_email_address,
quota,
size
FROM ovh.pack_xdsl.hosted_email_services_accounts
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;