Create email account forwarder
This function creates an email forwarder.
Important:
When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.
Query parameters
The domain.
The email address to forward.
The method to use to handle the email address's mail.
The failure message for the message's sender.
Note:
Use this parameter if you used the fail method for the fwdopt parameter.
The email address to which the system forwards messages.
Note:
You must use this parameter if you used the fwd method for the fwdopt parameter. You can pass multiple addresses to this parameter as a comma-separated list.
The system user to whom the system forwards messages.
Note:
You must use this parameter if you used the system method for the fwdopt parameter.
The application to which the system pipes messages.
Note:
You must use this parameter if you used the pipe method for the fwdopt parameter.
Important:
This parameter requires the FileStorage role. For more information, read our How to Use Server Profiles documentation.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "add_forwarder",
"module": "Email",
"result": {
"data": [
{
"domain": "example.com",
"email": "user@example.com",
"forward": "fwdtome@example.com"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}