Aleksander Machniak
2014-11-20 0b36d151572e050b51d82e7429fee847ebb33e22
plugins/password/README
@@ -42,6 +42,8 @@
 2.16. DBMail (dbmail)
 2.17. Expect (expect)
 2.18. Samba (smb)
 2.19. Vpopmail daemon (vpopmaild)
 2.20. Plesk (Plesk RPC-API)
 3. Driver API
@@ -63,7 +65,7 @@
 -------------------
 You can specify which database to connect by 'password_db_dsn' option and
 what SQL query to execute by 'password_query'. See main.inc.php.dist file for
 what SQL query to execute by 'password_query'. See config.inc.php.dist file for
 more info.
 Example implementations of an update_passwd function:
@@ -246,7 +248,7 @@
 This driver is fully compatible with the ldap driver, but
 does not require (or uses) the
    $rcmail_config['password_ldap_force_replace'] variable.
    $config['password_ldap_force_replace'] variable.
 Other advantages:
    * Connects only once with the LDAP server when using the search user.
    * Does not read the DN, but only replaces the password within (that is
@@ -299,13 +301,41 @@
 Driver to change Samba user password via the 'smbpasswd' command.
 See config.inc.php.dist file for configuration description.
 2.19. Vpopmail daemon (vpopmaild)
 -----------------------------------
 Driver for the daemon of vpopmail. Vpopmail is used with qmail to
 enable virtual users that are saved in a database and not in /etc/passwd.
 Set $config['password_vpopmaild_host'] to the host where vpopmaild runs.
 Set $config['password_vpopmaild_port'] to the port of vpopmaild.
 Set $config['password_vpopmaild_timeout'] to the timeout used for the TCP
 connection to vpopmaild (You may want to set it higher on busy servers).
 2.20. Plesk (Plesk RPC-API)
 ---------------------------
 Driver for changing Passwords via Plesk RPC-API. This Driver also works with
 Parallels Plesk Automation (PPA).
 You need to allow the IP of the Roundcube-Server for RPC-Calls in the Panel.
 Set $config['password_plesk_host'] to the Hostname / IP where Plesk runs
 Set your Admin or RPC User: $config['password_plesk_user']
 Set the Password of the User: $config['password_plesk_pass']
 Set $config['password_plesk_rpc_port']  for the RPC-Port. Usually its 8443
 Set the RPC-Path in $config['password_plesk_rpc_path']. Normally this is: enterprise/control/agent.php.
 3. Driver API
 -------------
 Driver file (<driver_name>.php) must define 'password_save' function with
 two arguments. First - current password, second - new password. Function
 should return PASSWORD_SUCCESS on success or any of PASSWORD_CONNECT_ERROR,
 Driver file (<driver_name>.php) must define rcube_<driver_name>_password class
 with public save() method that has two arguments. First - current password, second - new password.
 This method should return PASSWORD_SUCCESS on success or any of PASSWORD_CONNECT_ERROR,
 PASSWORD_CRYPT_ERROR, PASSWORD_ERROR when driver was unable to change password.
 Extended result (as a hash-array with 'message' and 'code' items) can be returned
 too. See existing drivers in drivers/ directory for examples.