8

Plugins

Rob Lister edited this page 2023-03-27 14:39:53 +01:00

Table of Contents

• Default Plugins
• Activating Plugins
• Plugin Development

Roundcube Mail comes with many useful plugins, which extend its functionality. There are also many third-party plugins, which can be found at Roundcube Plugins.

Default Plugins

Below is a table of the names and descriptions of the default plugins, which can be found here.

Name	Description
acl	Allows mailbox access control lists to be managed
additional_message_headers	Adds additional or removes headers from outgoing mail
archive	Adds a button that lets a user move mail to a specified archive folder
attachment_reminder	Reminds a user to attach files to their email
autologon	Performs an automatic login if accessed from localhost
database_attachments	Provides database-backed storage for temporary attachment handling
debug_logger	Enhances logging for debugging purposes
emoticons	Replaces emoticons in plain-text messages with real icons
enigma	Adds support for viewing and sending PGP signed/encrypted mail
example_addressbook	Sample plugin that implements a hard-coded list of contacts
filesystem_attachments	Adds basic, filesystem-based temporary attachment handling
help	Add help taskbar button / link to docs
hide_blockquote	Add possibility to hide long blocks of cited text in messages
http_authentication	Make use of an existing HTTP authentication and perform login with the existing user credentials
identicon	Display unique github-like identification icons for contacts/addresses that do not have a photo image
identity_select	Identity selection based on additional message headers
jqueryui	Provide the jQuery UI library with according themes
krb_authentication	Kerberos authentication. Login with existing user credentials
managesieve	Allows to manage Sieve filters in a visual UI using the managesieve protocol
markasjunk	Adds "mark as (not) spam" buttons to the message menu
new_user_dialog	Present identities settings dialog to new users
new_user_identity	Populates a new user's default identity from LDAP on their first visit
newmail_notifier	Plays a sound or shows desktop notifications when new messages arrive
password	Change user password using many via Settings using many methods (drivers)
redundant_attachments	Provides a redundant storage (database/memcache/redis) for temporary uploaded attachment files
show_additional_headers	Fetch additional headers and display them in the message view
squirrelmail_usercopy	Copy a new users identities and contacts from a nearby Squirrelmail installation
subscriptions_option	Enable or disable the use of imap subscriptions per-user or globally
userinfo	Adds a tab to settings to display information about the current user
vcard_attachments	Detects VCard attachments and show a button to add them to address book
virtuser_file	File based User-to-Email and Email-to-User lookup
virtuser_query	DB based User-to-Email and Email-to-User lookup
zipdownload	Download all attachments of a message or a selection of messages as Zip archive

Activating Plugins

A plugin is not loaded until you enable it by adding its directory name to the config option plugins, as an array element. This is done by editing your local config/config.inc.php file.

For example, to enable plugins named additional_message_headers and archive, config/config.inc.php should contain this line:

    $config['plugins'] = array('additional_message_headers', 'archive');

To disable a plugin, just remove it from the list.

Plugin Development

To learn more about developing plugins for Roundcube, see Plugin API.