dovecot-2.0-pigeonhole: Updated INSTALL documentation for new co...
pigeonhole at rename-it.nl
pigeonhole at rename-it.nl
Sun Sep 11 12:56:12 EEST 2011
details: http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/6e46c17ab0b7
changeset: 1526:6e46c17ab0b7
user: Stephan Bosch <stephan at rename-it.nl>
date: Sun Sep 11 11:56:07 2011 +0200
description:
Updated INSTALL documentation for new configuration options of the include extension.
diffstat:
INSTALL | 9 +
doc/include.txt | 32 +
doc/rfc/draft-ietf-sieve-include-03.txt | 784 -------------------------------------
doc/rfc/draft-ietf-sieve-include-05.txt | 784 +++++++++++++++++++++++++++++++++++++
doc/vacation.txt | 2 +-
5 files changed, 826 insertions(+), 785 deletions(-)
diffs (truncated from 1643 to 300 lines):
diff -r f12899a3d02f -r 6e46c17ab0b7 INSTALL
--- a/INSTALL Sun Sep 11 11:39:07 2011 +0200
+++ b/INSTALL Sun Sep 11 11:56:07 2011 +0200
@@ -268,6 +268,15 @@
configuration options. Refer to doc/vacation.txt for settings specific to the
vacation extension.
+- Include extension:
+
+ The Sieve include extension (draft) permits users to include one Sieve script
+ into another.
+
+ The include extension is available by default, but it has its own specific
+ configuration options. Refer to doc/include.txt for settings specific to the
+ include extension.
+
- Spamtest and Virustest extensions:
Using the spamtest and virustest extensions (RFC 5235), the Sieve language
diff -r f12899a3d02f -r 6e46c17ab0b7 doc/include.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/include.txt Sun Sep 11 11:56:07 2011 +0200
@@ -0,0 +1,32 @@
+Include Extension
+
+Relevant Specifications
+=======================
+
+draft-ietf-sieve-include-05 - doc/rfc/draft-ietf-sieve-include-05.txt
+
+Description
+===========
+
+The Sieve include extension permits users to include one Sieve script into
+another. This can make managing large scripts or multiple sets of scripts much
+easier, and allows a site and its users to build up libraries of scripts. Users
+are able to include their own personal scripts or site-wide scripts.
+
+Included scripts can include more scripts of their own, yielding a tree of
+included scripts with the main script (typically the user's personal script) at
+its root.
+
+Configuration
+=============
+
+The include extension is available by default. The include extension has its own
+specific settings. The following settings can be configured for the include
+extension (default values are indicated):
+
+sieve_include_max_includes = 255
+ The maximum number of scripts that may be included. This is the total number
+ of scripts involved in the include tree.
+
+sieve_include_max_nesting_depth = 10
+ The maximum nesting depth for the include tree.
diff -r f12899a3d02f -r 6e46c17ab0b7 doc/rfc/draft-ietf-sieve-include-03.txt
--- a/doc/rfc/draft-ietf-sieve-include-03.txt Sun Sep 11 11:39:07 2011 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,784 +0,0 @@
-
-
-
-Network Working Group C. Daboo
-Internet-Draft A. Stone
-Expires: January 30, 2010 July 29, 2009
-
-
- Sieve Email Filtering: Include Extension
- draft-ietf-sieve-include-03
-
-Status of this Memo
-
- This Internet-Draft is submitted to IETF in full conformance with the
- provisions of BCP 78 and BCP 79. This document may contain material
- from IETF Documents or IETF Contributions published or made publicly
- available before November 10, 2008. The person(s) controlling the
- copyright in some of this material may not have granted the IETF
- Trust the right to allow modifications of such material outside the
- IETF Standards Process. Without obtaining an adequate license from
- the person(s) controlling the copyright in such materials, this
- document may not be modified outside the IETF Standards Process, and
- derivative works of it may not be created outside the IETF Standards
- Process, except to format it for publication as an RFC or to
- translate it into languages other than English.
-
- Internet-Drafts are working documents of the Internet Engineering
- Task Force (IETF), its areas, and its working groups. Note that
- other groups may also distribute working documents as Internet-
- Drafts.
-
- Internet-Drafts are draft documents valid for a maximum of six months
- and may be updated, replaced, or obsoleted by other documents at any
- time. It is inappropriate to use Internet-Drafts as reference
- material or to cite them other than as "work in progress."
-
- The list of current Internet-Drafts can be accessed at
- http://www.ietf.org/ietf/1id-abstracts.txt.
-
- The list of Internet-Draft Shadow Directories can be accessed at
- http://www.ietf.org/shadow.html.
-
- This Internet-Draft will expire on January 30, 2010.
-
-Copyright Notice
-
- Copyright (c) 2009 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 in effect on the date of
-
-
-
-Daboo & Stone Expires January 30, 2010 [Page 1]
-
-Internet-Draft Sieve Extension: Include July 2009
-
-
- publication of this document (http://trustee.ietf.org/license-info).
- Please review these documents carefully, as they describe your rights
- and restrictions with respect to this document.
-
-Abstract
-
- The Sieve Email Filtering "include" extension permits users to
- include one Sieve script inside another. This can make managing
- large scripts or multiple sets of scripts much easier, and allows a
- site and its users to build up libraries of scripts. Users are able
- to include their own personal scripts or site-wide scripts.
-
-Change History (to be removed prior to publication as an RFC)
-
- Changes from ietf-02 to ietf-03:
-
- a. Setting a variable then calling global on it is an error
- (something like 'use strict').
-
- b. Specify that the 'global' keyword is only available when
- 'variables' has also been required.
-
- c. Uploading a script that includes a nonexistent script is not an
- error at upload time.
-
- Changes from ietf-01 to ietf-02:
-
- a. Require that script names must be constant strings, not subject
- to variable expansion.
-
- b. Try the phrase immediate script instead of current script.
-
- c. Clarify that "global 'varname'" and "global.varname" refer to the
- same variable.
-
- d. Drop the requirement the global keywords come after require and
- before anything else.
-
- Changes from ietf-00 to ietf-01:
-
- a. Replaced import/export with global.
-
- b. Added :once modifier to include.
-
- c. Added global namespace to see if it holds water.
-
- Changes from daboo-06 to ietf-00:
-
-
-
-
-Daboo & Stone Expires January 30, 2010 [Page 2]
-
-Internet-Draft Sieve Extension: Include July 2009
-
-
- a. None
-
- Changes from -05 to -06:
-
- a. Aaron Stone joins as author.
-
- b. Removed | characters from the script examples.
-
- c. Updated draft references to published RFCs.
-
- Changes from -04 to -05:
-
- a. Fixed examples.
-
- b. Relaxed requirement that imported/exported variables be set
- before being used.
-
- Changes from -03 to -04:
-
- a. Fixed missing 2119 definitions.
-
- b. Defined interaction with variables through use of import and
- export commands.
-
- Changes from -02 to -03:
-
- a. Refreshing expired draft (updated for nits).
-
- b. Syntax -> Usage.
-
- c. Updated to 3028bis reference.
-
- Changes from -01 to -02:
-
- a. Minor formatting changes only - refreshing expired draft.
-
- Changes from -00 to -01:
-
- a. Added IPR boiler plate.
-
- b. Re-ordered sections at start to conform to RFC style.
-
- c. Moved recursion comment into General Considerations section.
-
- d. Switched to using optional parameter to indicate personal vs
- global.
-
-
-
-
-
-Daboo & Stone Expires January 30, 2010 [Page 3]
-
-Internet-Draft Sieve Extension: Include July 2009
-
-
- e. Explicitly state that an error occurs when a missing script is
- included.
-
-
-Table of Contents
-
- 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 5
- 2. Conventions Used in This Document . . . . . . . . . . . . . . 5
- 3. Include Extension . . . . . . . . . . . . . . . . . . . . . . 5
- 3.1. General Considerations . . . . . . . . . . . . . . . . . . 5
- 3.2. Control Structure include . . . . . . . . . . . . . . . . 6
- 3.3. Control Structure return . . . . . . . . . . . . . . . . . 10
- 3.4. Interaction with Variables . . . . . . . . . . . . . . . . 10
- 3.4.1. Control Structure global . . . . . . . . . . . . . . . 10
- 3.4.2. Variables Namespace global . . . . . . . . . . . . . . 12
- 4. Security Considerations . . . . . . . . . . . . . . . . . . . 12
- 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13
- 5.1. "include" Extension Registration . . . . . . . . . . . . . 13
- 6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 13
- 6.1. Normative References . . . . . . . . . . . . . . . . . . . 13
- 6.2. Informative References . . . . . . . . . . . . . . . . . . 13
- Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 13
- Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 13
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo & Stone Expires January 30, 2010 [Page 4]
-
-Internet-Draft Sieve Extension: Include July 2009
-
-
-1. Introduction and Overview
-
- It's convenient to be able to break SIEVE [RFC5228] scripts down into
- smaller components which can be reused in a variety of different
- circumstances. For example, users may want to have a default script
- and a special 'vacation' script, the latter being activated when the
- user goes on vacation. In that case the default actions should
- continue to be run, but a vacation command should be executed first.
- One option is to edit the default script to add or remove the
- vacation command as needed. Another is to have a vacation script
- that simply has a vacation command and then includes the default
- script.
-
-
More information about the dovecot-cvs
mailing list