Question about Sieve scripts

[thepepe123]

Hi everyone,

I have successfully set up the mail server and had no problems at all, but now I'm failing with the Sieve scripts.

Unfortunately, there is not enough documentation on the subject for me and it is too shallow. I think I have understood the difference between “System Scripts” and “User Scripts”, as this is explained on the documentation page. 1, 2

Where I have problems now is running a Sieve script directly in the User Script field, or is the field not there for scripts directly but only the link to the scripts in the file system?

To try it out, I created the script in the file system and added in the Webgui under Settings -> Scripting -> User Scripts
inserted:

[sieve.untrusted.scripts.global_two]
contents = "%{file:/opt/stalwart-mail/etc/sieve/global-script.sieve}%"

but when I save and reload the configuration I get

Build error for "sieve.untrusted.scripts.global.contents": Failed to compile untrusted Sieve script: Expected token "instruction" but found "[" at line 1, column 0.

Unfortunately I do not understand how to use the scripts. I am completely confused how to use this.

Thanks for the help.

Regards

[mdecimus]

Hi,

Please read the section about macro limitations. In particular file macros only work on local settings which Sieve scripts are not by default (you can make them local though).

Also, note that global user scripts are not loaded automatically. You need to use ManageSieve or JMAP for Sieve to create a user script that imports your global script.

[thepepe123]

Thank you.

How do I go about managing the scripts via the Webgui or am I misinterpreting the User Scripts field?

[mdecimus]

From the webadmin you can only manage the global user scripts. To manage the scripts for a given mailbox you need one of the tools mentioned above.

[jac-cbi]

Based on this advice, I used the Perl (?!) script sieve-connect to connect up to my instance of stalwart mail-server, upload my user's sieve script (only one, just filtering mailing list emails into separate folders based on List-Id), and activated it the same way.

Sadly, even after restarting the server, email are not being sorted into the appropriate folders. Here's my sieve script:

require ["fileinto", "variables", "header", "envelope", "vnd.stalwart.expressions"];

# Check for List-Id header
if header :contains ["List-Id"] "*" {
    if anyof (
        header :contains ["List-Id"] "linux-kernel.vger.kernel.org",
        header :contains ["List-Id"] "linux-crypto.vger.kernel.org",
        header :contains ["List-Id"] "netdev.vger.kernel.org",
        header :contains ["List-Id"] "rust-for-linux.vger.kernel.org"
    ) {
        fileinto "ML.linux-all";
        stop;
    }

    if header :contains ["List-Id"] "oss-security.lists.openwall.com" {
        fileinto "ML.oss-security";
        stop;
    }

    if header :contains ["List-Id"] "cryptography.metzdowd.com" {
        fileinto "ML.cryptography";
        stop;
    }
}

# Check SPF, DKIM, and DMARC
if allof (
    header :contains ["Received-SPF"] "spf=pass",
    header :contains ["Authentication-Results"] "dkim=pass",
    header :contains ["Authentication-Results"] "dmarc=pass"
) {
    fileinto "Inbox";
    stop;
}

# Default to Spam
fileinto "Spam";

Any thoughts on why this might be happening? Or better yet, is there a non-firehose way to debug just the script running?

[mdecimus]

I haven't tested it but the script looks fine. I suggest that you try running Stalwart in debug or trace mode to make sure the script is being loaded. Also try with a simpler script that just performs one action to rule out other issues.

[jac-cbi]

Ah, right. I got this working. Enabling trace/debug did show the sieve error. Which, imo, should be an error, not a debug message.

Unfortunately, it's been running for a couple of weeks now, happily sorting away, so I've lost the exact log message.

I recall that header wasn't considered a valid include, and then to generically match all List-Id, I had to remove the asterisk from the right side of the expression. Then it started working like a champ.