Skip to main content

email_pro_options_is_email_availables

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

Overview​

Nameemail_pro_options_is_email_availables
TypeResource
Idovh.pack_xdsl.email_pro_options_is_email_availables

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
valueboolean

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectemail, pack_nameGet whether an address is available for Email Pro. Returns whether the given email address can be used to activate an Email Pro service of the xDSL pack.

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.

NameDatatypeDescription
api_hoststringThe 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"}})
emailstringThe email address
pack_namestringThe internal name of your pack (wire: packName)

SELECT examples​

Get whether an address is available for Email Pro. Returns whether the given email address can be used to activate an Email Pro service of the xDSL pack.

SELECT
value
FROM ovh.pack_xdsl.email_pro_options_is_email_availables
WHERE email = '{{ email }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;