register plugin



drivers configuration | iRedMail guide

Register plugin

downloaded

register plugin
Register plugin allows self-registering new user accounts (mailboxes) through Roundcube Webmail. In conjunction with Taskbar Plugin, registration links appear at the top right of your webmail login page.

Requirements

Roundcube Webmail 0.8.x – 0.9.x and newer
PHP 5.2.17 – 5.4.x
taskbar plugin

‘Register’ uses several back-ends (drivers) for accounts registration

Driver
Driver Name
Status
hMailServer hmail_sql_db production
cPanel cpanel production
Postfix Admin postfixadmin_db production
ISPConfig ispconfig_xxxx_v#.# Third Party development. We are not the developers of this driver. We do not offer support for it, not we make any claims that it will work in your ISPConfig server. For questions related to this specific driver, please contact its developer.
plugin_manager plugin
plugin_manager plugin

Installation


register plugin can be downloaded from Plugin Manager Center. Upload the register plugin folder downloaded from our mirror servers (after you’ve un-zipped it) into Roundcube’s ./plugins folder and proceed to configure the plugin as usual.

register plugin requires taskbar plugin to be present and enabled in your installation.

Configure ‘register’ plugin


  • make a copy of config.inc.php.dist file in its same directory and rename the new file to config.inc.php
  • edit the new created config file ./plugins/register/config.inc.php
    • set the driver name to be used for registering new users
    • set the default domain name and other domains if available
    • set disallowed accounts’ names which can’t be used when registering new users
    • set the minimum password length policy for new users

Sample config.inc.php configuration:

/* driver */
$rcmail_config['register_driver'] = 'hmail_sql_db_5320';

/* here go your domains where users can sign up */

$rcmail_config['webadddoms']['default'][] = "myroundcube.com";
//$rcmail_config['webadddoms']['default'][] = "xn--ber-goa.net"; // ьber.net => IDN converted !!!
$rcmail_config['webadddoms']['other'][]   = "dom3.com";

/* Disallowed accounts */
$rcmail_config['disallowedaccounts'] = array(
        0 => 'postmaster',
        1 => 'abuse',
        2 => 'webmaster',
        3 => 'payment',
        4 => 'billing',
        5 => 'noreply',
        6 => 'admin',
        7 => 'administrator'
);

/* Password min length */
$rcmail_config['password_min_length'] = 6;

Configure ‘register’ backend driver


  • make a copy of …/plugins/register/drivers/driver_name/config.inc.php.dist configuration file in its same directory and rename the new file to config.inc.php
  • edit the new created config file …/plugins/register/drivers/driver_name/config.inc.php
  • set the database settings such as host, port, database username, database password and database name where new users will be saved into. ( please, note that the database must exist and the database user defined in your configuration must have read and write privileges to the specified database)
  • set the mailbox size limit for new users
  • *set miscellaneous driver options if available ( see comments in the config file for details )

Sample driver configuration:

// driver hmail 5.3.2

/* hMailserver database settings */
$rcmail_config['db_dsnw_hmailserver'] = 'mysql://user:password@localhost/database_name?new_link=true';

/* Mailbox Limit (MB, 0 = unlimited) */
$rcmail_config['mailbox_limit'] = 10;

/* Plus Addressing */
$rcmail_config['pladdrstr']['mail4us.net'] = "+"; // + - _ % is allowed
                                      // see hmailserver plus addressing manual (default "+" => replaced by "_")
                                      //                                        (        "_" => replaced by "-")
Optional but highly recommended, it’s the use of captcha plugin when you have registration enabled in your installation. Captcha plugin will put in place an extra layer of security to prevent bots from messing with your registration form.

Configure ‘register’ backend driver in global_config configuration


register plugin driver must be loaded from global_config configuration file if you are implementing global_config plugin in your Roundcube installation.

Instead of making a copy of ./plugins/register/drivers/driver_name/config.inc.php.dist configuration file in its same directory and rename it to config.inc.php, just open ./plugins/register/drivers/driver_name/config.inc.php.dist and copy its configuration content into ./plugins/global_config/config.inc.php as you would do with all other plugins once global_config is implemented.