PIGEONHOLE(7)

โœจ PIGEONHOLE(7) โœจ

okay bestie, sit DOWN, because this is the pigeonhole(7) page and it's literally the vibe tour of the Pigeonhole Sieve support for Dovecot ๐Ÿ•Š๏ธ๐Ÿ’–


๐ŸŒธ NAME ๐ŸŒธ

pigeonhole โ€” a whole overview of the Pigeonhole Sieve support for Dovecot, no cap โœจ


๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

Pigeonhole adds support for the Sieve language (RFC 5228) and the ManageSieve protocol (RFC 5804) to Dovecot (dovecot(1)). periodt ๐Ÿ’…

ngl the name is lowkey iconic. In the literal sense, a pigeonhole is a hole or recess inside a dovecot for pigeons to nest in ๐Ÿฆ. But it's ALSO the name for one of a series of small, open compartments in a cabinet used for filing or sorting mail. And as a verb? It describes the act of putting an item into one of those pigeonholes. So the name "Pigeonhole" well describes an important part of the functionality that it adds to Dovecot: sorting and filing e-mail messages ๐Ÿ“ฌโœจ

The Sieve language is used to specify how e-mail needs to be processed. By writing Sieve scripts, users can customize how messages are delivered, e.g. whether they are forwarded or stored in special folders. Unwanted messages can be discarded or rejected, and, when the user is not available, the Sieve interpreter can send an automated reply ๐Ÿค–๐Ÿ’Œ

Above all, the Sieve language is meant to be simple, extensible and system independent. And โ€” plot twist โ€” unlike most other mail filtering script languages, it does not allow users to execute arbitrary programs ๐Ÿ˜ณ. This is particularly useful to prevent virtual users from having full access to the mail store. The intention of the language is to make it impossible for users to do anything more complex (and dangerous) than write simple mail filters. it's giving safety queen ๐Ÿ‘‘

Using the ManageSieve protocol, users can upload their Sieve scripts remotely, without needing direct filesystem access through FTP or SCP ๐Ÿซถ. Additionally, a ManageSieve server always makes sure that uploaded scripts are valid, preventing compile failures at mail delivery. so thoughtful of it ๐Ÿ˜ญ

Pigeonhole provides the following items:

  • The LDA Sieve plugin for Dovecot's Local Delivery Agent (LDA) (dovecot-lda(1)) that facilitates the actual Sieve filtering upon delivery ๐Ÿ’Œ
  • The ManageSieve service that implements the ManageSieve protocol through which users can remotely manage Sieve scripts on the server ๐ŸŒ
  • A plugin for Dovecot's doveadm(1) command line tool that adds new doveadm-sieve(1) commands for management of Sieve filtering ๐Ÿ› ๏ธ
  • The imap-sieve plugin documentation plugin, which provides the ability to attach Sieve scripts that are run for IMAP events in their mailboxes ๐Ÿ“ฅ
  • The imap-filter-sieve plugin documentation that allows refiltering mails in a mailbox using Sieve scripts ๐Ÿ”

The functionality and configuration of the LDA Sieve plugin and the ManageSieve service is described in detail in the README and INSTALL files contained in the Pigeonhole package and in sieve. iykyk ๐Ÿ“š


๐ŸŽ€ the command line tools (yes, outside of doveadm) ๐ŸŽ€

The following command line tools are available outside of doveadm:

  • sievec(1) โ€” Compiles Sieve scripts into a binary representation for later execution โš™๏ธ
  • sieve-test(1) โ€” The universal Sieve test tool for testing the effect of a Sieve script on a particular message ๐Ÿงช
  • sieve-filter(1) โ€” Filters all messages in a particular source mailbox through a Sieve script ๐Ÿ—‚๏ธ
  • sieve-dump(1) โ€” Dumps the content of a Sieve binary file for (development) debugging purposes ๐Ÿ”

๐Ÿ’€ REPORTING BUGS ๐Ÿ’€

found a bug? not the vibe, but okay, let's handle it bestie ๐Ÿซถ

Report bugs, including doveconf -n output, to the Dovecot Mailing List โŸจdovecot@dovecot.orgโŸฉ. Information about reporting bugs is available at: โŸจhttps://dovecot.org/bugreport.htmlโŸฉ

don't forget the doveconf -n output, fr fr, they literally need it ๐Ÿ™ˆ

๐ŸŒˆ SEE ALSO ๐ŸŒˆ

dovecot(1), dovecot-lda(1), doveadm(1), doveadm-sieve(1), sieve-dump(1), sieve-test(1), sieve-filter(1), sievec(1)

Additional resources:

  • sieve ๐ŸŒธ

and that's the whole page, bestie, you ate that ๐Ÿ‘‘โœจ this was PIGEONHOLE(7) from the f00471c version, dated August 2026 โ€” mwah, go sort some mail ๐Ÿ’…๐Ÿ’–๐Ÿ•Š๏ธ

๐Ÿ“ฆ where this page comes from