senior/roundcube-ident_switch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme rewritten.

Browse Source 
It's now sexy, contains images and explains settings!
This commit is contained in:
Boris Gulay
2019-01-12 15:51:30 +03:00
parent f164ccfd05
commit a062f5ebb5
1 changed files with 26 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -1,21 +1,36 @@
# ident_switch
ident_switch plugin for Roundcube
This plugin allows users to switch between different accounts (including remote) in single Roundcube session.
This plugin allows users to switch between different accounts (including remote) in single Roundcube session like this:
![Screenshot example](https://i.imgur.com/rRIqtA8.jpg)
*Inspired by identities_imap plugin that is no longer supported.*
### Where to start ###
* In settigs interface create new identity.
* For all identities except default you will see new section of settings - IMAP. Enter data required to connect to remote server. Don't forget to check Enabled check box.
* After you have created at least one identity with active IMAP settings you will see combobox in the top right corner instead of plain text field with account name. It will allows you to switch to another account.
* In settings interface create new identity.
* For all identities except default you will see new section of settings - "Plugin ident_switch" (see screenshot below). Enter data required to connect to remote server. Don't forget to check Enabled check box.
* After you have created at least one identity with active plugin you will see combobox in the top right corner instead of plain text field with account name. It will allows you to switch to another account.
### Settings ###
![Plugin settings](https://i.imgur.com/hguQsUV.jpg)
* **Enabled** - enables plugin (i.e. account switcing) for this identity.
* **Label** - text that will be displayed in drop down list for this identity. If left blank email will be used.
* **IMAP**
* **Server host name** - host name for imap server. If left blank 'localhost' will be used.
* **Port** - port on server to connect to. If left blank 143 will be used.
* **Secure connection** - enabled secure connection (TLS) *for both IMAP and SMTP*.
* **Username** - login used *for IMAP and SMTP servers*.
* **Password** - password used *for IMAP and SMTP servers*. It's stored encrypted in database.
* **SMTP**
* **Server host name** - host name for imap server. If left blank 'localhost' will be used.
* **Port** - port on server to connect to. If left blank 587 will be used.
### Version compatibility ###
* Branch 1.X - for Roundcube v1.1
* Branch 2.X - for Roundcube v1.2
* Branch 3.X - for Roundcube v1.3
* Versions 1.X (not supported any more) - for Roundcube v1.1
* Versions 2.X (not supported any more) - for Roundcube v1.2
* Versions 3.X (not supported any more) - for Roundcube v1.3
* Versions 4.x - for Roundcube v1.3 and upcoming 1.4.
Please specify verion like "~2.0" in your composer.json file for ident_switch requirement. In this case you will stay inside compatible branch until you manually update ypur Roundcube installation.
### Switching SMTP ###
Plugin also switched SMTP credentials but only for server specified in general config. You should use %u and %p substitutions for user and password to make it work. This substitutions are replaced by username and password for selected IMAP account.
Please specify version like "~2.0" in your composer.json file for ident_switch requirement. In this case you will stay inside compatible branch until you manually update your Roundcube installation.