https://github.com/haraka/haraka-plugin-auth-imap

Provide SMTP AUTH against IMAP servers
https://github.com/haraka/haraka-plugin-auth-imap

authentication haraka-plugin imap-server

Last synced: 4 months ago
JSON representation

Provide SMTP AUTH against IMAP servers

• Host: GitHub
• URL: https://github.com/haraka/haraka-plugin-auth-imap
• Owner: haraka
• License: mit
• Created: 2017-04-17T15:19:19.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-05T21:40:04.000Z (over 3 years ago)
• Last Synced: 2025-08-10T11:49:17.207Z (6 months ago)
• Topics: authentication, haraka-plugin, imap-server
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 7
• Watchers: 6
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status][ci-img]][ci-url]

[![Code Climate][clim-img]][clim-url]

[![NPM][npm-img]][npm-url]

# haraka-plugin-auth-imap

Authenticate against an imap server.

## Configuration

Configuration is stored in `config/auth_imap.ini` and uses INI

style formatting.

These are the configuration settings:

* host: The host/IP that the imap server is listening on (default: localhost).

* port: The TCP port that the imap server is listening on (default: 143).

* tls: Perform implicit TLS connection? (default: false).

* rejectUnauthorized: Set rejectUnauthorized in tlsOptions for 

  imap connection (default: do not set tlsOptions).

* connTimeout: Number of milliseconds to wait for a connection to be 

  established (default: none).

* authTimeout: Number of milliseconds to wait to be authenticated after a 

  connection has been established (default: none).

* users: comma separated list of users (local part before '@') which are 

  allowed to be authenticated by the imap server. If this setting is missing,

  all users are allowed. So use this setting, if you have no control over 

  the imap server because otherwise you could create an open relay, e.g.

  if you would authenticate with gmail and do not set users, every gmail

  user could use your mail server to send mail (default: none).

* trace_imap: if true, emit imap debug information. Do not use this in

  production because it logs sensitive information, e.g. passowrds in

  clear text (default: none).

### Per-domain Configuration

Additionally, domains can each have their own configuration for connecting

to the imap server. The defaults are the same, so only the differences needs 

to be declared. Example:

    host=imap.example.com

    

    [gmail.com]

    host=imap.gmail.com

    port=993

    tls=true

    users=arthur,trillian,ford

    [example2.com]

    host=imap.example2.com

    port=993

    tls=true

[ci-img]: https://github.com/haraka/haraka-plugin-auth-imap/actions/workflows/ci.yml/badge.svg

[ci-url]: https://github.com/haraka/haraka-plugin-auth-imap/actions/workflows/ci.yml

[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-auth-imap/badges/gpa.svg

[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-auth-imap

[npm-img]: https://nodei.co/npm/haraka-plugin-auth-imap.png

[npm-url]: https://www.npmjs.com/package/haraka-plugin-auth-imap