Permalink
Browse files

Clarify supported and unsupported features in the README

It was not totally clear what the plugin does and what it does not do.
Attempt to clean up the README to make this clearer.

Fixes #3.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
  • Loading branch information...
1 parent 6f01444 commit 9296db97dc6888913286c1341c739544ac269f92 @kevinoid committed Feb 9, 2014
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.txt
View
12 README.txt
@@ -6,6 +6,10 @@ or POP3. It forwards authentication credentials provided by the user to a
mail server, then relays the authentication decision of the mail server back
to Joomla!.
+In simpler terms, it lets Joomla! users use the same username and password
+that they use for email without the need to copy and synchronize the accounts
+manually.
+
This plugin currently supports the following features:
* Fully localizable
* Set user email account based on configurable mail domain.
@@ -15,6 +19,14 @@ This plugin currently supports the following features:
* Support for TLS (optional or required) and SSL
* Optional validation of SSL certificate from mail server
+Currently unsupported features:
+ * Does not integrate email/webmail into Joomla! or provide Single Sign-On
+ (SSO) between email/webmail and Joomla! Meaning users will still need to
+ login to both Joomla! and email/webmail separately.
+ * Authentication against multiple mail servers. Currently this plugin only
+ supports authentication against a single mail server (although the address
+ to which it connects may be load-balanced to multiple servers transparently).
+
Installation instructions are available in INSTALL.txt.
Major changes are listed in ChangeLog.txt.
Complete license text is available in COPYING.txt.

0 comments on commit 9296db9

Please sign in to comment.