delegated_account_responders

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

Overview

Name	delegated_account_responders
Type	Resource
Id	ovh.email_domain.delegated_account_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 true, emails will be copy to emailToCopy 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	email		Get a delegated account responder. Returns the content, the start and end dates and the copy settings of the responder of the delegated email account.
create	insert	email, content, copy		Create a delegated account responder. Creates the automatic reply of the delegated email account with its content and optional start and end dates, and returns the task. Set copy to true to copy the emails to copyTo.
update	update	email		Update a delegated account responder. Updates the content and the start and end dates of the responder.
delete	delete	email		Delete a delegated account responder. Removes the automatic reply of the delegated email account 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"}})
email	string	Email

SELECT examples

get

Get a delegated account responder. Returns the content, the start and end dates and the copy settings of the responder of the delegated email account.

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

INSERT examples

create

Create a delegated account responder. Creates the automatic reply of the delegated email account with its content and optional start and end dates, and returns the task. Set copy to true to copy the emails to copyTo.

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

Manifest

# Description fields are for documentation purposes
- name: delegated_account_responders
props:
  - name: email
    value: "{{ email }}"
    description: Required parameter for the delegated_account_responders resource.
  - name: content
    value: "{{ content }}"
    description: |
      Content of responder
  - name: copy
    value: {{ copy }}
    description: |
      If true, emails will be copy to emailToCopy 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 delegated account responder. Updates the content and the start and end dates of the responder.

UPDATE ovh.email_domain.delegated_account_responders
SET 
content = '{{ content }}',
from = '{{ from }}',
to = '{{ to }}'
WHERE 
email = '{{ email }}' --required;

DELETE examples

delete

Delete a delegated account responder. Removes the automatic reply of the delegated email account and returns the task.

DELETE FROM ovh.email_domain.delegated_account_responders
WHERE email = '{{ email }}' --required
;