service_protocols
Creates, updates, deletes, gets or lists a service_protocols resource.
Overview​
| Name | service_protocols |
| Type | Resource |
| Id | ovh.email_exchange.service_protocols |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
task_pending_id | integer | Pending task id (wire: taskPendingId) |
active_sync | boolean | ActiveSync protocol enabled on this Exchange service (wire: activeSync) |
active_sync_policy | string | ActiveSync policy to apply at device's first connection (allow, block, quarantine) (wire: activeSyncPolicy) |
creation_date | string (date-time) | Creation date (wire: creationDate) |
imap | boolean | IMAP protocol enabled on this Exchange service (wire: IMAP) |
last_update | string (date-time) | Last update date (wire: lastUpdate) |
pop | boolean | POP protocol enabled on this Exchange service (wire: POP) |
web_mail | boolean | Web mail protocol enabled on this Exchange service (wire: webMail) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | exchange_service, organization_name | Get the service protocols. Returns whether POP, IMAP, webmail and ActiveSync are enabled on the service, and the ActiveSync policy applied to new devices. | |
update | update | exchange_service, organization_name | Update the service protocols. Enables or disables POP, IMAP, webmail and ActiveSync on the service, and sets the ActiveSync policy applied to new devices: allow, block or quarantine. |
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"}}) |
exchange_service | string | The internal name of your exchange service (wire: exchangeService) |
organization_name | string | The internal name of your exchange organization (wire: organizationName) |
SELECT examples​
- get
Get the service protocols. Returns whether POP, IMAP, webmail and ActiveSync are enabled on the service, and the ActiveSync policy applied to new devices.
SELECT
task_pending_id,
active_sync,
active_sync_policy,
creation_date,
imap,
last_update,
pop,
web_mail
FROM ovh.email_exchange.service_protocols
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;
UPDATE examples​
- update
Update the service protocols. Enables or disables POP, IMAP, webmail and ActiveSync on the service, and sets the ActiveSync policy applied to new devices: allow, block or quarantine.
UPDATE ovh.email_exchange.service_protocols
SET
imap = {{ imap }},
pop = {{ pop }},
active_sync = {{ active_sync }},
active_sync_policy = '{{ active_sync_policy }}',
web_mail = {{ web_mail }}
WHERE
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required;