service_protocol_active_sync_mail_notifications

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

Overview

Name	service_protocol_active_sync_mail_notifications
Type	Resource
Id	ovh.email_exchange.service_protocol_active_sync_mail_notifications

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
notified_account_id	integer	Notified Account Id (wire: notifiedAccountId)
creation_date	string (date-time)	Creation date (wire: creationDate)
primary_email_address	string	Primary email address for notified account (wire: primaryEmailAddress)
state	string	Email state (creating, deleting, ok)

list

Get email addresses subscribed to ActiveSync quarantine notifications

Name	Datatype	Description
notified_account_id	integer	Notified Account Id (wire: notifiedAccountId)
creation_date	string (date-time)	Creation date (wire: creationDate)
primary_email_address	string	Primary email address for notified account (wire: primaryEmailAddress)
state	string	Email state (creating, deleting, ok)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, notified_account_id, organization_name		Get an ActiveSync notified account. Returns the email address and state of an account that receives the ActiveSync quarantine notifications.
list	select	exchange_service, organization_name	x_pagination_mode	List ActiveSync notified accounts. Returns the IDs of the accounts that receive the ActiveSync quarantine notifications.
create	insert	exchange_service, organization_name, notified_account_id		Add an ActiveSync notified account. Subscribes the account given by notifiedAccountId to the ActiveSync quarantine notifications, and returns the task.
delete	delete	exchange_service, notified_account_id, organization_name		Remove an ActiveSync notified account. Unsubscribes the account from the ActiveSync quarantine notifications, and returns the task.

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)
notified_account_id	integer	Notified Account Id (wire: notifiedAccountId)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
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

Get an ActiveSync notified account. Returns the email address and state of an account that receives the ActiveSync quarantine notifications.

SELECT
notified_account_id,
creation_date,
primary_email_address,
state
FROM ovh.email_exchange.service_protocol_active_sync_mail_notifications
WHERE exchange_service = '{{ exchange_service }}' -- required
AND notified_account_id = '{{ notified_account_id }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List ActiveSync notified accounts. Returns the IDs of the accounts that receive the ActiveSync quarantine notifications.

SELECT
notified_account_id,
creation_date,
primary_email_address,
state
FROM ovh.email_exchange.service_protocol_active_sync_mail_notifications
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an ActiveSync notified account. Subscribes the account given by notifiedAccountId to the ActiveSync quarantine notifications, and returns the task.

INSERT INTO ovh.email_exchange.service_protocol_active_sync_mail_notifications (
notified_account_id,
exchange_service,
organization_name
)
SELECT 
{{ notified_account_id }} /* required */,
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_protocol_active_sync_mail_notifications
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_protocol_active_sync_mail_notifications resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_protocol_active_sync_mail_notifications resource.
  - name: notified_account_id
    value: {{ notified_account_id }}
    description: |
      Exchange Account Id

DELETE examples

delete

Remove an ActiveSync notified account. Unsubscribes the account from the ActiveSync quarantine notifications, and returns the task.

DELETE FROM ovh.email_exchange.service_protocol_active_sync_mail_notifications
WHERE exchange_service = '{{ exchange_service }}' --required
AND notified_account_id = '{{ notified_account_id }}' --required
AND organization_name = '{{ organization_name }}' --required
;