Skip to content

imapsieve: Add missing Dovecot environment items #1597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
slusarz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

imapsieve: Add missing Dovecot environment items #1597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/core/plugins/imap_sieve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ This plugin registers the `imapsieve` extension with the Sieve
interpreter. This extension is enabled implicitly, which means that it
does not need to be added to the [[setting,sieve_extensions]] setting.

## Dovecot-specific Environment Items

The `imapsieve` extension ([[rfc,6785]]) defines environment items for the `environment` extension ([[rfc,5183]]). Beyond those, Dovecot provides additional environment items via the `vnd.dovecot.imapsieve` extension (enabled with `require "vnd.dovecot.imapsieve";`):

Comment thread
slusarz marked this conversation as resolved.
- `vnd.dovecot.mailbox-from`: The source mailbox from which the message is being copied or moved (populated during IMAP `COPY` or `MOVE` commands).
- `vnd.dovecot.mailbox-to`: The destination mailbox to which the message is being copied. When not executing from an IMAP `COPY` or `MOVE` command, this is equal to `imap.mailbox`.


## Example Configuration

```doveconf[dovecot.conf]
Expand Down
2 changes: 2 additions & 0 deletions docs/core/plugins/sieve_imapsieve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The `sieve_imapsieve` plugin implements the `imapsieve` extension
for the Sieve filtering language, adding functionality for using Sieve
scripts from within IMAP.

It also provides the Dovecot-specific `vnd.dovecot.imapsieve` extension, which exposes environment items such as `vnd.dovecot.mailbox-from` (source mailbox during IMAP `COPY`/`MOVE`) and `vnd.dovecot.mailbox-to` (destination mailbox).

::: tip
Full details about this plugin can be found at [[plugin,imap-sieve]].
:::