RFC 9122

IANA Registry for Sieve Actions

πŸ“… published June 2023, from ietf

IANA Registry for Sieve Actions πŸŽ€

Okay bestie, here's the vital info first πŸ’…

  • RFC: 9122
  • Title: IANA Registry for Sieve Actions
  • Authors: A. Melnikov (Isode Ltd) and K. Murchison (Fastmail) 🫢
  • Category: Standards Track
  • ISSN: 2070-1721
  • Date: June 2023
  • Obsoletes / Updates: The title block doesn't list anything here, so this one doesn't obsolete or update any other RFC 🌸

Abstract ✨

The Sieve Email Filtering Language [RFC5228] is a popular email filtering language used upon final mail delivery. This document creates a registry for Sieve actions so developers and Sieve extension writers can track interactions between different extensions πŸ¦‹

Status of This Memo πŸ“œ

This is an Internet Standards Track document πŸ”₯

It's a product of the Internet Engineering Task Force (IETF), so it represents the consensus of the IETF community. It went through public review and got approved for publication by the Internet Engineering Steering Group (IESG). For more on Internet Standards, check Section 2 of RFC 7841 πŸŽ€

Want the current status, any errata, or a way to send feedback? Head to https://www.rfc-editor.org/info/rfc9122 πŸ’–

Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved πŸ’œ

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) as in effect on the date of publication. Please review these documents carefully, because they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions, and they're provided without warranty as described in the Revised BSD License πŸ™ˆ

Table of Contents πŸ—ΊοΈ

1.  Introduction
2.  IANA Considerations
  2.1.  Sieve Actions Registration Template and Procedure
  2.2.  Initial Sieve Action Registry
3.  Security Considerations
4.  References
  4.1.  Normative References
  4.2.  Informative References
Appendix A.  Acknowledgements
Authors' Addresses

1. Introduction 🌈

The Sieve Email Filtering Language [RFC5228] is a popular email filtering language used upon final mail delivery. Sieve got so popular that there are now a myriad of Sieve extensions, and they can interact with each other in wonderful and complex ways 🀯 The catch is there's currently no easy way to find out all the actions defined by Sieve extensions published in RFCs. That makes it really hard for Sieve extension writers and Sieve implementation developers to foresee interactions between Sieve actions 😭

So this document creates a registry for Sieve [RFC5228] actions. The whole point is to help developers and Sieve extension writers track interactions between different extensions. It's giving organization, and I'm obsessed πŸ’…

2. IANA Considerations πŸ“‹

2.1. Sieve Actions Registration Template and Procedure πŸ’–

IANA has created the "Sieve Actions" registry (see Section 2.9 of [RFC5228] for details on Sieve actions). Registering actions is allowed and encouraged, whether they're specified in RFCs or in vendor-specific documentation πŸ™Œ Here's the registration template:

Name:  Name of the action
Description:  Short description
References:  One or more documents describing the action and any
   significant updates to its definition (this field is required for
   actions described in RFCs and is optional otherwise)
Capabilities:  Name of one or more Sieve capabilities associated with
   the Sieve action being registered
Action Interactions:  Interactions with other Sieve actions (as
   described in Section 2.10.1 of [RFC5228]), if any
Cancels Implicit Keep?  Flag specifying whether the action cancels
   the implicit keep (see Section 2.10.2 of [RFC5228])
Can Use With IMAP Events?  Whether or not this action can be used
   with IMAP events in Sieve [RFC6785]
Comments:  Optional comment or comments

The registration procedure is Expert Review [RFC8126], and the designated expert has a pretty chill job πŸ¦‹ They only check that the name of the action being registered matches the documentation, that the description field is accurate, that the correct documents are referenced, and that the list of relevant documents is as complete as possible. The designated expert can't reject a registration because they personally dislike the document defining an action. They should always err on the side of approving the registration, even if the documentation isn't complete 🌸

The same registration procedure is used to add a new reference or to change the description field of an existing registration. Same vibes, same process 🧚


To be continued in part 2 πŸ’œ

4.1. Normative References

okay these are the ones the spec leans on hardest, so they're required reading before you touch any of this πŸ“šβœ¨

[RFC5228]  Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email
           Filtering Language", RFC 5228, DOI 10.17487/RFC5228,
           January 2008, <https://www.rfc-editor.org/info/rfc5228>.

[RFC6785]  Leiba, B., "Support for Internet Message Access Protocol
           (IMAP) Events in Sieve", RFC 6785, DOI 10.17487/RFC6785,
           November 2012, <https://www.rfc-editor.org/info/rfc6785>.

4.2. Informative References

these are the extra reading that's good to know about 🧚 they're not required to implement the spec, but they're where all the Sieve extension drama lives πŸ’…

[RFC3894]  Degener, J., "Sieve Extension: Copying Without Side
           Effects", RFC 3894, DOI 10.17487/RFC3894, October 2004,
           <https://www.rfc-editor.org/info/rfc3894>.

[RFC5229]  Homme, K., "Sieve Email Filtering: Variables Extension",
           RFC 5229, DOI 10.17487/RFC5229, January 2008,
           <https://www.rfc-editor.org/info/rfc5229>.

[RFC5230]  Showalter, T. and N. Freed, Ed., "Sieve Email Filtering:
           Vacation Extension", RFC 5230, DOI 10.17487/RFC5230,
           January 2008, <https://www.rfc-editor.org/info/rfc5230>.

[RFC5232]  Melnikov, A., "Sieve Email Filtering: Imap4flags
           Extension", RFC 5232, DOI 10.17487/RFC5232, January 2008,
           <https://www.rfc-editor.org/info/rfc5232>.

[RFC5293]  Degener, J. and P. Guenther, "Sieve Email Filtering:
           Editheader Extension", RFC 5293, DOI 10.17487/RFC5293,
           August 2008, <https://www.rfc-editor.org/info/rfc5293>.

[RFC5429]  Stone, A., Ed., "Sieve Email Filtering: Reject and
           Extended Reject Extensions", RFC 5429,
           DOI 10.17487/RFC5429, March 2009,
           <https://www.rfc-editor.org/info/rfc5429>.

[RFC5435]  Melnikov, A., Ed., Leiba, B., Ed., Segmuller, W., and T.
           Martin, "Sieve Email Filtering: Extension for
           Notifications", RFC 5435, DOI 10.17487/RFC5435, January
           2009, <https://www.rfc-editor.org/info/rfc5435>.

[RFC5490]  Melnikov, A., "The Sieve Mail-Filtering Language --
           Extensions for Checking Mailbox Status and Accessing
           Mailbox Metadata", RFC 5490, DOI 10.17487/RFC5490, March
           2009, <https://www.rfc-editor.org/info/rfc5490>.

[RFC5703]  Hansen, T. and C. Daboo, "Sieve Email Filtering: MIME Part
           Tests, Iteration, Extraction, Replacement, and Enclosure",
           RFC 5703, DOI 10.17487/RFC5703, October 2009,
           <https://www.rfc-editor.org/info/rfc5703>.

[RFC6009]  Freed, N., "Sieve Email Filtering: Delivery Status
           Notifications and Deliver-By Extensions", RFC 6009,
           DOI 10.17487/RFC6009, October 2010,
           <https://www.rfc-editor.org/info/rfc6009>.

[RFC6131]  George, R. and B. Leiba, "Sieve Vacation Extension:
           "Seconds" Parameter", RFC 6131, DOI 10.17487/RFC6131, July
           2011, <https://www.rfc-editor.org/info/rfc6131>.

[RFC6134]  Melnikov, A. and B. Leiba, "Sieve Extension: Externally
           Stored Lists", RFC 6134, DOI 10.17487/RFC6134, July 2011,
           <https://www.rfc-editor.org/info/rfc6134>.

[RFC6558]  Melnikov, A., Leiba, B., and K. Li, "Sieve Extension for
           Converting Messages before Delivery", RFC 6558,
           DOI 10.17487/RFC6558, March 2012,
           <https://www.rfc-editor.org/info/rfc6558>.

[RFC8126]  Cotton, M., Leiba, B., and T. Narten, "Guidelines for
           Writing an IANA Considerations Section in RFCs", BCP 26,
           RFC 8126, DOI 10.17487/RFC8126, June 2017,
           <https://www.rfc-editor.org/info/rfc8126>.

[RFC8579]  Bosch, S., "Sieve Email Filtering: Delivering to Special-
           Use Mailboxes", RFC 8579, DOI 10.17487/RFC8579, May 2019,
           <https://www.rfc-editor.org/info/rfc8579>.

[RFC8580]  Murchison, K. and B. Gondwana, "Sieve Extension: File
           Carbon Copy (FCC)", RFC 8580, DOI 10.17487/RFC8580, May
           2019, <https://www.rfc-editor.org/info/rfc8580>.

[RFC9042]  Gondwana, B., Ed., "Sieve Email Filtering: Delivery by
           MAILBOXID", RFC 9042, DOI 10.17487/RFC9042, June 2021,
           <https://www.rfc-editor.org/info/rfc9042>.

Appendix A. Acknowledgements 🫢

big thank you to Barry Leiba, Donald Eastlake, Yoshiro Yoneya, and Murray Kucherawy for reviewing this doc and giving feedback. you guys are the real MVPs πŸ‘‘

Authors' Addresses πŸŽ€

Alexey Melnikov
Isode Ltd
14 Castle Mews
Hampton
TW12 2NP
United Kingdom
Email: Alexey.Melnikov@isode.com


Kenneth Murchison
Fastmail US LLC
Suite 1201
1429 Walnut Street
Philadelphia, PA 19102
United States of America
Email: murch@fastmailteam.com
πŸ“¦ where this page comes from