How to activate a sieve script?

[blqdev]

Greetings. I've written a sieve script in Notepad as follows

[session.data]
script = "'myscript'"

[sieve.trusted.scripts.myscript]
contents = '''
    <script contents>
'''

But am unsure how to proceed.

I added the <script contents> to the Stalwart UI under Settings > Scripting > System Scripts - is this correct?

Where/how do I add this section:

[session.data]
script = "'myscript'"

According to #655, I can attach the script to the DATA stage of the SMTP transaction. How?
According to #616, I can upload scripts to "my account" using the ManageSieve or JMAP for Sieve protocols. What is "my account"? How do I upload scripts using ManageSieve?

Any pointers will be appreciated.

[mdecimus]

Whether you add your script to the SMTP DATA stage or to your personal accounts using ManageSieve depends on whether you want this script to run globally on all messages that enter the system or just for messages that reach your mailbox.

[blqdev]

Thanks, the effect of adding the script to SMTP DATA stage and to a personal account is now understood, but I still can't figure out how to add the script to either.

I've added the script to the webadmin under Settings > Scripting > System Scripts, now how do I ensure the script is executed during the SMTP DATA stage? And how do I add it to personal accounts using ManageSieve?

[mdecimus]

I've added the script to the webadmin under Settings > Scripting > System Scripts, now how do I ensure the script is executed during the SMTP DATA stage?

You can set the log level to trace and check the logs after you received an email.

And how do I add it to personal accounts using ManageSieve?

You need a mail client that supports ManageSieve. I think SnappyMail does support it.

[blqdev]

You can set the log level to trace and check the logs after you received an email.

As in adding the script to the webadmin under Settings > Scripting > System Scripts is indeed all I needed to do for the script to execute? And there's no need to add

[session.data]
script = "'myscript'"

anywhere? Earlier you mentioned having to add the script to the SMTP DATA stage for it to run globally. Is that what adding the script to the webadmin under System Scripts does?

You need a mail client that supports ManageSieve. I think SnappyMail does support it.

Noted.

[blqdev]

You can set the log level to trace and check the logs after you received an email.

Here's the script:

[session.data]
script = "'forward-to-gmail'"

[sieve.trusted.scripts.forward-to-gmail]
contents = '''
    require ["envelope", "copy", "editheader"];

    if address :is "To" "[email protected]" {
        redirect :copy "[email protected]";
        deleteheader "DKIM-Signature";
        set "envelope.to" "[email protected]";
    }
'''

I set the log level to trace and checked the logs after receiving an email at [email protected] and searched the log for the script name forward-to-gmail and the intended forwarding address [email protected], which yielded no results.

I suspect the script isn't being executed because I haven't done anything with this part of the script:

[session.data]
script = "'forward-to-gmail'"

Since I don't know where to add this part.

Please advise further?

[mdecimus]

The script is incorrect, you are redirecting the email to [email protected] rather than [email protected]. Changing the envelope.to variable does not trigger a message forward.

[blqdev]

OK, figured it out.

Just add the whole script to the bottom of the config file like so:

[session.data]
script = "'myscript'"

[sieve.trusted.scripts.myscript]
contents = '''
    <script contents>
'''

No need to add it to the web interface.