Documentation for imap_filter

[allgoewer]

Hi all,

I'm having a hard time figuring out where to put the imap_filter directive in the default maddy.conf .

The documentation isn't really clear on that (at least to me) (see Doc) .

Can anyone help me out?

[foxcpp]

Good catch. Documentation for IMAP metadata filtering is a bit lacking.

maddy-storage specifies imap_filters directive that should be set in storage.imapsql block.

E.g. like this:

storage.imapsql local_mailboxes {
    driver sqlite3
    dsn imapsql.db
    
    imap_filter {
      command /var/lib/maddy/sieve.sh {account_name}
    }
}

It might be counter-intuitive (why not imap endpoint block?) but makes more sense if you consider that IMAP endpoint has nothing to do with message delivery.

[allgoewer]

I already tried that

storage.imapsql local_mailboxes {
    driver sqlite3
    dsn imapsql.db

    imap_filters {
        command /etc/maddy/sieve-{account_name}.sh
    }
}

leads to

Jul 08 17:24:40 ganymed maddy[9903]: /etc/maddy/maddy.conf:52: unexpected dir
ective: imap_filters

[foxcpp]

Oh, sorry, apparently there is a typo in the documentation and the actual directive name is imap_filter.

maddy/internal/storage/imapsql/imapsql.go

Line 269 in 27f468d

cfg.Custom("imap_filter", false, false, func() (interface{}, error) {

[allgoewer]

That works, thanks!

I think what confused me was the documentation referring to the directive as imap.filter.command.

I originally thought it should be going into the imap directive.

[foxcpp]

I improved maddy-imap text: https://maddy.email/man/_generated_maddy-imap.5/
I hope it makes it more clear.

Also note that placeholders are not expanded in command name to prevent command injection attacks (not relevant if you use just {account_name} but other placeholders may be more dangerous).