Skip to main content

account_usages

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

Overview​

Nameaccount_usages
TypeResource
Idovh.email_domain.account_usages

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
datestring (date-time)Timestamp
email_countintegerNumber of message in mailbox (wire: emailCount)
quotaintegerSize of mailbox (bytes)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccount_name, domainGet email account usage. Returns the number of emails, the maximum size in bytes of the mailbox (quota) and the date of the measure.

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
account_namestringName of account (wire: accountName)
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"}})
domainstringName of your domain name

SELECT examples​

Get email account usage. Returns the number of emails, the maximum size in bytes of the mailbox (quota) and the date of the measure.

SELECT
date,
email_count,
quota
FROM ovh.email_domain.account_usages
WHERE account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
;