Authentication via Remote IMAP Server (imap)

Settings

Removed: 3.1.0: The arg-based driver settings have been removed in favor of using the standard imapc_* settings.

Removed: 3.1.0: The ssl_ca_file, ssl_ca_dir and allow_invalid_cert settings have been removed. The standard ssl_* settings can be used instead (also inside passdb { ... } if wanted).

Changed: 3.3.0: The imapc_user, imapc_master_user and imapc_password settings are now the client authentication settings inside the imapc filter. The passdb sets client_auth_password automatically to the password given by the user, and client_auth_authzid defaults to the username, so normally none of them need to be set.

imapc_host

Default	[None]
Value	string

The remote IMAP host to connect to.

imapc_port

Default	143
Value	Port Number

The port on the remote IMAP host to connect to.

imapc_rawlog_dir

Default	[None]
Value	directory path
See Also	rawlog
Changes	Changed: 3.2.0 Setting type changed.

Log all IMAP traffic input/output to this directory.

imapc_ssl

Default	no
Value	string
Allowed Values	noimapsstarttls

Use TLS to connect to the remote IMAP server.

Value	Description
no	No TLS
imaps	Explicitly connect to remote IMAP port using TLS
starttls	Use IMAP STARTTLS command to switch to TLS connection

imapc_user

Default	%{owner_user}
Value	string
See Also	imapc_master_user imapc_password imapc_sasl_mechanisms
Changes	Removed: 3.3.0 Renamed to client_auth_authzid inside the imapc filter, i.e. imapc/client_auth_authzid.

The user identity to be used for performing a regular IMAP LOGIN to the source IMAP server.

Mail user variables can be used.

Example

Authenticates users against remote IMAP server in IP address 192.168.1.123:

passdb imap {
  imapc_host = 192.168.1.123
  imapc_port = 143
  imapc_rawlog_dir = /tmp/imapc_rawlog/
  imapc_ssl = starttls

  ssl_client_require_valid_cert = no
}

To log in with a different username than what the user gave, e.g. without the domain:

passdb imap {
  imapc_host = 192.168.1.123
  imapc {
    client_auth_authzid = %{user | username}
  }
}