Mail API: manage mailboxes automatically

If you look after many mailboxes, you do not want to create them one by one. From now on this works automatically: with the new Mail API you create, change, deactivate and delete the mailboxes of your hosting directly from your own programs and scripts, including aliases and forwarding. The Mail API works on all our hosting servers, Linux and Windows, and is free of charge.

Mailbox icon

Manage mailboxes automaticallyCreate, change password and storage, deactivate, reactivate and delete, plus aliases and forwarding.
Key icon

A key just for mailThe key is valid only for the hostings and domains you select. Your DNS key never opens your mailboxes.
Location icon

Can be limited to your serversOptionally a key only works from the IP addresses of your server. You receive a confirmation email for every new key.
Server icon

On all hosting serversLinux and Windows, at no extra cost and without moving. The limits of your hosting apply as usual.

How to set up the Mail API

In the customer area, enable API access under Account > Customer profile and click Manage API keys. Enter a label, choose the scope Mail (mailboxes) and the hostings you want. Optionally restrict the key to individual domains and to the IP addresses of your server. The key is shown once, note it down right away.

 

Interface for creating an API key with the scope MailNew in the customer area: create a key with the scope “Mail” for selected hostings

 

Built to be secure

The Plesk interface of the hosting servers remains closed to customers. On every call, the Mail API checks that the domain belongs to your active hosting and only allows a fixed set of mail functions. Failed logins block the sender IP, and every change is logged.

All endpoints and examples are in the Mail API knowledge base article. Developers can download the full description as an OpenAPI file.

Related Post