Search for duplicate or closed feature requests

Oct 13, 2025 by magicalceylontours.com 145 views

Introduction

In today's digital age, email security and convenience are paramount. With the increasing number of online threats, it's essential to have robust password management systems in place. Roundcube, a popular web-based email client, offers a password change plugin that allows users to update their passwords securely. However, to cater to the diverse needs of users, a Migadu driver for the password change plugin is proposed. This driver will enable users to change their email passwords via the Migadu API, providing an additional layer of security and convenience.

Prerequisites

Before embarking on this project, it's essential to ensure that the following prerequisites are met:

Search for duplicate or closed feature requests: Conduct a thorough search on the Roundcube GitHub issues page to determine if a similar feature request has already been proposed or closed.
Search for existing plugins: Visit the Roundcube plugins repository to check if any existing plugins provide the desired feature.

Proposal

The proposed Migadu driver for the password change plugin is designed to change email passwords via the Migadu API. This driver is built with the Rainloop password plugin as a reference, and it's essential to note that it's provided entirely at the user's own risk.

Installation

To install the Migadu driver, follow these steps:

Save the provided code as migadu.php in the plugins/password/driver folder.
Edit the plugins/password/config.inc.php file to set the following values:
- $config['password_driver'] = 'migadu'
- $config['password_username_format'] = %l; (Note: This is a lower-case L. The username needs to be local for this to work.)
Add the following configuration settings to the plugins/password/config.inc.php file:
- $config['password_migadu_url'] = 'https://api.migadu.com/v1/domains/mydomain.com/mailboxes/'; (Replace mydomain.com with the mail domain of your email accounts.)
- $config['password_migadu_adminuser'] = 'adminuser@mydomain.com'; (Replace adminuser@mydomain.com with your Migadu admin account email.)
- $config['password_migadu_apitoken'] = 'api-token'; (Replace api-token with your Migadu API token.)
Test the driver to ensure it's functioning correctly.

Migadu Driver Code

The Migadu driver code is provided below:

/**
 * Roundcube password driver for Migadu
 *
 * This driver changes the e-mail password via Migadu https API.
 * written with liberal cut and paste from the rainloop password plugin https://git.sr.ht/~migadu/migadu-rainloop-password-change. 
 * Use entirely at your own risk!!!
 *
 * INSTALL
 * 1. save this file as migadu.php in plugins/password/driver folder
 * 2. edit plugins/password/config.inc.php
 * set these two values near the top of plugins/password/config.inc.php
 *     $config['password_driver'] = 'migadu'
 *     $config['password_username_format'] = %l; **that's a lower-case L. username needs to be local for this to work
 * Add the following somewhere in plugins/password/config.inc.php
 *   $config['password_migadu_url']  = 'https://api.migadu.com/v1/domains/mydomain.com/mailboxes/; // be sure to change mydomain.com to the mail domain which your email accounts are in
 *   $config['password_migadu_adminuser']    = 'adminuser@mydomain.com'; // that's your Migadu admin account email
 *   $config['password_migadu_apitoken']    = 'api-token';  // you need to set one up in Migadu
 * 3. test
 */

class rcube_migadu_password
{
    /**
     * This method is called from roundcube to change the password
     * @param string $currpass Current password
     * @param string $newpass  New password
     * @param string $username Login username
     * @return int PASSWORD_SUCCESS|PASSWORD_CONNECT_ERROR
     */
    public function save($curpass, $newpass, $username)
    {

        $rcmail = rcmail::get_instance();
        $client = password::get_http_client();
        // Get configuration
        $password_migadu_url = $rcmail->config->get('password_migadu_url');
        $password_migadu_adminuser = $rcmail->config->get('password_migadu_adminuser');
        $password_migadu_apitoken = $rcmail->config->get('password_migadu_apitoken');
        $expect = 'name'; // this is just a quick fix because when a succesful change is made migadu reports back a load of things including 'name';
        $url = $password_migadu_url.$username;
                $aPayload = json_encode(array('password' => $newpass));

                $aOptions = array(
                                CURLOPT_URL => $url,
                                CURLOPT_HEADER => false,
                                CURLOPT_FAILONERROR => true,
                                CURLOPT_SSL_VERIFYPEER => false,
                                CURLOPT_RETURNTRANSFER => true,
                                CURLOPT_HTTPHEADER => array('Content-Type:application/json'),
                                CURLOPT_POST => true,
                                CURLOPT_CUSTOMREQUEST => "PUT",
                                CURLOPT_POSTFIELDS => $aPayload,
                                CURLOPT_TIMEOUT => 20,
                                CURLOPT_SSL_VERIFYHOST => false,
                                CURLOPT_USERPWD => $password_migadu_adminuser.':'.$password_migadu_apitoken
                        );
        $oCurl = \curl_init();
                        \curl_setopt_array($oCurl, $aOptions);
        $result = \curl_exec($oCurl);

        // If configured, check the body of the response
        if ($expect && stripos($result,$expect)==false) {
            rcube::raise_error('Password plugin: Unexpected response body: ' . substr($result, 0, 1024), true);
            return PASSWORD_ERROR;
        }
        return PASSWORD_SUCCESS;
    }
}

Motivation and Context

The motivation behind creating a Migadu driver for the password change plugin is to provide users with an additional layer of security and convenience. With the increasing number of online threats, it's essential to have robust password management systems in place. The Migadu driver will enable users to change their email passwords via the Migadu API, providing an additional layer of security and convenience.

Conclusion

Introduction

In our previous article, we introduced the Migadu driver for the password change plugin, a feature that enables users to change their email passwords via the Migadu API. In this article, we'll address some frequently asked questions (FAQs) about the Migadu driver to provide a better understanding of its functionality and benefits.

Q: What is the Migadu driver, and how does it work?

A: The Migadu driver is a plugin for the Roundcube password change plugin that allows users to change their email passwords via the Migadu API. It works by sending a request to the Migadu API with the user's new password, which is then updated in the user's account.

Q: What are the benefits of using the Migadu driver?

A: The Migadu driver provides several benefits, including:

Improved security: By using the Migadu API to change passwords, users can ensure that their passwords are updated securely and efficiently.
Convenience: The Migadu driver eliminates the need for users to manually update their passwords, making it a convenient feature for users.
Compatibility: The Migadu driver is compatible with the Roundcube password change plugin, making it a seamless integration for users.

Q: How do I install the Migadu driver?

A: To install the Migadu driver, follow these steps:

Save the provided code as migadu.php in the plugins/password/driver folder.
Edit the plugins/password/config.inc.php file to set the following values:
- $config['password_driver'] = 'migadu'
- $config['password_username_format'] = %l; (Note: This is a lower-case L. The username needs to be local for this to work.)
Add the following configuration settings to the plugins/password/config.inc.php file:
- $config['password_migadu_url'] = 'https://api.migadu.com/v1/domains/mydomain.com/mailboxes/'; (Replace mydomain.com with the mail domain of your email accounts.)
- $config['password_migadu_adminuser'] = 'adminuser@mydomain.com'; (Replace adminuser@mydomain.com with your Migadu admin account email.)
- $config['password_migadu_apitoken'] = 'api-token'; (Replace api-token with your Migadu API token.)
Test the driver to ensure it's functioning correctly.

Q: What are the system requirements for the Migadu driver?

A: The Migadu driver requires the following system requirements:

Roundcube: The Migadu driver is compatible with Roundcube version 1.4.10 or later.
PHP: The Migadu driver requires PHP version 7.2 or later.
Migadu API: The Migadu driver requires a valid Migadu API token to function.

Q: How do I troubleshoot issues with the Migadu driver?

A: To troubleshoot issues with the Migadu driver, follow these steps:

Check the Roundcube logs for any error messages related to the Migadu driver.
Verify that the Migadu API token is valid and correctly configured.
Check the Migadu API documentation for any changes or updates that may affect the Migadu driver.
Contact the Roundcube support team for further assistance.

Conclusion

In conclusion, the Migadu driver for the password change plugin provides a secure and convenient way for users to change their email passwords via the Migadu API. By addressing frequently asked questions, we hope to provide a better understanding of the Migadu driver's functionality and benefits. If you have any further questions or concerns, please don't hesitate to contact us.