====== authimap Plugin ======

---- plugin ----
description: Authenticate users against an IMAP server
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de
type       : auth
lastupdate : 2019-09-25
compatible : Hrun
depends    : 
conflicts  : 
similar    : 
tags       : auth imap pop3

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-authimap/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-authimap/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-authimap/
donationurl: 

screenshot_img : 
----

This plugin allows you to configure your DokuWiki to use a mailserver as authentication backend (IMAP and POP3 should work). It only works for a single server and single E-Mail domain only. Logins are the local part of the email-Address and Full-Names are derived from the local part as well. All users are member of the default group only.

===== Installation =====
[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Configuration and Settings =====

The plugin has three config options that you probably want to manually configure in your ''conf/local.protected.php''. Here's an example:

<file php>
$conf['authtype'] = 'authimap';
$conf['plugin']['authimap']['server'] = '{mail.example.com:993/imap/ssl}INBOX';                                   
$conf['plugin']['authimap']['domain'] = 'example.com';                                                                 
$conf['plugin']['authimap']['usedomain'] = 1;
</file>

The **server** setting requires a [[phpfn>imap_open|imap_open mailbox string]]. Here are a couple of examples:

  * connect to an IMAP server running on port 143 on mail.example.com:\\ ''{mail.example.com:143}INBOX''
  * connect to a POP3 server on port 110 on mail.example.com:\\ ''{mail.example.com:110/pop3}INBOX''
  * connect to an SSL IMAP server:\\ ''{mail.example.com:993/imap/ssl}INBOX''
  * connect to an SSL POP3 server with a self-signed certificate:\\ ''{mail.example.com:995/pop3/ssl/novalidate-cert}''

The **domain** setting is the E-Mail domain all your users use (the part after the ''@''-character).

Enable the **usedomain** setting if users log in with their full email address instead of the local part only at your mailserver. Logins at DokuWiki always use the local part only.