Sieve Environment Items

Created

  • 2008-05-01

Last Updated

  • 2015-01-22

Available Formats


Sieve Environment Items

Reference

  • RFC 5183: Sieve Email Filtering: Environment Extension

Note

The specifics of this registry are given in Section 4.3.

Available Formats

Range Registration Procedures
name begins with "vnd." First Come First Served
standardized (no "vnd." prefix) Standards track or experimental RFC
Capability name Description RFC number Contact address
domain The primary DNS domain associated with the Sieve execution context, usually but not always a proper suffix of the host name. RFC 5183 The Sieve discussion list
host The fully-qualified domain name of the host where the Sieve script is executing. RFC 5183 The Sieve discussion list
imap.changedflags If the script was invoked because of flag changes to an existing message, this contains the name(s) of the flag(s) that have changed. Otherwise, the value of this item MUST be the empty string. RFC 6785 The Sieve discussion list
imap.cause The name of the action that caused the script to be invoked. Its value is one of the following: APPEND (for invocations resulting from APPEND commands), COPY (for invocations resulting from COPY commands), or FLAG (for invocations resulting from flag changes). RFC 6785 The Sieve discussion list
imap.email The primary email address of the IMAP user that caused the action (the user identified by "imap.user"). RFC 6785 The Sieve discussion list
imap.mailbox The name of the mailbox that the affected message is in, in the case of existing messages, or is targeted to be stored into, in the case of new messages. The value of this item is fixed when the script begins, and, in particular, MUST NOT change as a result of any action, such as "fileinto". RFC 6785 The Sieve discussion list
imap.user The identity (IMAP login ID) of the IMAP user that caused the action. RFC 6785 The Sieve discussion list
location Type of service executing the Sieve script. RFC 5183 The Sieve discussion list
name The product name associated with the Sieve interpreter. RFC 5183 The Sieve discussion list
phase Point relative to final delivery at which the Sieve script is being evaluated. RFC 5183 The Sieve discussion list
remote-host Host name of remote SMTP client, if applicable and available. RFC 5183 The Sieve discussion list
remote-ip IP address of remote SMTP client, if applicable and available. RFC 5183 The Sieve discussion list
version The product version associated with the Sieve interpreter. RFC 5183 The Sieve discussion list
vnd.dovecot.* (anything starting with "vnd.dovecot.") An environment item specific to the Dovecot Secure IMAP server http://www.dovecot.org. Stephan Bosch; Timo Sirainen

Contact Information

Name Contact URI Last Updated
Stephan Bosch stephan&rename-it.nl
The Sieve discussion list sieve&ietf.org
Timo Sirainen tss&iki.fi