From 99b8dad9d1e08ac9a50c08415be1c067a8bf087b Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Fri, 27 Dec 2013 18:44:20 +0100 Subject: [PATCH] add readme for imap --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d9d2bb --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +External user authentication +============================ + +Authenticate user login against FTP, IMAP or SMB. + + +## Configuration + +### IMAP +Add the following to your `config.php`: + + 'user_backends' => array( + array( + 'class' => 'OC_User_IMAP', + 'arguments' => array( + '{127.0.0.1:143/imap/readonly}', + ), + ), + ), + +This connects to the IMAP server on `localhost`. + +Read the [imap_open][0] PHP manual page to learn more about the allowed +parameters. + +[0]: http://php.net/imap_open#refsect1-function.imap-open-parameters