WebMail Lite Documentation

User signup on Fastpanel

Generally, WebMail Lite allows for accessing existing email accounts only; creating new mailboxes on mail servers is not available in the product as it's not supported by standard email protocols. Still, it's possible to implement user signup by integrating with specific server software directly. This module allows users to create new email accounts for themselves on Fastpanel.

If you have installed WebMail Lite from Git, you can follow the instructions for adding a module.

If you've installed the product from ZIP package, there's a simple approach available.

You will need to edit data/settings/modules/MailSignupFastpanel.config.json configuration file and supply the following settings:

  • "Disabled": set to false to enable the functionality;
  • "FastpanelURL": specify URL of your Fastpanel installation, e.g. http://yourdomain.com:8888;
  • "FastpanelAdminUser" and "FastpanelAdminPass": credentials of Fastpanel administrative account;
  • "UserDefaultQuotaMB": default mailbox size in Mbytes.

Signup itself is configured in a different file, data/settings/modules/MailSignup.config.json. Normally, you'll only need to set Disabled to false there, and supply a list of domains, e.g.:

"DomainList": [
    ["domain1.com", "domain2.com", "domain3.com"],
    "array",
    null,
    "Defines list of domains signup feature is available for" 
]

All the domains supplied need to be hosted by this particular server powered by Fastpanel, and the domains must be listed in "Mail Servers" section of WebMail Lite admin interface - the default approach with just one server and empty list of domains works too.

URL for signup page is obtained by appending #signup to the installation URL. For example, if you have WebMail Lite at http://domain1.com/mail/ the signup page would be http://domain1.com/mail/#signup and the interface would look like this:

Mail signup on cPanel

To complete the registration, user needs to supply display name, login and password. If DomainList has more than one entry, user can select one of those domains from the dropdown list. Upon successful signup, user will be redirected into their account in WebMail Lite interface.

NB: It is strongly recommended to enable reCAPTCHA module to prevent from automated signups.

While by default there's no link for signup page anywhere in WebMail Lite interface, you can add it to the bottom of login page. That's achieved by editing HTML text in BottomInfoHtmlText setting in data/settings/modules/StandardLoginFormWebclient.config configuration file.