YakumoLabs/nextcloud-user_external
4
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📖 DOC: update README.md IMAP documentation

Browse Source 
Signed-off-by: Jonas Sulzer <jonas@violoncello.ch>
This commit is contained in:
Jonas Sulzer
2019-03-13 18:48:55 +01:00
parent 8685369c65
commit fe30fbf515
1 changed files with 5 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -56,38 +56,29 @@ needs to be activated.
IMAP IMAP
---- ----
Authenticate Nextcloud users against an IMAP server. Authenticate Nextcloud users against an IMAP server.
IMAP user and password need to be given for the Nextcloud login IMAP user and password need to be given for the Nextcloud login.
### Configuration ### Configuration
The parameters are `host, port, sslmode, domain`.
Add the following to your `config.php`: Add the following to your `config.php`:
'user_backends' => array( 'user_backends' => array(
array( array(
'class' => 'OC_User_IMAP', 'class' => 'OC_User_IMAP',
'arguments' => array( 'arguments' => array(
'{127.0.0.1:143/imap/readonly}', 'example.com' '127.0.0.1', 993, ssl, 'example.com'
), ),
), ),
), ),
This connects to the IMAP server on IP `127.0.0.1`, in readonly mode. This connects to the IMAP server on IP `127.0.0.1`.
The default port is 143; however if you want to restrict the domain, you need to specify the port and set sslmode to `null`.
If a domain name (e.g. example.com) is specified, then this makes sure that If a domain name (e.g. example.com) is specified, then this makes sure that
only users from this domain will be allowed to login. After successfull only users from this domain will be allowed to login. After successfull
login the domain part will be striped and the rest used as username in login the domain part will be striped and the rest used as username in
NextCloud. e.g. 'username@example.com' will be 'username' in NextCloud. NextCloud. e.g. 'username@example.com' will be 'username' in NextCloud.
Read the [imap_open][IMAP_0] PHP manual page to learn more about the allowed
parameters.
[IMAP_0]: http://php.net/imap_open#refsect1-function.imap-open-parameters
### Dependencies
The PHP [IMAP extension][IMAP_1] has to be activated.
[IMAP_1]: http://php.net/imap
Samba Samba