Responders
All operations require authentication.
List respondersProduction
List responders. Returns the account names of the responders of the domain. Filter them by account.
Path parameters
Name of your domain name
Query parameters
Responder name
Response
Example uses domain = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ domain/ {domain}/ responder \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get a responderProduction
Get a responder. Returns the account, content, start and end dates and copy settings of the responder.
Path parameters
Name of account
Name of your domain name
Response
Name of account
Content of responder
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
Account where copy emails
Date of start responder
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"{ "account": "string", "content": "string", "copy": true, "copyTo": "string", "from": "2024-01-01T12:00:00Z", "to": "2024-01-01T12:00:00Z"}
Create a responderProduction
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
Name of your domain name
Request body (required)
Account of domain
Content of responder
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
Account where copy emails
Date of start responder
Date of end responder
Response
Account name of task
Action of task
addchangedeleteCreation date of task
Domain name of task
Id of task
Type of action filter
25galiasdeletefilterforwardresponderExample uses domain = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ domain/ {domain}/ responder \
-H "authorization: Bearer $OVH_TOKEN"{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}
Delete a responderProduction
Delete a responder. Removes the automatic reply of the email account and returns the task. Follow it under task/responder/{id}.
Path parameters
Name of account
Name of your domain name
Response
Account name of task
Action of task
addchangedeleteCreation date of task
Domain name of task
Id of task
Type of action filter
25galiasdeletefilterforwardresponderExample uses account = string, domain = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ domain/ {domain}/ responder/ {account} \
-H "authorization: Bearer $OVH_TOKEN"{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}
Update a responderProduction
Update a responder. Changes the content of the automatic reply and the dates it is active (from, to) for the email account.
Path parameters
Name of account
Name of your domain name
Request body (required)
Name of account
Content of responder
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
Account where copy emails
Date of start responder
Date of end responder
Response
Example uses account = string, domain = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ domain/ {domain}/ responder/ {account} \
-H "authorization: Bearer $OVH_TOKEN"