notification_email_histories
Creates, updates, deletes, gets or lists a notification_email_histories resource.
Overview​
| Name | notification_email_histories |
| Type | Resource |
| Id | ovh.me.notification_email_histories |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | ID of the email notification |
body | string | Content of the email |
date | string (date-time) | Date at which the email was sent |
subject | string | Subject of the email |
Email notification received
| Name | Datatype | Description |
|---|---|---|
id | integer | ID of the email notification |
body | string | Content of the email |
date | string (date-time) | Date at which the email was sent |
subject | string | Subject of the email |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id | Retrieve information about an email | |
list | select | x_pagination_mode | Retrieve every email sent to you |
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"}}) |
id | integer | Id |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Retrieve information about an email
SELECT
id,
body,
date,
subject
FROM ovh.me.notification_email_histories
WHERE id = '{{ id }}' -- required
;
Retrieve every email sent to you
SELECT
id,
body,
date,
subject
FROM ovh.me.notification_email_histories
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;