Restore email forwarders

This function restores an account's email forwarders.

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:

  • As part of a multipart/form-data request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's POST Method documentation.
  • As a query parameter to restore an existing file on the server.
Authorizations:
query Parameters
backup
string

The email forwarder file to restore.

Important:

Only pass this parameter to restore email forwarder files that already exist on the server.

Note:

To restore multiple email filter files, increment the parameter name. For example: backup-1, backup-2, and backup-3.

Examples:
backup=backup-1=/home/user/aliases-example1.com.gz backup-2=/home/user/aliases-example2.com.gz backup-3=/home/user/aliases-example3.com.gz
backup=/home/user/aliases-example.com.gz
timeout
integer >= 0
Default: 7200

The maximum number of seconds to try to restore the file.

  • 0 - The system will not time out the file restoration.
Example: timeout=3600
verbose
integer
Default: 0

Whether to return additional information from the /home/cpuser/.cpanel/logs/restore-email-forwarders log files.

  • 1 - Return additional information.
  • 0 - Do not return additional information.
Enum: 0 1
Example: verbose=1
Request Body schema: multipart/form-data

The email forwarder file to upload and restore.

Important:

  • Only pass this parameter to upload files that don't already exist on the server.
  • You can't pass this parameter on the command line.

Note:

To upload multiple email filter files, increment the parameter name. For example: backup-1, backup-2, and backup-3.

backup
string <binary>

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --input=json --output=jsonpretty \
  --user=username \
  Backup \
  restore_email_forwarders

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "restore_email_forwarders",
  • "module": "Backup",
  • "result": {
    • "data": {
      • "log_id": "2019-08-13T15:10:07Z.1",
      • "log_path": "/home/cpuser/.cpanel/logs/restore-email-forwarders/2019-09-11T18:30:49Z.1.log",
      • "messages": [
        • "The system successfully restored the email forwarders from the 'aliases-example.com.gz' backup."
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}