metadata.rb

# encoding: UTF-8
#
# Cookbook Name:: dovecot
# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
# Copyright:: Copyright (c) 2016 Xabier de Zuazo
# Copyright:: Copyright (c) 2013-2015 Onddo Labs, SL.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

name 'dovecot'
maintainer 'Xabier de Zuazo'
maintainer_email 'xabier@zuazo.org'
license 'Apache 2.0'
description <<-EOH
Installs and configures Dovecot, open source IMAP and POP3 email server.
EOH
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
version '3.3.0' # WiP

if respond_to?(:source_url)
  source_url "https://github.com/zuazo/#{name}-cookbook"
end
if respond_to?(:issues_url)
  issues_url "https://github.com/zuazo/#{name}-cookbook/issues"
end

chef_version '>= 12' if respond_to?(:chef_version)

supports 'amazon'
supports 'centos', '>= 6.0'
supports 'debian', '>= 7.0'
supports 'fedora', '>= 18.0'
supports 'opensuse'
supports 'oracle', '>= 6.0'
supports 'scientific', '>= 6.0'
supports 'suse'
supports 'ubuntu', '>= 12.04'

depends 'ohai', '~> 4.0'

recipe 'dovecot::default', 'Installs and configures Dovecot.'
recipe 'dovecot::user', 'Creates the dovecot system user.'
recipe 'dovecot::conf_files', 'Generates all the configuration files.'
recipe 'dovecot::ohai_plugin',
       'Provides an Ohai plugin for reading dovecot install information.'
recipe 'dovecot::from_package', 'Installs the required packages.'
recipe 'dovecot::service', 'Configures the Dovecot service.'
recipe 'dovecot::create_pwfile', 'Creates a userdb password file from databag.'

attribute 'dovecot/install_from',
          display_name: 'dovecot install method',
          description:
            'Determines how Dovecot is installed from. Only `package` is '\
            'supported for now.',
          type: 'string',
          required: 'optional',
          default: '"package"'

attribute 'dovecot/user',
          display_name: 'dovecot user',
          description: 'Dovecot system user. Should no be changed.',
          type: 'string',
          required: 'optional',
          default: '"dovecot"'

attribute 'dovecot/group',
          display_name: 'dovecot group',
          description: 'Dovecot system group. Should no be changed.',
          type: 'string',
          required: 'optional',
          default: '"dovecot"'

attribute 'dovecot/databag_name',
          display_name: 'Databag name',
          description: 'The name of the databag to use',
          type: 'string',
          required: 'optional',
          default: '"dovecot"'

attribute 'dovecot/databag_users_item',
          display_name: 'Databag users item name',
          description: 'The name item to put the users in',
          type: 'string',
          required: 'optional',
          default: '"users"'

attribute 'dovecot/user_homedir',
          display_name: 'dovecot homedir',
          description: 'Dovecot system user home directory.',
          calculated: true,
          type: 'string',
          required: 'optional'

attribute 'dovecot/lib_path',
          display_name: 'dovecot library path',
          description: 'Dovecot library path. Should no be changed.',
          calculated: true,
          type: 'string',
          required: 'optional'

attribute 'dovecot/conf_path',
          display_name: 'dovecot configuration path',
          description:
            'Dovecot configruration files path. Should no be changed.',
          type: 'string',
          required: 'optional',
          default: '"/etc/dovecot"'

attribute 'dovecot/conf_files_user',
          display_name: 'dovecot configuration files user',
          description: 'System user owner of configuration files.',
          type: 'string',
          required: 'optional',
          default: '"root"'

attribute 'dovecot/conf_files_group',
          display_name: 'dovecot configuration files group',
          description: 'System group owner of configuration files.',
          type: 'string',
          required: 'optional',
          default: 'node["dovecot"]["group"]'

attribute 'dovecot/conf_files_mode',
          display_name: 'dovecot configuration files mode',
          description: 'Configuration files system file mode bits.',
          type: 'string',
          required: 'optional',
          default: '00644'

attribute 'dovecot/conf/password_file',
          display_name: 'path of password file',
          description: 'The path and filename of the password file',
          type: 'string',
          required: 'optional',
          default: 'node["dovecot"]["conf_path"]/password'

attribute 'dovecot/sensitive_files',
          display_name: 'dovecot sensitve files',
          description:
            'An array of dovecot sensitive configuration files. Each array '\
            'item can be a glob expression or a fixed file name. This file '\
            'names should be relative to node["dovecot"]["conf_path"] '\
            'directory. Example: [ "dovecot-sql.conf.ext", "*-auth.conf.ext", '\
            '"conf.d/auth-supersecret.conf.ext" ]',
          type: 'array',
          required: 'optional',
          default: %w(*.conf.ext)

attribute 'dovecot/sensitive_files_mode',
          display_name: 'dovecot sensitve files mode',
          description:
            'Configuration files system file mode bits for sensitve files.',
          type: 'string',
          required: 'optional',
          default: '00640'

attribute 'dovecot/conf_files/core',
          display_name: 'dovecot core configuration files',
          description: 'Dovecot core configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(
            conf.d/10-auth.conf
            conf.d/10-director.conf
            conf.d/10-logging.conf
            conf.d/10-mail.conf
            conf.d/10-master.conf
            conf.d/10-ssl.conf
            conf.d/10-tcpwrapper.conf
            conf.d/15-lda.conf
            conf.d/15-mailboxes.conf
            conf.d/90-acl.conf
            conf.d/90-plugin.conf
            conf.d/90-quota.conf
            conf.d/auth-checkpassword.conf.ext
            conf.d/auth-deny.conf.ext
            conf.d/auth-master.conf.ext
            conf.d/auth-passwdfile.conf.ext
            conf.d/auth-sql.conf.ext
            conf.d/auth-static.conf.ext
            conf.d/auth-system.conf.ext
            conf.d/auth-vpopmail.conf.ext
            dovecot.conf
            dovecot-db.conf.ext
            dovecot-dict-sql.conf.ext
            dovecot-sql.conf.ext
          )

attribute 'dovecot/conf_files/imap',
          display_name: 'dovecot imap configuration files',
          description: 'Dovecot IMAP configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(conf.d/20-imap.conf)

attribute 'dovecot/conf_files/pop3',
          display_name: 'dovecot pop3 configuration files',
          description: 'Dovecot POP3 configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(conf.d/20-pop3.conf)

attribute 'dovecot/conf_files/lmtp',
          display_name: 'dovecot lmtp configuration files',
          description: 'Dovecot LMTP configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(conf.d/20-lmtp.conf)

attribute 'dovecot/conf_files/sieve',
          display_name: 'dovecot sieve configuration files',
          description: 'Dovecot Sieve configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(
            conf.d/20-managesieve.conf
            conf.d/90-sieve.conf
          )

attribute 'dovecot/conf_files/ldap',
          display_name: 'dovecot ldap configuration files',
          description: 'Dovecot LDAP configuration files list.',
          type: 'array',
          required: 'optional',
          default: %w(
            dovecot-ldap.conf.ext
            conf.d/auth-ldap.conf.ext
          )

attribute 'dovecot/auth',
          display_name: 'dovecot auth',
          description:
            'Dovecot Authentication Databases as a hash of hashes. Supported '\
            'authdbs: checkpassword, deny, ldap, master, passwdfile, sql, '\
            'system and vpopmail.',
          type: 'hash',
          required: 'optional',
          default: {}

attribute 'dovecot/namespaces',
          display_name: 'dovecot namespaces',
          description: 'Dovecot Namespaces as an array of hashes.',
          type: 'array',
          required: 'optional',
          default: []

attribute 'dovecot/plugins',
          display_name: 'dovecot plugins',
          description:
            'Dovecot Plugins configuration as a hash of hashes. Supported '\
            'plugins: mail_log, acl and quota.',
          type: 'hash',
          required: 'optional',
          default: {
            'sieve' => {
              'sieve' => '~/.dovecot.sieve',
              'sieve_dir' => '~/sieve'
            }
          }

attribute 'dovecot/protocols',
          display_name: 'dovecot protocols',
          description:
            'Dovecot Protocols configuration as a hash of hashes. Supported '\
            'protocols: lda, imap, lmtp, sieve and pop3.',
          type: 'hash',
          required: 'optional',
          default: {}

attribute 'dovecot/services',
          display_name: 'dovecot services',
          description:
            'Dovecot Services configuration as a hash of hashes. Supported '\
            'services: anvil, director, imap-login, pop3-login, lmtp, imap, '\
            'pop3, auth, auth-worker, dict, tcpwrap, managesieve-login, '\
            'managesieve, quota-status, quota-warning, doveadm, config, '\
            'aggregator, replicator',
          type: 'hash',
          required: 'optional',
          default: {}

attribute 'dovecot/conf/mail_plugins',
          display_name: 'dovecot mail plugins',
          description: 'Dovecot default enabled mail_plugins.',
          type: 'array',
          required: 'optional',
          default: []

attribute 'dovecot/packages/core',
          display_name: 'dovecot core packages',
          description: 'Dovecot core package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/imap',
          display_name: 'dovecot imap packages',
          description: 'Dovecot IMAP package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/pop3',
          display_name: 'dovecot pop3 packages',
          description: 'Dovecot POP3 package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/lmtp',
          display_name: 'dovecot lmtp packages',
          description: 'Dovecot LMTP package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/sieve',
          display_name: 'dovecot sieve packages',
          description: 'Dovecot Sieve package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/ldap',
          display_name: 'dovecot ldap packages',
          description: 'Dovecot LDAP package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/sqlite',
          display_name: 'dovecot sqlite packages',
          description: 'Dovecot SQLite package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/mysql',
          display_name: 'dovecot mysql packages',
          description: 'Dovecot MySQL package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/packages/pgsql',
          display_name: 'dovecot pgsql packages',
          description: 'Dovecot PostgreSQL package names array.',
          type: 'array',
          required: 'optional',
          calculated: true

attribute 'dovecot/service/name',
          display_name: 'dovecot service name',
          description: 'Dovecot system service name.',
          type: 'string',
          required: 'optional',
          default: 'dovecot'

attribute 'dovecot/service/supports',
          display_name: 'dovecot service supports',
          description: 'Dovecot service supported actions.',
          type: 'hash',
          required: 'optional',
          calculated: true

attribute 'dovecot/service/provider',
          display_name: 'dovecot service provider',
          description: 'Dovecot service Chef provider class.',
          type: 'string', # 'class' really
          required: 'optional',
          calculated: true

attribute 'dovecot/ohai_plugin/build-options',
          display_name: 'dovecot ohai plugin build options',
          description:
            'Whether to enable reading build options inside ohai plugin. Can '\
            'be disabled to be lighter.',
          type: 'string',
          required: 'optional',
          choice: %w(true false),
          default: 'true'

# dovecot.conf

attribute 'dovecot/conf/listen',
          display_name: 'listen',
          description:
            'A comma separated list of IPs or hosts where to listen in for '\
            'connections.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/base_dir',
          display_name: 'dovecot base dir',
          description: 'Base directory where to store runtime data.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/instance_name',
          display_name: 'instance name',
          description:
            'Name of this instance. Used to prefix all Dovecot processes in '\
            'ps output.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/login_greeting',
          display_name: 'login greeting',
          description: 'Greeting message for clients.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/login_trusted_networks',
          display_name: 'login trusted networks',
          description: 'Space separated list of trusted network ranges.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/login_access_sockets',
          display_name: 'login access sockets',
          description: 'Space separated list of login access check sockets.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_proxy_self',
          display_name: 'auth proxy self',
          description:
            'With proxy_maybe=yes if proxy destination matches any of these '\
            'IPs, don\'t do proxying.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/verbose_proctitle',
          display_name: 'verbose proctitle',
          description: 'Show more verbose process titles (in ps).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/shutdown_clients',
          display_name: 'shutdown clients',
          description:
            'Should all processes be killed when Dovecot master process shuts '\
            'down.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/doveadm_port',
          display_name: 'doveadm port',
          description:
          'If non-zero, doveadm cli will use this port to communicate with '\
          'doveadm server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/doveadm_password',
          display_name: 'doveadm password',
          description:
          'If not empty, the doveadm server replication communication will '\
          'use that secret.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/doveadm_worker_count',
          display_name: 'doveadm worker count',
          description:
            'If non-zero, run mail commands via this many connections to '\
            'doveadm server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/doveadm_socket_path',
          display_name: 'doveadm socket path',
          description:
            'UNIX socket or host:port used for connecting to doveadm server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/import_environment',
          display_name: 'import environment',
          description:
            'Space separated list of environment variables that are preserved '\
            'on Dovecot startup and his childs.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/dict',
          display_name: 'dict',
          description: 'Dictionary server settings as a hash.',
          type: 'hash',
          required: 'optional',
          default: nil

# conf.d/10-auth.conf

attribute 'dovecot/conf/disable_plaintext_auth',
          display_name: 'disable plaintext auth',
          description:
            'Disable LOGIN command and all other plaintext authentications '\
            'unless SSL/TLS is used.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_cache_size',
          display_name: 'auth cache size',
          description:
            'Authentication cache size (e.g. 10M). 0 means it\'s disabled.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_cache_ttl',
          display_name: 'auth cache ttl',
          description: 'Time to live for cached data.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_cache_negative_ttl',
          display_name: 'auth cache negative ttl',
          description:
            'TTL for negative hits (user not found, password mismatch).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_realms',
          display_name: 'disable plaintext auth',
          description:
            'Space separated list (or array) of realms for SASL '\
            'authentication mechanisms that need them.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_default_realm',
          display_name: 'auth default realm',
          description: 'Default realm/domain to use if none was specified.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_username_chars',
          display_name: 'auth username chars',
          description: 'List of allowed characters in username.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_username_translation',
          display_name: 'auth username translation',
          description:
            'Username character translations before it\'s looked up from '\
            'databases.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_username_format',
          display_name: 'auth username format',
          description:
            'Username formatting before it\'s looked up from databases.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_master_user_separator',
          display_name: 'auth master user separator',
          description:
            'If you want to allow master users to log in by specifying the '\
            'master username within the normal username string, you can '\
            'specify the separator character here (format: '\
            '<username><separator><master username>).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_anonymous_username',
          display_name: 'auth anonymous username',
          description:
            'Username to use for users logging in with ANONYMOUS SASL '\
            'mechanism.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_worker_max_count',
          display_name: 'auth worker max count',
          description: 'Maximum number of dovecot-auth worker processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_gssapi_hostname',
          display_name: 'auth gssapi hostname',
          description: 'Host name to use in GSSAPI principal names.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_krb5_keytab',
          display_name: 'auth krb5 keytab',
          description: 'Kerberos keytab to use for the GSSAPI mechanism.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_use_winbind',
          display_name: 'auth use winbind',
          description:
            'Do NTLM and GSS-SPNEGO authentication using Samba\'s winbind '\
            'daemon and ntlm_auth helper.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_winbind_helper_path',
          display_name: 'auth winbind helper path',
          description: 'Path for Samba\'s ntlm_auth helper binary.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_failure_delay',
          display_name: 'auth failure delay',
          description:
            'Time to delay before replying to failed authentications.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_ssl_require_client_cert',
          display_name: 'auth ssl require client cert',
          description:
            'Take the username from client\'s SSL certificate, using '\
            'X509_NAME_get_text_by_NID() which returns the subject\'s DN\'s '\
            'CommonName.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_mechanisms',
          display_name: 'auth mechanisms',
          description:
            'Space separated list of wanted authentication mechanisms: plain, '\
            'login, digest-md5, cram-md5, ntlm, rpa, apop, anonymous, gssapi, '\
            'otp, skey, gss-spnego',
          type: 'string',
          required: 'optional',
          default: '"plain"'

# conf.d/10-director.conf

attribute 'dovecot/conf/director_servers',
          display_name: 'director servers',
          description:
            'List of IPs or hostnames to all director servers, including '\
            'ourself (as a string or as an array).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/director_mail_servers',
          display_name: 'director mail servers',
          description: 'List of IPs or hostnames to all backend mail servers.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/director_user_expire',
          display_name: 'director_user_expire',
          description:
            'How long to redirect users to a specific server after it no '\
            'longer has any connections.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/director_doveadm_port',
          display_name: 'director doveadm port',
          description:
            'TCP/IP port that accepts doveadm connections (instead of '\
            'director connections).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/director_username_hash',
          display_name: 'director username hash',
          description:
            'How the username is translated before being hashed.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/10-logging.conf

attribute 'dovecot/conf/log_path',
          display_name: 'path',
          description:
            'Log file to use for error messages. "syslog" logs to syslog, '\
            '/dev/stderr logs to stderr.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/info_log_path',
          display_name: 'info log path',
          description:
            'Log file to use for informational messages. Defaults to log_path.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/debug_log_path',
          display_name: 'debug log path',
          description:
            'Log file to use for debug messages. Defaults to info_log_path.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/syslog_facility',
          display_name: 'syslog facility',
          description: 'Syslog facility to use if you\'re logging to syslog.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_verbose',
          display_name: 'auth verbose',
          description:
            'Log unsuccessful authentication attempts and the reasons why '\
            'they failed.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_verbose_passwords',
          display_name: 'auth verbose passwords',
          description:
            'In case of password mismatches, log the attempted password.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_debug',
          display_name: 'auth debug',
          description: 'Even more verbose logging for debugging purposes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_debug_passwords',
          display_name: 'auth debug passwords',
          description:
            'In case of password mismatches, log the passwords and used '\
            'scheme so the problem can be debugged.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_debug',
          display_name: 'mail debug',
          description: 'Enable mail process debugging.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/verbose_ssl',
          display_name: 'verbose ssl',
          description: 'Show protocol level SSL errors.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/log_timestamp',
          display_name: 'log timestamp',
          description: 'Prefix for each line written to log file.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/login_log_format_elements',
          display_name: 'login log format elements',
          description:
            'Space-separated list (or array) of elements we want to log.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/login_log_format',
          display_name: 'login log format',
          description: 'Login log format.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_log_prefix',
          display_name: 'mail log prefix',
          description: 'Log prefix for mail processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/deliver_log_format',
          display_name: 'deliver log format',
          description: 'Format to use for logging mail deliveries.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/10-mail.conf

attribute 'dovecot/conf/mail_location',
          display_name: 'mail location',
          description: 'Location for user\'s mailboxes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_shared_explicit_inbox',
          display_name: 'mail shared explicit inbox',
          description:
            'Should shared INBOX be visible as "shared/user" or '\
            '"shared/user/INBOX"?',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_uid',
          display_name: 'mail uid',
          description: 'System user used to access mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_gid',
          display_name: 'mail gid',
          description: 'System group used to access mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_privileged_group',
          display_name: 'mail privileged group',
          description: 'Group to enable temporarily for privileged operations.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_access_groups',
          display_name: 'mail access groups',
          description:
            'Grant access to these supplementary groups for mail processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_full_filesystem_access',
          display_name: 'mail full filesystem access',
          description: 'Allow full filesystem access to clients.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_attribute_dict',
          display_name: 'mail attribute dict',
          description: 'Dictionary for key=value mailbox attributes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_server_comment',
          display_name: 'mail server comment',
          description: 'A comment or note that is associated with the server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_server_admin',
          display_name: 'mail server admin',
          description:
            'Indicates a method for contacting the server administrator. '\
            'This value MUST be a URI.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mmap_disable',
          display_name: 'mmap disable',
          description: 'Don\'t use mmap() at all.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/dotlock_use_excl',
          display_name: 'dotlock use excl',
          description: 'Rely on O_EXCL to work when creating dotlock files.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_fsync',
          display_name: 'mail fsync',
          description:
            'When to use fsync() or fdatasync() calls: optimized, always or '\
            'never',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_nfs_storage',
          display_name: 'mail nfs storage',
          description: 'Mail storage exists in NFS.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_nfs_index',
          display_name: 'mail nfs index',
          description: 'Mail index files also exist in NFS.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lock_method',
          display_name: 'lock method',
          description:
            'Locking method for index files: fcntl, flock or dotlock.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_temp_dir',
          display_name: 'mail temp dir',
          description:
            'Directory in which LDA/LMTP temporarily stores incoming mails '\
            '>128 kB.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/first_valid_uid',
          display_name: 'first valid uid',
          description: 'Valid UID range for users, defaults to 500 and above.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/last_valid_uid',
          display_name: 'last valid uid',
          description: 'Valid UID range for users, defaults to 500 and above.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/first_valid_gid',
          display_name: 'first valid gid',
          description: 'Valid GID range for users, defaults to non-root/wheel.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/last_valid_gid',
          display_name: 'last valid gid',
          description: 'Valid GID range for users, defaults to non-root/wheel.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_max_keyword_length',
          display_name: 'mail max keyword length',
          description: 'Maximum allowed length for mail keyword name.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/valid_chroot_dirs',
          display_name: 'valid chroot dirs',
          description:
            '\':\' separated list of directories under which chrooting is '\
            'allowed for mail processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_chroot',
          display_name: 'mail chroot',
          description: 'Default chroot directory for mail processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/auth_socket_path',
          display_name: 'auth socket path',
          description:
            'UNIX socket path to master authentication server to find users.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_plugin_dir',
          display_name: 'mail plugin dir',
          description: 'Directory where to look up mail plugins.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_cache_min_mail_count',
          display_name: 'mail cache min mail count',
          description:
            'The minimum number of mails in a mailbox before updates are done '\
            'to cache file.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mailbox_idle_check_interval',
          display_name: 'mailbox idle check interval',
          description:
            'When IDLE command is running, mailbox is checked once in a while '\
            'to see if there are any new mails or other changes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_save_crlf',
          display_name: 'mail save crlf',
          description: 'Save mails with CR+LF instead of plain LF.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_prefetch_count',
          display_name: 'mail prefetch count',
          description:
            'Max number of mails to keep open and prefetch to memory.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_temp_scan_interval',
          display_name: 'mail temp scan interval',
          description:
            'How often to scan for stale temporary files and delete them '\
            '(0 = never).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/maildir_stat_dirs',
          display_name: 'maildir stat dirs',
          description:
            'By default LIST command returns all entries in maildir beginning '\
            'with a dot.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/maildir_copy_with_hardlinks',
          display_name: 'maildir copy with hardlinks',
          description:
            'When copying a message, do it with hard links whenever possible.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/maildir_very_dirty_syncs',
          display_name: 'maildir very dirty syncs',
          description: 'Assume Dovecot is the only MUA accessing Maildir.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/maildir_broken_filename_sizes',
          display_name: 'maildir broken filename sizes',
          description:
            'If enabled, Dovecot doesn\'t use the S=<size> in the Maildir '\
            'filenames for getting the mail\'s physical size, except when '\
            'recalculating Maildir++ quota.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/maildir_empty_new',
          display_name: 'maildir empty new',
          description:
            'Always move mails from new/ directory to cur/, even when the '\
            '\Recent flags aren\'t being reset.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_read_locks',
          display_name: 'mbox read locks',
          description:
            'Which read locking methods to use for locking mbox: dotlock, '\
            'dotlock_try, fcntl, flock or lockfyy',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_write_locks',
          display_name: 'mbox write locks',
          description:
            'Which write locking methods to use for locking mbox: dotlock, '\
            'dotlock_try, fcntl, flock or lockfyy',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_lock_timeout',
          display_name: 'mbox lock timeout',
          description:
            'Maximum time to wait for lock (all of them) before aborting.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_dotlock_change_timeout',
          display_name: 'mbox dotlock change timeout',
          description:
            'If dotlock exists but the mailbox isn\'t modified in any way, '\
            'override the lock file after this much time.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_dirty_syncs',
          display_name: 'mbox dirty syncs',
          description:
            'When mbox changes unexpectedly simply read the new mails but '\
            'still safely fallbacks to re-reading the whole mbox file '\
            'whenever something in mbox isn\'t how it\'s expected to be.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_very_dirty_syncs',
          display_name: 'mbox very dirty syncs',
          description:
            'Like mbox_dirty_syncs, but don\'t do full syncs even with '\
            'SELECT, EXAMINE, EXPUNGE or CHECK commands.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_lazy_writes',
          display_name: 'mbox lazy writes',
          description:
            'Delay writing mbox headers until doing a full write sync '\
            '(EXPUNGE and CHECK commands and when closing the mailbox).',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_min_index_size',
          display_name: 'mbox min index size',
          description:
            'If mbox size is smaller than this (e.g. 100k), don\'t write '\
            'index files.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mbox_md5',
          display_name: 'mbox md5',
          description:
            'Mail header selection algorithm to use for MD5 POP3 UIDLs when '\
            'pop3_uidl_format=%m.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mdbox_rotate_size',
          display_name: 'mdbox rotate size',
          description: 'Maximum dbox file size until it\'s rotated.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mdbox_rotate_interval',
          display_name: 'mdbox rotate interval',
          description: 'Maximum dbox file age until it\'s rotated.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mdbox_preallocate_space',
          display_name: 'mdbox preallocate space',
          description:
            'When creating new mdbox files, immediately preallocate their '\
            'size to mdbox_rotate_size.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_attachment_dir',
          display_name: 'mail attachment dir',
          description:
            'Directory root where to store mail attachments. Disabled, if '\
            'empty.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_attachment_min_size',
          display_name: 'mail attachment min size',
          description:
            'Attachments smaller than this aren\'t saved externally.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_attachment_fs',
          display_name: 'mail attachment fs',
          description:
            'Filesystem backend to use for saving attachments: posix, sis '\
            'posix or sis-queue posix.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/mail_attachment_hash',
          display_name: 'mail attachment hash',
          description: 'Hash format to use in attachment filenames.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/10-master.conf

attribute 'dovecot/conf/default_process_limit',
          display_name: 'default process limit',
          description: 'Default process limit.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/default_client_limit',
          display_name: 'default client limit',
          description: 'Default client limit.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/default_vsz_limit',
          display_name: 'default vsz limit',
          description:
            'Default VSZ (virtual memory size) limit for service processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/default_login_user',
          display_name: 'default login user',
          description: 'Login user is internally used by login processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/default_internal_user',
          display_name: 'default internal user',
          description: 'Internal user is used by unprivileged processes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/10-ssl.conf

attribute 'dovecot/conf/ssl',
          display_name: 'ssl',
          description: 'SSL/TLS support: true or false',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_cert',
          display_name: 'ssl cert',
          description: 'PEM encoded X.509 SSL/TLS certificate.',
          calculated: true,
          type: 'string',
          required: 'optional'

attribute 'dovecot/conf/ssl_key',
          display_name: 'ssl key',
          description: 'PEM encoded X.509 SSL/TLS private key.',
          calculated: true,
          type: 'string',
          required: 'optional'

attribute 'dovecot/conf/ssl_key_password',
          display_name: 'ssl key password',
          description:
            'If key file is password protected, give the password here.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_ca',
          display_name: 'ssl ca',
          description: 'PEM encoded trusted certificate authority.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_require_crl',
          display_name: 'ssl require crl',
          description:
            'Require that CRL check succeeds for client certificates.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_client_ca_dir',
          display_name: 'ssl client ca dir',
          description:
            'Directory for trusted SSL CA certificates. These are used only '\
            'when Dovecot needs to act as an SSL client..',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_client_ca_file',
          display_name: 'ssl client ca file',
          description:
            'File for trusted SSL CA certificates. These are used only when '\
            'Dovecot needs to act as an SSL client.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_verify_client_cert',
          display_name: 'ssl verify client cert',
          description: 'Request client to send a certificate.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_cert_username_field',
          display_name: 'ssl cert username field',
          description: 'Which field from certificate to use for username.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_parameters_regenerate',
          display_name: 'ssl parameters regenerate',
          description: 'How often to regenerate the SSL parameters file.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_dh_parameters_length',
          display_name: 'ssl dh parameters length',
          description: 'DH parameters length to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_protocols',
          display_name: 'ssl protocols',
          description: 'SSL protocols to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_cipher_list',
          display_name: 'ssl cipher list',
          description: 'SSL ciphers to use',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_prefer_server_ciphers',
          display_name: 'ssl prefer server ciphers',
          description: 'Prefer the server\'s order of ciphers over client\'s.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_options',
          display_name: 'ssl options',
          description:
            'SSL extra options. Currently supported options are: '\
            'no_compression',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ssl_crypto_device',
          display_name: 'ssl crypto device',
          description:
            'SSL crypto device to use, for valid values run '\
            '"$ openssl engine".',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/15-lda.conf

attribute 'dovecot/conf/postmaster_address',
          display_name: 'postmaster address',
          description: 'Address to use when sending rejection mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/hostname',
          display_name: 'hostname',
          description:
            'Hostname to use in various parts of sent mails, eg. in '\
            'Message-Id.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/quota_full_tempfail',
          display_name: 'quota full tempfail',
          description:
            'If user is over quota, return with temporary failure instead of '\
            'bouncing the mail.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sendmail_path',
          display_name: 'sendmail path',
          description: 'Binary to use for sending mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/submission_host',
          display_name: 'submission host',
          description:
            'If non-empty, send mails via this SMTP host[:port] instead of '\
            'sendmail.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/rejection_subject',
          display_name: 'rejection subject',
          description: 'Subject: header to use for rejection mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/rejection_reason',
          display_name: 'rejection reason',
          description: 'Human readable error message for rejection mails.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/recipient_delimiter',
          display_name: 'recipient delimiter',
          description:
            'Delimiter character between local-part and detail in email '\
            'address.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lda_original_recipient_header',
          display_name: 'lda original recipient header',
          description:
            'Header where the original recipient address (SMTP\'s RCPT TO: '\
            'address) is taken from if not available elsewhere.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lda_mailbox_autocreate',
          display_name: 'lda mailbox autocreate',
          description:
            'Should saving a mail to a nonexistent mailbox automatically '\
            'create it?',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lda_mailbox_autosubscribe',
          display_name: 'lda mailbox autosubscribe',
          description:
            'Should automatically created mailboxes be also automatically '\
            'subscribed?',
          type: 'string',
          required: 'optional',
          default: 'nil'

# conf.d/20-lmtp.conf

attribute 'dovecot/conf/lmtp_proxy',
          display_name: 'lmtp proxy',
          description:
            'Support proxying to other LMTP/SMTP servers by performing passdb '\
            'lookups.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lmtp_save_to_detail_mailbox',
          display_name: 'lmtp save to detail mailbox',
          description:
            'When recipient address includes the detail (e.g. user+detail), '\
            'try to save the mail to the detail mailbox.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lmtp_rcpt_check_quota',
          display_name: 'lmtp rcpt check quota',
          description:
            'Verify quota before replying to RCPT TO. This adds a small '\
            'overhead.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/lmtp_hdr_delivery_address',
          display_name: 'lmtp hdr delivery address',
          description:
            'Which recipient address to use for Delivered-To: header and '\
            'Received: header.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# dovecot-db.conf.ext

attribute 'dovecot/conf/db',
          display_name: 'berkeley db',
          description: 'DB_CONFIG for Berkeley DB as a hash.',
          type: 'hash',
          required: 'optional',
          default: nil

# conf-dovecot-dict-sql.rb

attribute 'dovecot/conf/dict_sql/connect',
          display_name: 'dict sql connect',
          description:
            'Dict sql connect configuration as a string or an array.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/dict_sql/maps',
          display_name: 'dict sql maps',
          description: 'Dict sql database tables maps.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# dovecot-ldap.conf.ext

attribute 'dovecot/conf/ldap/hosts',
          display_name: 'ldap hosts',
          description: 'Space separated list or array of LDAP hosts to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/uris',
          display_name: 'ldap uris',
          description: 'LDAP URIs to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/dn',
          display_name: 'ldap dn',
          description:
            'Distinguished Name, the username used to login to the LDAP '\
            'server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/dnpass',
          display_name: 'ldap dnpass',
          description: 'Password for LDAP server, if dn is specified.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/sasl_bind',
          display_name: 'ldap sasl bind',
          description: 'Use SASL binding instead of the simple binding.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/sasl_mech',
          display_name: 'ldap sasl mech',
          description: 'SASL mechanism name to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/sasl_realm',
          display_name: 'ldap sasl realm',
          description: 'SASL realm to use.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/sasl_authz_id',
          display_name: 'ldap sasl authz id',
          description:
            'SASL authorization ID, ie. the dnpass is for this "master user", '\
            'but the dn is still the logged in user.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls',
          display_name: 'ldap tls',
          description: 'Use TLS to connect to the LDAP server.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_ca_cert_file',
          display_name: 'ldap tls ca cert file',
          description: 'TLS options, currently supported only with OpenLDAP.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_ca_cert_file',
          display_name: 'ldap tls ca cert file',
          description: 'TLS options, currently supported only with OpenLDAP.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_ca_cert_dir',
          display_name: 'ldap tls ca cert dir',
          description: 'TLS options, currently supported only with OpenLDAP.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_cipher_suite',
          display_name: 'ldap tls cipher suite',
          description: 'TLS options, currently supported only with OpenLDAP.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_cert_file',
          display_name: 'ldap tls cert file',
          description:
            'TLS cert/key is used only if LDAP server requires a client '\
            'certificate.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_key_file',
          display_name: 'ldap tls key file',
          description:
            'TLS cert/key is used only if LDAP server requires a client '\
            'certificate.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/tls_require_cert',
          display_name: 'ldap tls require cert',
          description: 'Valid values: never, hard, demand, allow, try',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/ldaprc_path',
          display_name: 'ldap ldaprc path',
          description: 'Use the given ldaprc path.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/debug_level',
          display_name: 'ldap debug level',
          description:
            'LDAP library debug level as specified by LDAP_DEBUG_* in '\
            'ldap_log.h.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/auth_bind',
          display_name: 'ldap auth bind',
          description:
            'Use authentication binding for verifying password\'s validity.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/auth_bind_userdn',
          display_name: 'ldap auth bind userdn',
          description:
            'If authentication binding is used, you can save one LDAP request '\
            'per login if user\'s DN can be specified with a common template.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/ldap_version',
          display_name: 'ldap ldap version',
          description: 'LDAP protocol version to use. Likely 2 or 3.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/base',
          display_name: 'ldap base',
          description: 'LDAP base. %variables can be used here.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/deref',
          display_name: 'ldap deref',
          description: 'Dereference: never, searching, finding or always.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/scope',
          display_name: 'ldap scope',
          description: 'Search scope: base, onelevel or subtree.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/user_attrs',
          display_name: 'ldap user attrs',
          description:
            'User attributes are given in LDAP-name=dovecot-internal-name '\
            'list.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/user_filter',
          display_name: 'ldap user filter',
          description: 'Filter for user lookup.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/pass_attrs',
          display_name: 'ldap pass attrs',
          description: 'Password checking attributes.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/pass_filter',
          display_name: 'ldap pass filter',
          description: 'Filter for password lookups.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/iterate_attrs',
          display_name: 'ldap iterate attrs',
          description: 'Attributes to get a list of all users',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/iterate_filter',
          display_name: 'ldap iterate filter',
          description: 'Filter to get a list of all users',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/ldap/default_pass_scheme',
          display_name: 'ldap default pass scheme',
          description:
            'Default password scheme. "{scheme}" before password overrides '\
            'this.',
          type: 'string',
          required: 'optional',
          default: 'nil'

# dovecot-sql.conf.ext

attribute 'dovecot/conf/sql/driver',
          display_name: 'sql driver',
          description: 'Database driver: mysql, pgsql or sqlite.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sql/connect',
          display_name: 'sql connect',
          description:
            'Database connection string or array. This is driver-specific '\
            'setting.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sql/default_pass_scheme',
          display_name: 'sql default pass scheme',
          description: 'Default password scheme.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sql/password_query',
          display_name: 'sql password query',
          description: 'passdb query to retrieve the password.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sql/user_query',
          display_name: 'sql user query',
          description: 'userdb query to retrieve the user information.',
          type: 'string',
          required: 'optional',
          default: 'nil'

attribute 'dovecot/conf/sql/iterate_query',
          display_name: 'sql iterate query',
          description: 'Query to get a list of all usernames.',
          type: 'string',
          required: 'optional',
          default: 'nil'