domain_disclaimers

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

Overview

Name	domain_disclaimers
Type	Resource
Id	ovh.email_mxplan.domain_disclaimers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Disclaimer name
task_pending_id	integer	task pending id (wire: taskPendingId)
content	string	Signature, added at the bottom of your organization emails
creation_date	string (date-time)	Creation date (wire: creationDate)
outside_only	boolean	Activate the disclaimer only for external emails (wire: outsideOnly)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_name, service		Get the disclaimer. Returns the content of the disclaimer added at the bottom of the emails of the domain, and whether it is added only to external emails.
create	insert	domain_name, service, content		Create a disclaimer. Creates the disclaimer added at the bottom of the emails of the domain, and returns the task. Set outsideOnly to true to add it only to external emails. Insert Active Directory attributes in content as %%AttributeName%%.
update	update	domain_name, service		Update the disclaimer. Updates the content of the disclaimer of the domain, and outsideOnly to add it only to external emails. Insert Active Directory attributes in content as %%AttributeName%%.
delete	delete	domain_name, service		Delete the disclaimer. Removes the disclaimer of the domain, so that it is no longer added to the emails sent from it, 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"}})
domain_name	string	Domain name (wire: domainName)
service	string	The internal name of your mxplan organization

SELECT examples

get

Get the disclaimer. Returns the content of the disclaimer added at the bottom of the emails of the domain, and whether it is added only to external emails.

SELECT
name,
task_pending_id,
content,
creation_date,
outside_only
FROM ovh.email_mxplan.domain_disclaimers
WHERE domain_name = '{{ domain_name }}' -- required
AND service = '{{ service }}' -- required
;

INSERT examples

create

Create a disclaimer. Creates the disclaimer added at the bottom of the emails of the domain, and returns the task. Set outsideOnly to true to add it only to external emails. Insert Active Directory attributes in content as %%AttributeName%%.

INSERT INTO ovh.email_mxplan.domain_disclaimers (
content,
outside_only,
domain_name,
service
)
SELECT 
'{{ content }}' /* required */,
{{ outside_only }},
'{{ domain_name }}',
'{{ service }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: domain_disclaimers
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domain_disclaimers resource.
  - name: service
    value: "{{ service }}"
    description: Required parameter for the domain_disclaimers resource.
  - name: content
    value: "{{ content }}"
    description: |
      Signature, added at the bottom of your organization emails
  - name: outside_only
    value: {{ outside_only }}
    description: |
      Activate the disclaimer only for external emails

UPDATE examples

update

Update the disclaimer. Updates the content of the disclaimer of the domain, and outsideOnly to add it only to external emails. Insert Active Directory attributes in content as %%AttributeName%%.

UPDATE ovh.email_mxplan.domain_disclaimers
SET 
content = '{{ content }}',
outside_only = {{ outside_only }}
WHERE 
domain_name = '{{ domain_name }}' --required
AND service = '{{ service }}' --required;

DELETE examples

delete

Delete the disclaimer. Removes the disclaimer of the domain, so that it is no longer added to the emails sent from it, and returns the task.

DELETE FROM ovh.email_mxplan.domain_disclaimers
WHERE domain_name = '{{ domain_name }}' --required
AND service = '{{ service }}' --required
;