diff --git a/source/admin_manual/migrating_mailboxes.rst b/source/admin_manual/migrating_mailboxes.rst index d01063f29..00b28e066 100644 --- a/source/admin_manual/migrating_mailboxes.rst +++ b/source/admin_manual/migrating_mailboxes.rst @@ -28,7 +28,7 @@ Things that you should consider in your config: * :ref:`Quota ` without rules (to make sure quota gets calculated, but not enforced) * :ref:`Mail caching settings ` * :dovecot_core:ref:`Attachment detection settings ` - * :dovecot_core:ref:`Mailbox attribute settings ` + * :dovecot_core:ref:`Mailbox attribute settings ` * :ref:`Compression ` and :ref:`encryption ` settings * :ref:`NFS related settings ` diff --git a/source/configuration_manual/dict/index.rst b/source/configuration_manual/dict/index.rst index 173141a16..4ca54e8cf 100644 --- a/source/configuration_manual/dict/index.rst +++ b/source/configuration_manual/dict/index.rst @@ -388,13 +388,13 @@ You can also access multiple SQL fields. For example * ``INSERT INTO user_shares (from_user, to_user, dummy) VALUES ('$from', '$to', '$value') ON DUPLICATE KEY UPDATE dummy='$value'`` -SQL dict with mail_attribute_dict -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +SQL dict with mail_attribute +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -It's possible to implement :dovecot_core:ref:`mail_attribute_dict` also with +It's possible to implement :dovecot_core:ref:`mail_attribute` also with SQL dict. -.. warning:: Using shared attributes in mail_attribute_dict requires the +.. warning:: Using shared attributes in ``mail_attribute`` requires the mailbox GUID to be unique between users. This is not the case when mails were migrated via imapc, because it uses a hash of the mailbox name as the GUID. So every migrated user would have diff --git a/source/configuration_manual/imap_metadata.rst b/source/configuration_manual/imap_metadata.rst index bf5a6c36c..8bb37d219 100644 --- a/source/configuration_manual/imap_metadata.rst +++ b/source/configuration_manual/imap_metadata.rst @@ -9,8 +9,8 @@ which allows per-mailbox, per-user data to be stored and accessed via IMAP commands. To activate metadata storage, a :ref:`dictionary ` needs to be -configured in the Dovecot configuration using the ``mail_attribute_dict`` -option. +configured in the Dovecot configuration using the +:dovecot_core:ref:`mail_attribute` setting. To activate the IMAP METADATA commands, the ``imap_metadata`` option needs to be activated. @@ -20,7 +20,10 @@ Example: .. code-block:: none # Store METADATA information within user's Maildir directory - mail_attribute_dict = file:%h/Maildir/dovecot-attributes + mail_attribute { + dict_driver = file + dict_file_path = %h/Maildir/dovecot-attributes + } protocol imap { imap_metadata = yes diff --git a/source/configuration_manual/mail_crypt_plugin.rst b/source/configuration_manual/mail_crypt_plugin.rst index bdccf4510..4f3bf642a 100644 --- a/source/configuration_manual/mail_crypt_plugin.rst +++ b/source/configuration_manual/mail_crypt_plugin.rst @@ -95,7 +95,7 @@ than one key pair, but only one can be active. :dovecot_plugin:ref:`crypt_user_key_curve` must be set. -:dovecot_core:ref:`mail_attribute_dict` must be set, as is is used to store the +:dovecot_core:ref:`mail_attribute` must be set, as is is used to store the keys. Unencrypted User Keys @@ -108,7 +108,10 @@ Example config for folder keys with Maildir: .. code-block:: none - mail_attribute_dict = file:%h/Maildir/dovecot-attributes + mail_attribute { + dict_driver = file + dict_file_path = %h/Maildir/dovecot-attributes + } mail_plugins = $mail_plugins mail_crypt crypt_user_key_curve = secp521r1 @@ -123,7 +126,10 @@ Example config for mandatory encrypted folder keys with Maildir: .. code-block:: none - mail_attribute_dict = file:%h/Maildir/dovecot-attributes + mail_attribute { + dict_driver = file + dict_file_path = %h/Maildir/dovecot-attributes + } mail_plugins = $mail_plugins mail_crypt crypt_user_key_curve = secp521r1 diff --git a/source/configuration_manual/protocols/imap_server.rst b/source/configuration_manual/protocols/imap_server.rst index c3a0c0171..badfbe906 100644 --- a/source/configuration_manual/protocols/imap_server.rst +++ b/source/configuration_manual/protocols/imap_server.rst @@ -18,7 +18,7 @@ Some of the extensions need to be explicitly enabled: * SPECIAL-USE * NOTIFY: Set :dovecot_core:ref:`mailbox_list_index` to ``yes`` * URLAUTH: Set :dovecot_core:ref:`imap_urlauth_host` and - :dovecot_core:ref:`mail_attribute_dict` + :dovecot_core:ref:`mail_attribute` .. seealso:: diff --git a/source/settings/core.rst b/source/settings/core.rst index b6b53b4ba..941131e32 100644 --- a/source/settings/core.rst +++ b/source/settings/core.rst @@ -1282,14 +1282,17 @@ See :ref:`settings` for list of all setting groups. commands. .. note:: If activated, a dictionary needs to be configured, via the - :dovecot_core:ref:`mail_attribute_dict` setting. + :dovecot_core:ref:`mail_attribute` setting. Example: .. code-block:: none # Store METADATA information within user's Maildir directory - mail_attribute_dict = file:%h/Maildir/dovecot-attributes + mail_attribute { + dict_driver = file + dict_file_path = %h/Maildir/dovecot-attributes + } protocol imap { imap_metadata = yes @@ -2121,22 +2124,24 @@ See :ref:`settings` for list of all setting groups. Attachments below this size will not be saved externally. -.. dovecot_core:setting:: mail_attribute_dict +.. dovecot_core:setting:: mail_attribute :seealso: @imap_metadata;dovecot_core - :todo: Indicate metadata setting - :values: @string - - The dictionary to be used for key=value mailbox attributes. + :values: @named_filter - This is used by the URLAUTH and METADATA extensions. + Named filter for initializing :ref:`dict driver ` for server and + mailbox attributes (key=value). - :ref:`Mail user variables ` can be used. + This is used by the URLAUTH and METADATA extensions, as well as various + other features. Example: .. code-block:: none - mail_attribute_dict = file:%h/dovecot-attributes + mail_attribute { + dict_driver = file + dict_file_path = %h/dovecot-attributes + } .. dovecot_core:setting:: mail_cache_fields