responders

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

Overview

Name	responders
Type	Resource
Id	ovh.email_domain.responders

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
account	string	Name of account
content	string	Content of responder
copy	boolean	If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address
copy_to	string	Account where copy emails (wire: copyTo)
from	string (date-time)	Date of start responder
to	string (date-time)	Date of end responder

list

Responder

Name	Datatype	Description
account	string	Name of account
content	string	Content of responder
copy	boolean	If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address
copy_to	string	Account where copy emails (wire: copyTo)
from	string (date-time)	Date of start responder
to	string (date-time)	Date of end responder

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account, domain		Get a responder. Returns the account, content, start and end dates and copy settings of the responder.
list	select	domain	account, x_pagination_mode	List responders. Returns the account names of the responders of the domain. Filter them by account.
create	insert	domain, account, content, copy		Create a responder. Creates an automatic reply for an account with its content and optional start and end dates, and returns the task. With copy false, emails are dropped; with copy true, they go to the mailbox, or to copyTo when set.
update	update	account, domain		Update a responder. Changes the content of the automatic reply and the dates it is active (from, to) for the email account.
delete	delete	account, domain		Delete a responder. Removes the automatic reply of the email account and returns the task. Follow it under task/responder/{id}.

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
account	string	Name of account
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	string	Name of your domain name
account	string	Responder name
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 responder. Returns the account, content, start and end dates and copy settings of the responder.

SELECT
account,
content,
copy,
copy_to,
from,
to
FROM ovh.email_domain.responders
WHERE account = '{{ account }}' -- required
AND domain = '{{ domain }}' -- required
;

list

List responders. Returns the account names of the responders of the domain. Filter them by account.

SELECT
account,
content,
copy,
copy_to,
from,
to
FROM ovh.email_domain.responders
WHERE domain = '{{ domain }}' -- required
AND account = '{{ account }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a responder. Creates an automatic reply for an account with its content and optional start and end dates, and returns the task. With copy false, emails are dropped; with copy true, they go to the mailbox, or to copyTo when set.

INSERT INTO ovh.email_domain.responders (
account,
content,
copy,
copy_to,
from,
to,
domain
)
SELECT 
'{{ account }}' /* required */,
'{{ content }}' /* required */,
{{ copy }} /* required */,
'{{ copy_to }}',
'{{ from }}',
'{{ to }}',
'{{ domain }}'
RETURNING
id,
account,
action,
date,
domain,
type
;

Manifest

# Description fields are for documentation purposes
- name: responders
props:
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the responders resource.
  - name: account
    value: "{{ account }}"
    description: |
      Account of domain
  - name: content
    value: "{{ content }}"
    description: |
      Content of responder
  - name: copy
    value: {{ copy }}
    description: |
      If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address
  - name: copy_to
    value: "{{ copy_to }}"
    description: |
      Account where copy emails
  - name: from
    value: "{{ from }}"
    description: |
      Date of start responder
  - name: to
    value: "{{ to }}"
    description: |
      Date of end responder

UPDATE examples

update

Update a responder. Changes the content of the automatic reply and the dates it is active (from, to) for the email account.

UPDATE ovh.email_domain.responders
SET 
content = '{{ content }}',
from = '{{ from }}',
to = '{{ to }}'
WHERE 
account = '{{ account }}' --required
AND domain = '{{ domain }}' --required;

DELETE examples

delete

Delete a responder. Removes the automatic reply of the email account and returns the task. Follow it under task/responder/{id}.

DELETE FROM ovh.email_domain.responders
WHERE account = '{{ account }}' --required
AND domain = '{{ domain }}' --required
;