nixos/dovecot: add support for sieve extensions, in particular imapsieve and pipe #275031

2xsaiko · 2023-12-17T17:40:59Z

Description of changes

Finally upstreaming some stuff from my config that I've been running for years. This is used on my mail server, where I use it to drive automatic learning for the spam filter. In action here: https://git.dblsaiko.net/systems/tree/configurations/polaris/dovecot.nix?id=8ea672890c78b059e002920628636234c7541c1f#n54

Adds general support for enabling Sieve plugins/extensions, support for the IMAPSieve plugin and support for specifying which binaries are available from the vnd.dovecot.pipe extension (part of the Extprograms plugin). IMAPSieve is used to trigger Sieve scripts on IMAP user actions, like moving mails around. vnd.dovecot.pipe can be used to run external programs from a Sieve script, for example passing the mail to rspamd to register it as spam.

Documentation for the IMAPSieve plugin: https://doc.dovecot.org/configuration_manual/sieve/plugins/imapsieve/
Documentation for the Extprograms plugin: https://doc.dovecot.org/configuration_manual/sieve/plugins/extprograms/

Things done

Add a 👍 reaction to pull requests you find important.

RaitoBezarius · 2023-12-21T11:10:31Z

nixos/modules/services/mail/dovecot.nix

+          from = mkOption {
+            default = null;
+            description = ''
+              Only execute the administrator Sieve scripts for the mailbox configured with services.dovecot2.imapsieve.mailbox.${name}.name when the message originates from the indicated mailbox.


Not sure if you can refer to ${name} here.

How do you build the manual? I wanted to check how it looks in there when I wrote this but couldn't figure out a way to do it :D

What would you write instead?

I'd just do <name> or *, this is the convention I usually see.

RaitoBezarius · 2023-12-21T11:11:20Z

nixos/modules/services/mail/dovecot.nix

@@ -459,4 +622,5 @@ in

  };

+  meta.maintainers = [lib.maintainers.dblsaiko];


Suggested change

meta.maintainers = [lib.maintainers.dblsaiko];

meta.maintainers = [ lib.maintainers.dblsaiko ];

RaitoBezarius

LGTM; untested.

…eve and pipe

RaitoBezarius · 2024-01-14T19:37:28Z

@2xsaiko This broke my production deployment of dovecot2 with the following error:

Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: line 1: error: require command: unknown Sieve capability `fileinto'.
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: line 4: error: unknown command 'fileinto' (only reported once at first occurrence).
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: error: validation failed.
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: sievec: Fatal: failed to compile sieve script '/var/lib/dovecot/sieve/after'

RaitoBezarius · 2024-01-14T19:42:30Z

This probably misinteracts with https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/blob/master/mail-server/dovecot.nix?ref_type=heads#L310-330.

RaitoBezarius · 2024-01-14T19:44:21Z

After manual fixups, that is adding:

  services.dovecot2.sieve = {
    plugins = [ "sieve_imapsieve" "sieve_extprograms" ];
    extensions = [ "fileinto" ];
    globalExtensions = [ "+vnd.dovecot.pipe" "+vnd.dovecot.environment" ];
  };

It still complains with:

Jan 14 20:43:39 amadeus dovecot2-pre-start[3701122]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 20:43:39 amadeus dovecot2-pre-start[3701174]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 20:43:40 amadeus dovecot2-pre-start[3701175]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory

but is now not broken anymore.

nixos/modules/services/mail/dovecot.nix

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

2xsaiko · 2024-01-14T20:22:21Z

Jan 14 20:43:39 amadeus dovecot2-pre-start[3701122]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 20:43:39 amadeus dovecot2-pre-start[3701174]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 20:43:40 amadeus dovecot2-pre-start[3701175]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory

Hmm, that most likely comes from line 31 in dovecot-2.3.21/src/lib-old-stats/stats-connection.c which is called from line 394 in dovecot-2.3.21/src/plugins/old-stats/stats-plugin.c. Are you sure that error wasn't there before? This change isn't loading the old-stats plugin and I'm not getting that error either (it's also deprecated). Either way, it shouldn't be fatal from what I can see.

RaitoBezarius · 2024-01-14T20:26:33Z

You are probably right on the fact this existed before, I am just finishing mitigating the rest and then I will look further. Le dim. 14 janv. 2024, 21:22, Marco Rebhan ***@***.***> a écrit :

…

Jan 14 20:43:39 amadeus dovecot2-pre-start[3701122]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory Jan 14 20:43:39 amadeus dovecot2-pre-start[3701174]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory Jan 14 20:43:40 amadeus dovecot2-pre-start[3701175]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory Hmm, that most likely comes from line 31 in dovecot-2.3.21/src/lib-old-stats/stats-connection.c which is called from line 394 in dovecot-2.3.21/src/plugins/old-stats/stats-plugin.c. Are you sure that error wasn't there before? This change isn't loading the old-stats plugin and I'm not getting that error either (it's also deprecated). Either way, it shouldn't be fatal from what I can see. — Reply to this email directly, view it on GitHub <#275031 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACMZREWULI3PVG47O5LYKTYOQ5APAVCNFSM6AAAAABAYQEB76VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOJRGA3DENJSG4> . You are receiving this because you modified the open/close state.Message ID: ***@***.***>

RaitoBezarius · 2024-01-14T20:40:08Z

nixos/modules/services/mail/dovecot.nix

+            idx: el:
+              singleton "imapsieve_mailbox${toString idx}_name = ${el.name}"
+              ++ optional (el.from != null) "imapsieve_mailbox${toString idx}_from = ${el.from}"
+              ++ optional (el.causes != null) "imapsieve_mailbox${toString idx}_causes = ${el.causes}"


This should have been a list, I believe.

Yup, it should have. My bad!

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

dr460nf1r3 · 2024-01-18T18:32:25Z

@2xsaiko This broke my production deployment of dovecot2 with the following error:

Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: sievec: Error: stats: open(/run/dovecot2/old-stats-mail) failed: No such file or directory
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: line 1: error: require command: unknown Sieve capability `fileinto'.
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: line 4: error: unknown command 'fileinto' (only reported once at first occurrence).
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: after: error: validation failed.
Jan 14 18:34:30 amadeus dovecot2-pre-start[3655287]: sievec: Fatal: failed to compile sieve script '/var/lib/dovecot/sieve/after'

I can confirm this is an issue. We ran into it after a flake bump yesterday. Can test the PR if desired.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

…ipts` #275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

Since NixOS/nixpkgs#275031 things have became more structured when it comes to the sieve plugin. Relies on NixOS/nixpkgs#281001 for full features. Former-commit-id: fe6d325397f35eecb51bc77d04cc1a805c98e249

…ipts` NixOS#275031 introduced structured configuration for the dovecot2 sieve plugin, by doing so, it broke SNM configuration doing Sieve configurations. This attempts to fix up the public API to make it possible for SNM to pick up the pieces.

github-actions bot added 6.topic: nixos 8.has: module (update) labels Dec 17, 2023

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Dec 17, 2023

2xsaiko force-pushed the outgoing/sieve branch from 6c895c1 to e619533 Compare December 21, 2023 10:45

RaitoBezarius reviewed Dec 21, 2023

View reviewed changes

RaitoBezarius approved these changes Dec 21, 2023

View reviewed changes

2xsaiko force-pushed the outgoing/sieve branch from e619533 to a4fcdd4 Compare December 21, 2023 11:20

2xsaiko added 2 commits December 21, 2023 12:41

nixos/dovecot: add support for sieve extensions, in particular imapsi…

1e31a63

…eve and pipe

nixos/dovecot: add myself as maintainer

7004ee6

2xsaiko force-pushed the outgoing/sieve branch from a4fcdd4 to 7004ee6 Compare December 21, 2023 11:41

2xsaiko requested a review from RaitoBezarius December 21, 2023 12:07

RaitoBezarius approved these changes Jan 12, 2024

View reviewed changes

RaitoBezarius merged commit 1b2aeec into NixOS:master Jan 12, 2024
19 checks passed

RaitoBezarius reviewed Jan 14, 2024

View reviewed changes

nixos/modules/services/mail/dovecot.nix Show resolved Hide resolved

RaitoBezarius mentioned this pull request Jan 14, 2024

nixos/mail/dovecot2: re-introduce extra settings and rename sieveScripts #281001

Merged

13 tasks

RaitoBezarius reviewed Jan 14, 2024

View reviewed changes

beardhatcode added a commit to beardhatcode/nixpkgs that referenced this pull request Jan 22, 2024

Revert "Merge pull request NixOS#275031 from 2xsaiko/outgoing/sieve"

1a73346

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

beardhatcode added a commit to beardhatcode/nixpkgs that referenced this pull request Feb 6, 2024

Revert "Merge pull request NixOS#275031 from 2xsaiko/outgoing/sieve"

8c441dd

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

This was referenced Feb 7, 2024

sieve (dovecot/pigeonhole) script fails after updating #286859

Closed

nixos/dovecot: More sieve options and precompiling of scripts #35536

Closed

beardhatcode added a commit to beardhatcode/nixpkgs that referenced this pull request Mar 1, 2024

Revert "Merge pull request NixOS#275031 from 2xsaiko/outgoing/sieve"

d7df517

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

beardhatcode added a commit to beardhatcode/nixpkgs that referenced this pull request Mar 13, 2024

Revert "Merge pull request NixOS#275031 from 2xsaiko/outgoing/sieve"

0583bbf

This reverts commit 1b2aeec, reversing changes made to fb1f1bc.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/dovecot: add support for sieve extensions, in particular imapsieve and pipe #275031

nixos/dovecot: add support for sieve extensions, in particular imapsieve and pipe #275031

2xsaiko commented Dec 17, 2023

RaitoBezarius Dec 21, 2023

2xsaiko Dec 21, 2023

RaitoBezarius Dec 21, 2023

RaitoBezarius Dec 21, 2023

RaitoBezarius left a comment •

edited

RaitoBezarius commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024

2xsaiko commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024 via email

RaitoBezarius Jan 14, 2024

2xsaiko Jan 14, 2024

dr460nf1r3 commented Jan 18, 2024

		@@ -459,4 +622,5 @@ in

		};

		meta.maintainers = [lib.maintainers.dblsaiko];

	meta.maintainers = [lib.maintainers.dblsaiko];
	meta.maintainers = [ lib.maintainers.dblsaiko ];

nixos/dovecot: add support for sieve extensions, in particular imapsieve and pipe #275031

nixos/dovecot: add support for sieve extensions, in particular imapsieve and pipe #275031

Conversation

2xsaiko commented Dec 17, 2023

Description of changes

Things done

RaitoBezarius Dec 21, 2023

Choose a reason for hiding this comment

2xsaiko Dec 21, 2023

Choose a reason for hiding this comment

RaitoBezarius Dec 21, 2023

Choose a reason for hiding this comment

RaitoBezarius Dec 21, 2023

Choose a reason for hiding this comment

RaitoBezarius left a comment • edited

Choose a reason for hiding this comment

RaitoBezarius commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024

2xsaiko commented Jan 14, 2024

RaitoBezarius commented Jan 14, 2024 via email

RaitoBezarius Jan 14, 2024

Choose a reason for hiding this comment

2xsaiko Jan 14, 2024

Choose a reason for hiding this comment

dr460nf1r3 commented Jan 18, 2024

RaitoBezarius left a comment •

edited