service_mailing_list_aliases

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

Overview

Name	service_mailing_list_aliases
Type	Resource
Id	ovh.email_exchange.service_mailing_list_aliases

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Pending task id (wire: taskPendingId)
alias	string	Alias
creation_date	string (date-time)	Creation date (wire: creationDate)

list

Get aliases on this mailingList

Name	Datatype	Description
task_pending_id	integer	Pending task id (wire: taskPendingId)
alias	string	Alias
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	alias, exchange_service, mailing_list_address, organization_name		Get a group alias. Returns the alias address, its creation date and the ID of its pending task, if any (taskPendingId).
list	select	exchange_service, mailing_list_address, organization_name	x_pagination_mode	List group aliases. Returns the aliases of the group: extra addresses that deliver to the members of the group.
create	insert	exchange_service, mailing_list_address, organization_name, alias		Create a group alias. Adds the alias address to the group, so that the emails sent to it reach the members, and returns the task.
delete	delete	alias, exchange_service, mailing_list_address, organization_name		Delete a group alias. Removes the alias address from the group, whose members no longer receive its emails, 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
alias	string	Alias
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 group alias. Returns the alias address, its creation date and the ID of its pending task, if any (taskPendingId).

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

list

List group aliases. Returns the aliases of the group: extra addresses that deliver to the members of the group.

SELECT
task_pending_id,
alias,
creation_date
FROM ovh.email_exchange.service_mailing_list_aliases
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

Create a group alias. Adds the alias address to the group, so that the emails sent to it reach the members, and returns the task.

INSERT INTO ovh.email_exchange.service_mailing_list_aliases (
alias,
exchange_service,
mailing_list_address,
organization_name
)
SELECT 
'{{ alias }}' /* 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_aliases
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_mailing_list_aliases resource.
  - name: mailing_list_address
    value: "{{ mailing_list_address }}"
    description: Required parameter for the service_mailing_list_aliases resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_mailing_list_aliases resource.
  - name: alias
    value: "{{ alias }}"
    description: |
      Alias

DELETE examples

delete

Delete a group alias. Removes the alias address from the group, whose members no longer receive its emails, and returns the task.

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