hosted_email_services_configurations
Creates, updates, deletes, gets or lists a hosted_email_services_configurations resource.
Overview​
| Name | hosted_email_services_configurations |
| Type | Resource |
| Id | ovh.pack_xdsl.hosted_email_services_configurations |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
services | array | List of services configurations |
status | string | Status (active, suspended) |
webmail_url | string | Webmail url (wire: webmailUrl) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, pack_name | Get the configuration of a hosted email service. Returns the webmail URL, the status and the configuration of each service of the hosted email 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 configuration of a hosted email service. Returns the webmail URL, the status and the configuration of each service of the hosted email account.
SELECT
services,
status,
webmail_url
FROM ovh.pack_xdsl.hosted_email_services_configurations
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;