ZNC website has died on 29 March 2017, without fresh backups. Wiki is now back from dump of July 2015. Please help restoring the lost content.
| This module is a part of ZNC.
This module is shipped with ZNC by default. If you have the right "LoadMod" you can activate it with
The code for this module can be found here. This module is part of ZNC since Version 1.0
This module is intended for admins who run a shell/web/email/etc server and want to provide ZNC access to their existing users. By using this module, when your users login to ZNC - either with their IRC client or via the webadmin module - their password will be checked against your IMAP server instead of the ZNC config file.
This global module takes up to three arguments. The arguments can be
[server] [[+]port] [UserFormatString].
Read loading modules to learn more about loading modules.
If you want to set the arguments manually use this as reference:
Server: should be self explanatory. It is the IMAP server to connect to when trying to authenticate an incoming user.
Port: is the port that your IMAP server listens on. Use a + before the port to connect using SSL.
UserFormatString: will format the incoming username.
- You use a % to represent the username like so.. %@foo.com - This will send email@example.com to your imap server when a user tries to authenticate as the user fred.
- You can force the user to supply the full email address leaving this string blank or supplying just % by itself.
If any arguments are left blank the following defaults will be used:
Port: 143 (non-SSL)
Note: SSL must be enabled when you want the module to connect to the IMAP server using SSL.