https://github.com/kevinoid/auth-mailbox-joomla
Plugin for Joomla! to authenticate users against a mail server using IMAP, NNTP, or POP3.
https://github.com/kevinoid/auth-mailbox-joomla
joomla-plugin php
Last synced: about 1 year ago
JSON representation
Plugin for Joomla! to authenticate users against a mail server using IMAP, NNTP, or POP3.
- Host: GitHub
- URL: https://github.com/kevinoid/auth-mailbox-joomla
- Owner: kevinoid
- License: gpl-2.0
- Created: 2011-01-01T22:46:34.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2022-03-08T15:48:22.000Z (over 4 years ago)
- Last Synced: 2025-03-26T20:21:21.470Z (about 1 year ago)
- Topics: joomla-plugin, php
- Language: PHP
- Homepage:
- Size: 93.8 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.txt
- License: COPYING.txt
Awesome Lists containing this project
README
Mailbox Authentication Plugin for Joomla!
=========================================
This is a Joomla! plugin to authenticate users against a mail server via IMAP,
NNTP, 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 users log in to Joomla! with the same username and
password that they use for email, without the need to copy and synchronize the
accounts manually.
### Supported Features
* Fully localizable
* Set user email account based on configurable mail domain.
* Authenticate to mail server using full email address.
* Configable mail host address and port.
* Optionally require secure (non-plaintext) authentication.
* Support for TLS (optional or required) and SSL.
* Optional validation of SSL certificate from mail server.
* Supports the [Joomla! Update
System](https://docs.joomla.org/Help36:Extensions_Extension_Manager_Update).
### 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).
### Plugin Requirements
* **Joomla! 3.0 or later.** (Confirmed working on Joomla! 4.0-alpha3.)
There are previous versions of this plugin available [for Joomla!
2.5](https://github.com/kevinoid/auth-mailbox-joomla/releases/tag/v1.0.9-for-joomla2.5)
and [for Joomla!
1.5](https://github.com/kevinoid/auth-mailbox-joomla/releases/tag/v1.0.9-for-joomla1.5).
* **[PHP IMAP Extension](https://www.php.net/manual/en/book.imap.php).**
### Troubleshooting
#### Joomla! Logs
To get debugging information from the Joomla! logs:
1. Enable [Log Almost
Everything](https://docs.joomla.org/images/8/88/Debug_logging_settings-en.jpg)
from the "Logging" tab of the "System - Debug" plugin in the [Extensions
Plugin Manager](https://docs.joomla.org/Help310:Extensions_Plugin_Manager)?
2. Attempt to log in.
3. Open `administrator/logs/everything.php` from the Joomla! directory on your
server in a text editor and search for `authentication_mailbox` near the end
of the log file. The log messages should include the arguments to
[`imap_open`](https://www.php.net/manual/en/function.imap-open.php)
(excluding passwords) and the resulting messages from
[`imap_errors`](https://www.php.net/manual/en/function.imap-errors.php).
- If `administrator/logs/everything.php` does not exist, check that the
directory permissions allow the PHP process to write to that directory.
- If `authentication_mailbox` does not appear in
`administrator/logs/everything.php`, check that "Authentication -
Mailbox" is enabled in the Extensions Plugin Manager.
#### imap_open
If [`imap_open`](https://www.php.net/manual/en/function.imap-open.php) can not
open the user's mailbox, it may be simpler to debug by calling
[`imap_open`](https://www.php.net/manual/en/function.imap-open.php) from a
test script such as the following:
```php