Address Rewriting

Create Recipient Map

Using this endpoint you can create a recipient map to forward all mails from one email address to another.

post/api/v1/add/recipient_map

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

activenumber

1 for a active user account 0 for a disabled user account

recipient_map_newstring

the email address that should receive the forwarded emails

recipient_map_oldstring

the email address which emails should be forwarded

Example request

{
  "active": "1",
  "recipient_map_new": "target@mailcow.tld",
  "recipient_map_old": "recipient@mailcow.tld"
}

Response

OK

type'success' | 'danger' | 'error'

Changes

No recorded changes to this operation across all 55 revisions of this API.