service_mailing_list_send_as

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

Overview

Name	service_mailing_list_send_as
Type	Resource
Id	ovh.email_exchange.service_mailing_list_send_as

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
allowed_account_id	integer	Account id to give send on behalf to (wire: allowedAccountId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)

list

Get users authorized to Send On Behalf To mails from this mailbox

Name	Datatype	Description
allowed_account_id	integer	Account id to give send on behalf to (wire: allowedAccountId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	allowed_account_id, exchange_service, mailing_list_address, organization_name		Get a send as permission. Returns the ID of the account allowed to send emails as this group, and the creation date of the right.
list	select	exchange_service, mailing_list_address, organization_name	x_pagination_mode	List send as permissions. Returns the IDs of the accounts allowed to send emails as the group, from the group address.
create	insert	exchange_service, mailing_list_address, organization_name, allow_account_id		Add a send as permission. Allows the account given by allowAccountId to send emails as the group, and returns the task.
delete	delete	allowed_account_id, exchange_service, mailing_list_address, organization_name		Remove a send as permission. Withdraws the right of the allowed account to send emails as this group, 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
allowed_account_id	integer	Account id to give send on behalf to (wire: allowedAccountId)
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)
mailing_list_address	string	The mailing list address (wire: mailingListAddress)
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 a send as permission. Returns the ID of the account allowed to send emails as this group, and the creation date of the right.

SELECT
allowed_account_id,
task_pending_id,
creation_date
FROM ovh.email_exchange.service_mailing_list_send_as
WHERE allowed_account_id = '{{ allowed_account_id }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND mailing_list_address = '{{ mailing_list_address }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List send as permissions. Returns the IDs of the accounts allowed to send emails as the group, from the group address.

SELECT
allowed_account_id,
task_pending_id,
creation_date
FROM ovh.email_exchange.service_mailing_list_send_as
WHERE exchange_service = '{{ exchange_service }}' -- required
AND mailing_list_address = '{{ mailing_list_address }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a send as permission. Allows the account given by allowAccountId to send emails as the group, and returns the task.

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

Manifest

# Description fields are for documentation purposes
- name: service_mailing_list_send_as
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_mailing_list_send_as resource.
  - name: mailing_list_address
    value: "{{ mailing_list_address }}"
    description: Required parameter for the service_mailing_list_send_as resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_mailing_list_send_as resource.
  - name: allow_account_id
    value: {{ allow_account_id }}
    description: |
      Account id to allow to send as mails from this mailing list

DELETE examples

delete

Remove a send as permission. Withdraws the right of the allowed account to send emails as this group, and returns the task.

DELETE FROM ovh.email_exchange.service_mailing_list_send_as
WHERE allowed_account_id = '{{ allowed_account_id }}' --required
AND exchange_service = '{{ exchange_service }}' --required
AND mailing_list_address = '{{ mailing_list_address }}' --required
AND organization_name = '{{ organization_name }}' --required
;