This function restores an account's email filters.
Important:
When the Receive Mail role is disabled, the system also disables this function.
Note:
You must use the backup
parameter when you call this function in one of the following formats:
multipart/form-data
request body to upload and restore a backup file to the server.backup | string The email filter file to restore. Important: Only pass this parameter to restore email filter files that already exist on the server. Note: To restore multiple email filter files, increment the parameter name. For example: backup backup |
timeout | integer Default: The maximum number of seconds to try to restore the file.
Example: |
verbose | integer Default: Whether to return additional information from the
Example: |
The email filter file to upload and restore.
Important:
Note:
backup-1
, backup-2
, and backup-3
.backup | string |
HTTP Request was successful.
apiversion | integer The version of the API. |
func | string The name of the method called. |
module | string The name of the module called. |
object |
uapi --input=json --output=jsonpretty \ --user=username \ Backup \ restore_email_filters
{- "apiversion": 3,
- "func": "restore_email_filters",
- "module": "Backup",
- "result": {
- "data": {
- "log_id": "2019-08-13T15:10:07Z.1",
- "log_path": "/home/cpuser/.cpanel/logs/restore-email-filters/2019-09-11T18:30:49Z.1.log",
- "messages": [
- "The system successfully restored the email filters from the 'filter-info.user.yaml.gz' backup."
]
}, - "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}