Mercurial > prosody-modules

view mod_auth_imap/README.md @ 6307:c194bec4b56d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_voipms: Fix bug from not returning in message/bare hook Since SMS/MMS are sent/received on JIDs that are not real accounts, we need to `return true` from the 'message/bare' hook, otherwise routing will occur and result in failed account lookups.
author Chaz Kettleson <chaz@pyr3x.com>
date Fri, 01 Aug 2025 18:36:47 -0400
parents fe081789f7b5
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
- 'Type-Auth'
summary: IMAP authentication module
rockspec:
  build:
    modules:
      mod_auth_imap: auth_imap/mod_auth_imap.lua
      mod_auth_imap.sasl_imap: auth_imap/sasl_imap.lib.lua
...

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