docs(groupware): Add documentation for filter ui

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
This commit is contained in:
Daniel Kesselberg
2024-11-13 16:55:08 +01:00
parent 3e10a7c536
commit 1f6f97825b

View File

@@ -323,7 +323,7 @@ The mail app supports summarizing message threads that contain 3 or more message
Filtering and autoresponder
---------------------------
The Mail app has a simple editor for Sieve scripts and an interface to configure autoresponders. Sieve has to be enabled in the :ref:`account settings <mail-account-settings>`.
The Mail app has a editor for Sieve scripts, an interface to configure autoresponders and an interface to configure filters. Sieve has to be enabled in the :ref:`account settings <mail-account-settings>`.
Autoresponders
~~~~~~~~~~~~~~
@@ -332,6 +332,52 @@ Autoresponders
The autoresponder is off by default. It can be set manually, or follow the system settings. Following system settings means that the long absence message entered on the :ref:`Absence settings section <groupware-absence>` is applied automatically.
Filter
~~~~~~
.. versionadded:: 4.1
Mail 4.1 includes a simple editor to configure filter rules.
.. note:: Importing existing filters is not supported. However, all existing filters will remain active and unchanged. We recommend backing up your current script through the Sieve script editor as a precaution.
How to Add a New Filter
^^^^^^^^^^^^^^^^^^^^^^^
1. Open your account settings.
2. Verify that Sieve is enabled for your account (see Sieve server settings).
3. Click on Filters.
4. Select New Filter to create a new rule.
How to Delete a Filter
^^^^^^^^^^^^^^^^^^^^^^
1. Open your account settings.
2. Ensure that Sieve is enabled for your account (see Sieve server settings).
3. Click on Filters.
4. Hover over the filter you wish to delete, then click the trash icon.
Tests
^^^^^
Tests are applied to incoming emails on your mail server, targeting fields such as subject (the email\'s subject line), from (the sender), and to (the recipient). You can use the following operators to define conditions for these fields:
- **is**: An exact match. The field must be identical to the provided value.
- **contains**: A substring match. The field matches if the provided value is contained within it. For example, "report" would match "port".
- **matches**: A pattern match using wildcards. The "*" symbol represents any number of characters (including none), while "?" represents exactly one character. For example, "*report*" would match "Business report 2024".
Actions
^^^^^^^
Actions are triggered when the specified tests are true. The following actions are available:
- **fileinto**: Moves the message into a specified folder.
- **addflag**: Adds a flag to the message.
- **stop**: Halts the execution of the filter script. No further filters with will be processed after this action.
Follow-up reminders
-------------------