Skip to content

Responders

All operations require authentication.

5 operationsv1/email/domain
Agent setup

List respondersProduction

GET
/1.0/email/domain/{domain}/responder

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

Path parameters

domain
required
string

Name of your domain name

Query parameters

account
string

Responder name

Response

200string[]successful operation

Example uses domain = string

$ curl https://api.eu.ovhcloud.com/1.0/email/domain/{domain}/responder \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a responderProduction

GET
/1.0/email/domain/{domain}/responder/{account}

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

Path parameters

account
required
string

Name of account

domain
required
string

Name of your domain name

Response

200Respondersuccessful operation
account
read-only
string

Name of account

content
string

Content of responder

copy
read-only
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

copyTo
read-only
string

Account where copy emails

from
stringdate-time

Date of start responder

to
stringdate-time

Date of end responder

Example uses account = string, domain = string

$ curl https://api.eu.ovhcloud.com/1.0/email/domain/{domain}/responder/{account} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "account": "string", "content": "string", "copy": true, "copyTo": "string", "from": "2024-01-01T12:00:00Z", "to": "2024-01-01T12:00:00Z"}

Create a responderProduction

POST
/1.0/email/domain/{domain}/responder

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.

Path parameters

domain
required
string

Name of your domain name

Request body (required)

account
required
string

Account of domain

content
required
string

Content of responder

copy
required
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

copyTo
string

Account where copy emails

from
stringdate-time

Date of start responder

to
stringdate-time

Date of end responder

Response

200TaskSpecialAccountsuccessful operation
account
read-only
string

Account name of task

action
read-only
DomainSpecialAccountActionEnum

Action of task

Valuesaddchangedelete
date
read-only
stringdate-time

Creation date of task

domain
read-only
string

Domain name of task

id
read-only
integer

Id of task

type
read-only
DomainSpecialAccountTypeEnum

Type of action filter

Values25galiasdeletefilterforwardresponder

Example uses domain = string

$ curl https://api.eu.ovhcloud.com/1.0/email/domain/{domain}/responder \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}

Delete a responderProduction

DELETE
/1.0/email/domain/{domain}/responder/{account}

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

Path parameters

account
required
string

Name of account

domain
required
string

Name of your domain name

Response

200TaskSpecialAccountsuccessful operation
account
read-only
string

Account name of task

action
read-only
DomainSpecialAccountActionEnum

Action of task

Valuesaddchangedelete
date
read-only
stringdate-time

Creation date of task

domain
read-only
string

Domain name of task

id
read-only
integer

Id of task

type
read-only
DomainSpecialAccountTypeEnum

Type of action filter

Values25galiasdeletefilterforwardresponder

Example uses account = string, domain = string

$ curl https://api.eu.ovhcloud.com/1.0/email/domain/{domain}/responder/{account} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}

Update a responderProduction

PUT
/1.0/email/domain/{domain}/responder/{account}

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

Path parameters

account
required
string

Name of account

domain
required
string

Name of your domain name

Request body (required)

account
read-only
string

Name of account

content
string

Content of responder

copy
read-only
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

copyTo
read-only
string

Account where copy emails

from
stringdate-time

Date of start responder

to
stringdate-time

Date of end responder

Response

200—successful operation

Example uses account = string, domain = string

$ curl https://api.eu.ovhcloud.com/1.0/email/domain/{domain}/responder/{account} \
  -H "authorization: Bearer $OVH_TOKEN"