Pop3c Mailbox Format

The pop3c storage accesses a remote POP3 server as if it were a regular (local) Dovecot mailbox format.

The remote POP3 mailbox is visible as the INBOX folder on the Dovecot side.

Settings

pop3c

Value	Named Filter
See Also	pop3c client_auth client_auth_authzid client_auth_authid client_auth_password client_auth_mechanism client authentication

This settings filter provides a scope for settings for pop3c.

The filter is needed for configuring the generic client_auth and ssl_client_* settings for pop3c specifically, since the same settings are used also by other clients.

Example:

pop3c {
  host = pop3.example.com
  ssl = pop3s
  port = 995
  client_auth_authzid = %{user}
  client_auth_password = secret
}

pop3c_features

Default	[None]
Value	Boolean List

List of features, optimizations, and workarounds that can be enabled.

Workarounds:

no-pipelining

Prevents use of the PIPELINING extension even when it is advertised.

pop3c_host

Default	[None]
Value	string

The remote POP3 host to connect to.

pop3c_master_user

Default	[None]
Value	string
See Also	pop3c_password pop3c_user
Changes	Removed: 3.3.0 Renamed to client_auth_authid inside the pop3c filter, i.e. pop3c/client_auth_authid.

The master username to authenticate as on the remote POP3 host.

To authenticate as a master user but use a separate login user, the following configuration should be employed, where the credentials are represented by masteruser and masteruser-secret:

pop3c_user = %{user}
pop3c_master_user = masteruser
pop3c_password = masteruser-secret

Mail user variables can be used.

pop3c_password

Default	[None]
Value	string
See Also	pop3c_master_user pop3c_user
Changes	Removed: 3.3.0 Renamed to client_auth_password inside the pop3c filter, i.e. pop3c/client_auth_password.

The authentication password for the remote POP3 server.

If using master users, this setting will be the password of the master user.

pop3c_port

Default	110
Value	Port Number

The port on the remote POP3 host to connect to.

pop3c_quick_received_date

Default	no
Value	boolean

If enabled, pop3c doesn't require calling TOP for each message in order to get the metadata.

pop3c_rawlog_dir

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

Log all POP3 traffic input/output to this directory.

pop3c_ssl

Default	no
Value	string
Allowed Values	nopop3sstarttls

Use TLS to connect to the remote POP3 server.

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

pop3c_ssl_verify

Default	yes
Value	boolean
See Also	pop3c_ssl
Changes	Removed: 3.3.0 Renamed to ssl_client_require_valid_cert inside the pop3c filter, i.e. pop3c/ssl_client_require_valid_cert.

Verify remote POP3 TLS certificate?

Verification may be disabled during testing, but should be enabled during production use.

Only used if pop3c_ssl is enabled.

pop3c_user

Default	%{user}
Value	string
See Also	pop3c_master_user pop3c_password
Changes	Removed: 3.3.0 Renamed to client_auth_authzid inside the pop3c filter, i.e. pop3c/client_auth_authzid. Note that the default changed too, see client_auth_authzid.

The user identity to be used for performing authentication to the source POP3 server.

Mail user variables can be used.

The login to the remote server is configured with the client authentication settings inside the pop3c filter.

Configuration Example

Connect using STARTTLS to pop3.example.com:

# In-memory index files:
mail_driver = pop3c
mail_path =

# OR, Store index files locally:
#mail_path = ~/pop3c

pop3c {
  host = pop3.example.com
  port = 110
  ssl = starttls
  client_auth_authzid = user@example.com
  client_auth_password = secret
}