summaries
Creates, updates, deletes, gets or lists a summaries resource.
Overview​
| Name | summaries |
| Type | Resource |
| Id | ovh.email_domain.summaries |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
account | integer | Number of mailboxes |
mailing_list | integer | Number of mailing lists (wire: mailingList) |
redirection | integer | Number of redirections |
responder | integer | Number of responders |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain | Get the summary. Returns the number of email accounts, mailing lists, redirections and responders of the email domain. |
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 |
SELECT examples​
- get
Get the summary. Returns the number of email accounts, mailing lists, redirections and responders of the email domain.
SELECT
account,
mailing_list,
redirection,
responder
FROM ovh.email_domain.summaries
WHERE domain = '{{ domain }}' -- required
;