This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
plugins:roundcubeplugins [2015/09/29 12:23] mrpink [Requirements] |
plugins:roundcubeplugins [2017/11/13 04:11] (current) nuxwin |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======RoundcubePlugins Plugin Documentation====== | + | <WRAP center round important 60%> |
+ | **Bear in mind that this documentation is for the last released version. If you use an older version, you must refer to the README.md file inside the plugin archive.** | ||
+ | </WRAP> | ||
- | Plugin allows to use Roundcube Plugins with i-MSCP. | + | See https://github.com/i-MSCP/plugins/blob/23d7e787ce820e112c9238a66c94d0cc8625586e/incubator/RoundcubePlugins/README.md |
- | + | ||
- | ===== Included Roundcube Plugins ===== | + | |
- | + | ||
- | ==== additional_message_headers ==== | + | |
- | + | ||
- | Adds a header identifying the originating ip for the mails sent via webmail. | + | |
- | + | ||
- | ==== archive ==== | + | |
- | + | ||
- | Archive plugin adds a new button to the Roundcube toolbar to move messages to an (user selectable) archive folder. The button will only appear after the user configured the Archive folder. | + | |
- | + | ||
- | Roundcube user config: Settings -> Preferences -> Special Folders -> Archive | + | |
- | + | ||
- | ==== calendar ==== | + | |
- | + | ||
- | Calendar plugin is a full calendar for Roundcube. | + | |
- | + | ||
- | Roundcube user config: Settings -> Preferences -> Calendar | + | |
- | + | ||
- | ==== contextmenu ==== | + | |
- | + | ||
- | Adds context menus to the message list, folder list and address book. | + | |
- | Possibility to mark mails as read/unread, delete, reply and forward mails. | + | |
- | + | ||
- | ==== dkimstatus ==== | + | |
- | + | ||
- | Displays the DKIM Signature status of each mail in Roundcube. | + | |
- | + | ||
- | ==== emoticons ==== | + | |
- | + | ||
- | Emoticons inserts nice smileys and other emoticons when the appropriate text representations e.g. :-) are discovered in the mail text. | + | |
- | + | ||
- | ==== logon_page ==== | + | |
- | + | ||
- | Allows to display additional information (HTML code block) at logon page. | + | |
- | Configuration: Put your content into the file config-templates/logon_page/logon_page.html. It will be parsed by Roundcube templates engine, so you can use all template features (tags). | + | |
- | + | ||
- | ==== managesieve ==== | + | |
- | + | ||
- | Uses the managesieve protocol and allows the user to manage his sieve mail rules. A default Spam sieve rule will be created after the user opened the Filters configuration in Roundcube. | + | |
- | + | ||
- | Roundcube user config: Settings -> Filters | + | |
- | + | ||
- | ==== newmail_notifier ==== | + | |
- | + | ||
- | Can notify on new mails by focusing browser window and changing favicon, playing a sound and displaying desktop notification (using webkitNotifications feature). | + | |
- | + | ||
- | Roundcube user config: Settings -> Preferences -> Mailbox View | + | |
- | + | ||
- | ==== pdfviewer ==== | + | |
- | + | ||
- | Roundcube inline pdf viewer. | + | |
- | + | ||
- | ==== pop3fetcher ==== | + | |
- | + | ||
- | Plugin pop3fetcher allows to add pop3 accounts and automatically fetch emails from them. | + | |
- | + | ||
- | Roundcube user config: Settings -> Preferences -> Other Accounts | + | |
- | + | ||
- | ==== tasklist ==== | + | |
- | + | ||
- | Task management plugin for Roundcube. | + | |
- | + | ||
- | ==== zipdownload ==== | + | |
- | + | ||
- | Adds an option to download all attachments of a message in one zip file. | + | |
- | + | ||
- | + | ||
- | ===== Requirements ===== | + | |
- | + | ||
- | * i-MSCP versions >= 1.2.3 | + | |
- | * Dovecot | + | |
- | * Roundcube 1.x | + | |
- | * See installation section for required software packages. | + | |
- | + | ||
- | ===== Installation ===== | + | |
- | + | ||
- | **1. Install the needed Debian / Ubuntu packages** | + | |
- | + | ||
- | Only necessary if you want to use the Roundcube Plugin managesieve. | + | |
- | + | ||
- | **Attention:** Debian Squeeze and Ubuntu Lucid have these binares included with the dovecot package. So on Squeeze and Lucid you don't need to install anything. | + | |
- | + | ||
- | # aptitude update | + | |
- | # aptitude install dovecot-sieve dovecot-managesieved | + | |
- | + | ||
- | **2. Get the plugin from Plugin Store** | + | |
- | + | ||
- | http://i-mscp.net/filebase/index.php/Filebase/ | + | |
- | + | ||
- | **3. Plugin upload and installation** | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Upload the RoundcubePlugins plugin archive | + | |
- | * Install the plugin | + | |
- | + | ||
- | ===== Update ===== | + | |
- | + | ||
- | **1. Get the plugin from Plugin Store** | + | |
- | + | ||
- | http://i-mscp.net/filebase/index.php/Filebase/ | + | |
- | + | ||
- | **2. Backup your current plugin config** | + | |
- | + | ||
- | # plugins/RoundcubePlugins/config.php | + | |
- | # plugins/RoundcubePlugins/config-templates/logon_page/logon_page.html | + | |
- | + | ||
- | **3. Plugin upload and update** | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Upload the RoundcubePlugins plugin archive | + | |
- | * Update the plugin list | + | |
- | + | ||
- | ===== Configuration ===== | + | |
- | + | ||
- | For the different configuration options please check the plugin config file. | + | |
- | + | ||
- | # plugins/RoundcubePlugins/config.php | + | |
- | + | ||
- | After you made your config changes, don't forget to update the plugin list. | + | |
- | + | ||
- | * Login into the panel as admin and go to the plugin management interface | + | |
- | * Update the plugin list | + | |
- | + | ||
- | ===== Authors ===== | + | |
- | + | ||
- | * Rene Schuster <[email protected]> | + | |
- | * Sascha Bay <info@space2place.de> | + |