service_account_protocols

Creates, updates, deletes, gets or lists a service_account_protocols resource.

Overview

Name	service_account_protocols
Type	Resource
Id	ovh.email_exchange.service_account_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	Mobile access enabled on that mailbox (wire: activeSync)
creation_date	string (date-time)	Creation date (wire: creationDate)
imap	boolean	IMAP protocol enabled on that mailbox (wire: IMAP)
last_update	string (date-time)	Last update date (wire: lastUpdate)
pop	boolean	POP protocol enabled on that mailbox (wire: POP)
web_mail	boolean	Web mail enabled on that mailbox (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, primary_email_address		Get the account protocols. Returns whether POP, IMAP, webmail and ActiveSync are enabled on the email account.
update	update	exchange_service, organization_name, primary_email_address		Update the account protocols. Enables or disables POP, IMAP, webmail and ActiveSync on the 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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)

SELECT examples

get

Get the account protocols. Returns whether POP, IMAP, webmail and ActiveSync are enabled on the email account.

SELECT
task_pending_id,
active_sync,
creation_date,
imap,
last_update,
pop,
web_mail
FROM ovh.email_exchange.service_account_protocols
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND primary_email_address = '{{ primary_email_address }}' -- required
;

UPDATE examples

update

Update the account protocols. Enables or disables POP, IMAP, webmail and ActiveSync on the email account.

UPDATE ovh.email_exchange.service_account_protocols
SET 
imap = {{ imap }},
pop = {{ pop }},
active_sync = {{ active_sync }},
web_mail = {{ web_mail }}
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND primary_email_address = '{{ primary_email_address }}' --required;