service_mailing_list_member_mailing_lists

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

Overview

Name	service_mailing_list_member_mailing_lists
Type	Resource
Id	ovh.email_exchange.service_mailing_list_member_mailing_lists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
member_account_id	integer	Member account id (wire: memberAccountId)
member_contact_id	integer	Member account id (wire: memberContactId)
member_mailing_list_id	integer	Member mailing list id (wire: memberMailingListId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
member_email_address	string	Member account primaryEmailAddress (wire: memberEmailAddress)

list

Mailing list members

Name	Datatype	Description
member_account_id	integer	Member account id (wire: memberAccountId)
member_contact_id	integer	Member account id (wire: memberContactId)
member_mailing_list_id	integer	Member mailing list id (wire: memberMailingListId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
member_email_address	string	Member account primaryEmailAddress (wire: memberEmailAddress)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, mailing_list_address, member_mailing_list_id, organization_name		Get a group member. Returns the email address and the ID of the member (account, contact or group), and the date it was added.
list	select	exchange_service, mailing_list_address, organization_name	x_pagination_mode	List group members. Returns the IDs of the groups that are members of the group. Email accounts and external contacts are listed under member/account and member/contact.
create	insert	exchange_service, mailing_list_address, organization_name		Add a group member. Adds a member to the group and returns the task: an email account (memberAccountId) through member/account, an external contact (memberContactId) through member/contact, or a group (memberMailingListId) through member/mailingList.
delete	delete	exchange_service, mailing_list_address, member_mailing_list_id, organization_name		Remove a group member. Removes the account, contact or group from the members of the 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
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)
member_mailing_list_id	integer	Member mailing list id (wire: memberMailingListId)
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 member. Returns the email address and the ID of the member (account, contact or group), and the date it was added.

SELECT
member_account_id,
member_contact_id,
member_mailing_list_id,
task_pending_id,
creation_date,
member_email_address
FROM ovh.email_exchange.service_mailing_list_member_mailing_lists
WHERE exchange_service = '{{ exchange_service }}' -- required
AND mailing_list_address = '{{ mailing_list_address }}' -- required
AND member_mailing_list_id = '{{ member_mailing_list_id }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List group members. Returns the IDs of the groups that are members of the group. Email accounts and external contacts are listed under member/account and member/contact.

SELECT
member_account_id,
member_contact_id,
member_mailing_list_id,
task_pending_id,
creation_date,
member_email_address
FROM ovh.email_exchange.service_mailing_list_member_mailing_lists
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 group member. Adds a member to the group and returns the task: an email account (memberAccountId) through member/account, an external contact (memberContactId) through member/contact, or a group (memberMailingListId) through member/mailingList.

INSERT INTO ovh.email_exchange.service_mailing_list_member_mailing_lists (
member_account_id,
member_contact_id,
member_mailing_list_id,
exchange_service,
mailing_list_address,
organization_name
)
SELECT 
{{ member_account_id }},
{{ member_contact_id }},
{{ member_mailing_list_id }},
'{{ 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_member_mailing_lists
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_mailing_list_member_mailing_lists resource.
  - name: mailing_list_address
    value: "{{ mailing_list_address }}"
    description: Required parameter for the service_mailing_list_member_mailing_lists resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_mailing_list_member_mailing_lists resource.
  - name: member_account_id
    value: {{ member_account_id }}
    description: |
      Member account id
  - name: member_contact_id
    value: {{ member_contact_id }}
    description: |
      Member contact id
  - name: member_mailing_list_id
    value: {{ member_mailing_list_id }}
    description: |
      Member mailing list id

DELETE examples

delete

Remove a group member. Removes the account, contact or group from the members of the group, and returns the task.

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