Delegated Accounts
All operations require authentication.
List delegated accountsProduction
List delegated accounts. Returns the email addresses of the email accounts delegated to the customer account. Filter them by domain or accountName.
Query parameters
Name of email address
Domain of email address
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
Get a delegated accountProduction
Get a delegated account. Returns the email address, description, size in bytes, allowed sizes and blocked state of the delegated email account.
Path parameters
Response
Name of account
List of allowed sizes for this account in bytes
Account description
Name of domain
If true your account is blocked
Size of your account in bytes
Example uses email = string
$ curl https:/{ "accountName": "string", "allowedAccountSize": [ 0 ], "description": "string", "domain": "string", "email": "string", "isBlocked": true, "size": 0}
Update a delegated accountProduction
Update a delegated account. Updates the description or the size in bytes of the delegated email account. The allowed sizes are in allowedAccountSize.
Path parameters
Request body (required)
Name of account
List of allowed sizes for this account in bytes
Account description
Name of domain
If true your account is blocked
Size of your account in bytes
Response
Example uses email = string
$ curl https:/Change a delegated account passwordProduction
Change a delegated account password. Sets a new password and returns the task. The password needs 8 to 30 characters and no accents.
Path parameters
Request body (required)
New password
Response
Action of task
addAccountchangeAccountchangePassworddeleteAccountinternalMigrationmigrationtemporaryTaskunknownCreation date of task
Domain name of task
Id of task
Account name of task
Example uses email = string
$ curl https:/{ "action": "addAccount", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "name": "string"}
List filtersProduction
List filters. Returns the names of the filters of the delegated email account. Get one to read its action, priority and state.
Path parameters
Response
Example uses email = string
$ curl https:/[ "string"]
Get a filterProduction
Get a filter. Returns the account, priority, active state, action (accept, account, delete or redirect) and action parameter of the filter.
Path parameters
Filter name
Response
Action of filter
acceptaccountdeleteredirectAction parameter of filter
If true filter is active
Domain name of filter
Filter name
Account name of filter
Priority of filter
Example uses email = string, name = string
$ curl https:/{ "action": "accept", "actionParam": "string", "active": true, "domain": "string", "name": "string", "pop": "string", "priority": 0}
Create a filterProduction
Create a filter. Creates a filter with a rule on a header (operand and value), an action, a priority and an active state, and returns the task.
Path parameters
Request body (required)
Action of filter
acceptaccountdeleteredirectAction parameter of filter
If true filter is active
Header to be filtered
Filter name
Rule of filter
checkspfcontainsnoContainsPriority of filter
Rule parameter of filter
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Delete a filterProduction
Delete a filter. Removes the filter and its rules from the email account, and returns the tasks. Incoming emails are no longer filtered by it.
Path parameters
Filter name
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string, name = string
$ curl https:/[ { "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z" }]
Enable or disable a filterProduction
Enable or disable a filter. Set activity to true to apply the filter to incoming emails, or to false to suspend it.
Path parameters
Filter name
Request body (required)
New activity
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Change filter priorityProduction
Change filter priority. Sets the priority of the filter, which gives the order the filters of the account are applied in.
Path parameters
Filter name
Request body (required)
New priority
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
List filter rulesProduction
List filter rules. Returns the IDs of the rules of the filter. Get one to read the header it checks, its operand and its value.
Path parameters
Filter name
Response
Example uses email = string, name = string
$ curl https:/[ 0]
Get a filter ruleProduction
Get a filter rule. Returns the header, the operand (checkspf, contains or noContains) and the value of the rule.
Path parameters
Filter name
Response
Header to be filtered
Rule of filter
checkspfcontainsnoContainsRule parameter of filter
Example uses email = string, id = 0, name = string
$ curl https:/{ "header": "string", "id": 0, "operand": "checkspf", "value": "string"}
Create a filter ruleProduction
Create a filter rule. Adds a rule to the filter on a header, with an operand (checkspf, contains or noContains) and a value, and returns the task.
Path parameters
Filter name
Request body (required)
Header to be filtered
Rule of filter
checkspfcontainsnoContainsRule parameter of filter
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Delete a filter ruleProduction
Delete a filter rule. Removes the rule from the filter and returns the tasks. The filter keeps applying its other rules.
Path parameters
Filter name
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses email = string, id = 0, name = string
$ curl https:/[ { "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z" }]
Get a delegated account responderProduction
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.
Path parameters
Response
Name of account
Content of responder
If true, emails will be copy to emailToCopy address
Account where copy emails
Date of start responder
Date of end responder
Example uses email = string
$ curl https:/{ "account": "string", "content": "string", "copy": true, "copyTo": "string", "from": "2024-01-01T12:00:00Z", "to": "2024-01-01T12:00:00Z"}
Create a delegated account responderProduction
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.
Path parameters
Request body (required)
Content of responder
If true, emails will be copy to emailToCopy 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 email = string
$ curl https:/{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}
Delete a delegated account responderProduction
Delete a delegated account responder. Removes the automatic reply of the delegated email account and returns the task.
Path parameters
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 email = string
$ curl https:/{ "account": "string", "action": "add", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "type": "25g"}
Update a delegated account responderProduction
Update a delegated account responder. Updates the content and the start and end dates of the responder.
Path parameters
Request body (required)
Name of account
Content of responder
If true, emails will be copy to emailToCopy address
Account where copy emails
Date of start responder
Date of end responder
Response
Example uses email = string
$ curl https:/Refresh delegated account usageProduction
Refresh delegated account usage. Asks for the figures returned by usage to be recomputed; they are updated asynchronously.
Path parameters
Response
Example uses email = string
$ curl https:/Get delegated account usageProduction
Get delegated account usage. Returns the number of emails, the maximum size in bytes of the mailbox (quota) and the date of the measure.
Path parameters
Response
Timestamp
Number of message in mailbox
Size of mailbox (bytes)
Example uses email = string
$ curl https:/{ "date": "2024-01-01T12:00:00Z", "emailCount": 0, "quota": 0}