Internet Assigned Numbers Authority Sieve Extensions Created 2000-11 Last Updated 2023-08-10 Available Formats [IMG] XML [IMG] HTML [IMG] Plain text Registries included below • Sieve Extensions • Sieve URN Parameters • Sieve Actions Sieve Extensions Reference [RFC5228] Available Formats [IMG] CSV Range Registration Procedures vendor-controlled (name begins with "vnd.") First Come First Served IETF-controlled (no "vnd." prefix) Standards track or IESG-approved experimental RFC Capability name Description RFC number Contact address Registration date body Provides a test for matching against the [RFC5173] [Sieve_discussion_list] the body of the message being processed comparator-* (anything adds the indicated comparator for use starting with with the :comparator argument [RFC4790][RFC5228] (Sieve base spec) [Sieve_discussion_list] "comparator-") adds a new Sieve test and action that convert enable Sieve scripts to perform data [RFC6558] [Sieve_discussion_list] conversions on the message being delivered. copy [RFC3894] [Jutta_Degener] date The "date" extension gives Sieve the [RFC5260] [Sieve_discussion_list] ability to test date and time values. Adds test 'duplicate' that can be used to test whether a particular message is duplicate a duplicate, i.e., whether a copy of it [RFC7352] [Sieve_discussion_list] 2014-06-30 was seen before by the delivery agent that is executing the Sieve script. Adds actions 'addheader' and editheader 'deleteheader' that modify the header of [RFC5293] [Sieve_discussion_list] the message being processed enclose adds the "enclose" action for enclosing [RFC5703] [Sieve_discussion_list] a message with a wrapper. changes the interpretation of strings to encoded-character allow arbitrary octets and Unicode [RFC5228] (Sieve base spec) [Sieve_discussion_list] characters to be represented using US-ASCII adds the 'notify' action for notifying user about the received message. It also provides two new tests: enotify valid_notify_method checks notification [RFC5435] [Sieve_discussion_list] URIs for validity; notify_method_capability can check recipients capabilities. adds the 'envelope' test for testing the envelope message transport sender and recipient [RFC5228] (Sieve base spec) [Sieve_discussion_list] address The "envelope-deliverby" extension extends the envelope test to allow envelope-deliverby checking of information associated with [RFC6009] [Sieve_discussion_list] the Deliver-By ESMTP extension defined in [RFC2852]. The "envelope-dsn" extension extends the envelope-dsn envelope test to allow checking of [RFC6009] [Sieve_discussion_list] information associated with the DSN ESMTP extension defined in [RFC3461]. The "environment" extension provides a new environment test that can be used to environment implement scripts that behave [RFC5183] [Sieve_discussion_list] differently when moved from one system to another or otherwise operated in different contexts. adds the 'ereject' action for refusing delivery of a message. The refusal ereject should happen as early as possible (e.g. [RFC5429] [Sieve_discussion_list] at the protocol level) and might not preserve the exact reason for refusal if it contains non-US-ASCII text. Adds the ":list" match type to certain Sieve tests, and the ":list" argument to the "redirect" action. The ":list" match type changes tests to match values extlists against values stored in one or more [RFC6134] [Sieve_discussion_list] externally stored lists. The ":list" argument to the redirect action changes the redirect action to forward the message to email addresses stored in the externally stored list. extracttext adds the "extracttext" action for [RFC5703] [Sieve_discussion_list] extracting text from a MIME body part. Adds the ":fcc" parameter to Sieve fcc action commands that generate additional [RFC8580] [Sieve_discussion_list] 2019-01-29 messages. adds the 'fileinto' action for [RFC5228] (Sieve base spec), fileinto delivering to a mailbox other than the [RFC5490] (:create), [RFC3894] [Sieve_discussion_list] default (:copy), [RFC5232] (:flags) adds the "foreverypart" and "break" foreverypart actions for iterating through MIME parts [RFC5703] [Sieve_discussion_list] of a message. The "ihave" extension provides a means ihave to write scripts that make use of other [RFC5463] [Sieve_discussion_list] extensions only when they are actually available. imapsieve Add Sieve processing for IMAP events. [RFC6785] [Sieve_discussion_list] imap4flags Adds actions and tests for manipulating [RFC5232] [Sieve_discussion_list] IMAP flags adds the "include" command to execute other Sieve scripts, the "return" action include from an included script, and the [RFC6609] [Sieve_discussion_list] "global" command and "global" variables namespace to access variables shared among included scripts. The "index" extension provides a means index to limit header and address tests to [RFC5260] [Sieve_discussion_list] specific instances when more than one field of a given type is present. adds test for checking for mailbox mailbox existence and a new optional argument to [RFC5490] [Sieve_discussion_list] fileinto for creating a mailbox before attempting mail delivery. adds a test for checking mailbox existence by OBJECTID, and new optional mailboxid arguments to fileinto and :fcc that [RFC9042] [EXTRA_discussion_list] 2021-03-30 allow selecting the destination mailbox by OBJECTID. adds tests for checking for mailbox mboxmetadata metadata item existence and for [RFC5490] [Sieve_discussion_list] retrieving of a mailbox metadata value. adds the ":mime" and ":anychild" tagged arguments to the "header", "address", mime and "exists" tests. Adds the ":type", [RFC5703] [Sieve_discussion_list] ":subtype", ":contenttype", and ":param" options when ":mime" is used with the "header" test. The "redirect-deliverby" extension extends the redirect action to allow redirect-deliverby specification of the BY ESMTP parameter [RFC6009] [Sieve_discussion_list] associated with the Deliver-By SMTP extension defined in [RFC2852]. The "redirect-dsn" extension extends the redirect action to allow specification redirect-dsn of the NOTIFY and RET ESMTP parameters [RFC6009] [Sieve_discussion_list] associated with the DSN SMTP extension defined in [RFC3461]. regex [draft-murchison-sieve-regex-07] [Kenneth_Murchison] adds the "reject" action for refusing reject delivery of a message. The exact reason [RFC5429] [Sieve_discussion_list] for refusal is conveyed back to the client. Extends existing conditional tests in relational Sieve language to allow relational [RFC5231] [Sieve_discussion_list] operators replace adds the "replace" action for replacing [RFC5703] [Sieve_discussion_list] a MIME body part of a message. adds tests for checking for server servermetadata metadata item existence and for [RFC5490] [Sieve_discussion_list] retrieving of a server metadata value. Provides a test to check for varying spamtest likelihood of an email message being [RFC5235] [Sieve_discussion_list] spam. Provides a test to check for varying spamtestplus likelihood of an email message being [RFC5235] [Sieve_discussion_list] spam, possibly using a percentage range. adds a test for checking whether an IMAP special-use attribute is assigned for a special-use particular mailbox or any mailbox, and [RFC8579] [Sieve_discussion_list] 2019-01-29 it adds the ability to file messages into a mailbox identified solely by a special-use attribute. adds the ':user' and ':detail' address subaddress parts for use with the address and [RFC5233] [Sieve_discussion_list] envelope tests adds an action for generating an vacation auto-reply saying that the original [RFC5230] [Sieve_discussion_list] message will not be read or answered immediately adds the ":seconds" parameter to the vacation-seconds Sieve Vacation extension. [RFC6131] [Sieve_discussion_list] Implementations that support this MUST also support "vacation". variables Adds support for variables to the Sieve [RFC5229] [Sieve_discussion_list] filtering language. Provides a test to check for varying virustest likelihood of there being malicious [RFC5235] [Sieve_discussion_list] content in an email message. vnd.cyrus.* (anything Extends the Sieve language with starting with vendor-defined functionality specific to Not applicable [Kenneth_Murchison] 2020-05-05 "vnd.cyrus.") the Cyrus IMAP server ([http://www.cyrusimap.org]). vnd.dovecot.* Extends the Sieve language with (anything starting vendor-defined functionality specific to Not applicable [Stephan_Bosch][Timo_Sirainen] 2008-07-28 with "vnd.dovecot.") the Dovecot Secure IMAP server ([http://www.dovecot.org]). vnd.stalwart.* Extends the Sieve language with (anything starting vendor-defined functionality specific to Not applicable [Mauro_De_Gennaro] 2022-11-02 with "vnd.stalwart.") the Stalwart JMAP server [http://www.stalw.art]. Sieve URN Parameters Registration Procedure(s) Specification Required Expert(s) Unassigned Reference [RFC6134] Available Formats [IMG] CSV URN Parameter Name Reference addrbook [RFC6134], section 2.6 Sieve Actions Registration Procedure(s) Expert Review Expert(s) Alexey Melnikov, Ken Murchison Reference [RFC9122] Available Formats [IMG] CSV Cancels Can Use Name Description References Capabilities Action Implicit With Comments Interactions Keep? IMAP Events? All Add a header subsequent field to the tests and addheader existing [RFC5293] "editheader" actions apply No Yes message header to the altered message Add IMAP flags to a list of IMAP flags addflag that would be [RFC5232][RFC5229] "imap4flags", No Yes set on the "variables" message if it gets delivered to a mailbox All Convert body subsequent parts from one tests and convert MIME type to [RFC6558] "convert" actions apply No Yes another to the altered message All Remove a subsequent header field tests and deleteheader from the [RFC5293] "editheader" actions apply No Yes existing to the message header altered message Silently throw discard away the [RFC5228] Yes Yes message All subsequent Enclose a tests and message as an actions enclose attachment to [RFC5703] "enclose" except No Yes a new message "redirect" apply to the altered message This action is incompatible with the "vacation" action. Typically is Refuse not permitted ereject delivery of [RFC5429] "ereject" with actions Yes No the message that cause mail delivery, such as "keep", "fileinto", and "redirect" Store text of extracttext a MIME part [RFC5703][RFC5229] "extracttext", No Yes into a "variables" variable Deliver the "fileinto", "copy", Use of :copy message into "imap4flags", suppresses fileinto the specified [RFC5228][RFC3894][RFC5232][RFC5490][RFC9042][RFC8579] "mailbox", cancellation Yes Yes mailbox "mailboxid", of implicit "special-use" keep File the keep message into [RFC5228][RFC5232] "imap4flags" Yes Yes the user's main mailbox Send a notify notification [RFC5435][RFC8580] "enotify", "fcc" No Yes to a user "copy", Use of :copy Send (forward) "redirect-dsn", suppresses redirect the message to [RFC5228][RFC3894][RFC6009][RFC6134] "redirect-deliverby", cancellation Yes Yes another user "extlists" of implicit keep This action is incompatible with the "vacation" action. Typically is Refuse not permitted reject delivery of [RFC5429] "reject" with actions Yes No the message that cause mail delivery, such as "keep", "fileinto", and "redirect" Remove IMAP flags from a list of IMAP flags that "imap4flags", removeflag would be set [RFC5232][RFC5229] "variables" No Yes on the message if it gets delivered to a mailbox All subsequent tests and Replace a MIME actions replace part [RFC5703] "replace" except No Yes "redirect" apply to the altered message set Store a value [RFC5229] "variables" No Yes in a variable Set IMAP system flags or keywords setflag that would be [RFC5232][RFC5229] "imap4flags", No Yes set on the "variables" message if it gets delivered to a mailbox This action Implement a "vacation", is vacation vacation [RFC5230][RFC6131][RFC8580] "vacation-seconds", incompatible No No autoresponder "fcc" with "reject" and "ereject" actions Contact Information ID Name Organization Contact URI Last Updated [EXTRA_discussion_list] EXTRA discussion list mailto:extra&ietf.org [Jutta_Degener] Jutta Degener Sendmail, Inc. 6425 Christie Ave, 4th Floor Emeryville, mailto:jutta&sendmail.com CA 94608 [Kenneth_Murchison] Kenneth Murchison mailto:sieve&cyrusimap.org 2020-05-05 [Mauro_De_Gennaro] Mauro De Gennaro mailto:mauro&stalw.art 2022-11-02 [Sieve_discussion_list] Sieve discussion list mailto:sieve&ietf.org [Stephan_Bosch] Stephan Bosch mailto:stephan&rename-it.nl [Timo_Sirainen] Timo Sirainen mailto:tss&iki.fi Licensing Terms