Mercurial > prosody-modules

view mod_auth_imap/README.markdown @ 4678:0bcbff950f14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_smacks: Update README `smacks_enabled_s2s` defaults now to `true`. See https://hg.prosody.im/prosody-modules/file/242251ce1036/mod_smacks/mod_smacks.lua#l39
author Martin Dosch <martin@mdosch.de>
date Sun, 12 Sep 2021 13:34:46 +0200
parents 4d73a1a6ba68
children b97a2ffef87f
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
- 'Type-Auth'
summary: IMAP authentication module
...

Introduction
============

This is a Prosody authentication plugin which uses a generic IMAP server
as the backend.

Configuration
=============

  option                            type      default
  --------------------------------- --------- --------------------------------
  imap\_auth\_host                  string    localhost
  imap\_auth\_port                  number    nil
  imap\_auth\_realm                 string    Same as the sasl\_realm option
  imap\_auth\_service\_name         string    nil
  auth\_append\_host                boolean   false
  auth\_imap\_verify\_certificate   boolean   true
  auth\_imap\_ssl                   table     A SSL/TLS config