gnus-compat.el: Require overlay for XEmacs
[gnus] / lisp / gnus-sieve.el
index ea0f360..cde9376 100644 (file)
@@ -1,6 +1,6 @@
 ;;; gnus-sieve.el --- Utilities to manage sieve scripts for Gnus
 
-;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2015 Free Software Foundation, Inc.
 
 ;; Author: NAGY Andras <nagya@inf.elte.hu>,
 ;;     Simon Josefsson <simon@josefsson.org>
   :group 'gnus-sieve)
 
 (defcustom gnus-sieve-region-start "\n## Begin Gnus Sieve Script\n"
-  "Line indicating the start of the autogenerated region in
-your Sieve script."
+  "Line indicating the start of the autogenerated region in your Sieve script."
   :type 'string
   :group 'gnus-sieve)
 
 (defcustom gnus-sieve-region-end "\n## End Gnus Sieve Script\n"
-  "Line indicating the end of the autogenerated region in
-your Sieve script."
+  "Line indicating the end of the autogenerated region in your Sieve script."
   :type 'string
   :group 'gnus-sieve)
 
 (defcustom gnus-sieve-select-method nil
   "Which select method we generate the Sieve script for.
-
 For example: \"nnimap:mailbox\""
+  ;; FIXME? gnus-select-method?
+  :type '(choice (const nil) string)
   :group 'gnus-sieve)
 
 (defcustom gnus-sieve-crosspost t
@@ -140,7 +139,7 @@ Return nil if no rule could be guessed."
   "Convert an elisp string list to a Sieve string list.
 
 For example:
-\(gnus-sieve-string-list '(\"to\" \"cc\"))
+\(gnus-sieve-string-list \\='(\"to\" \"cc\"))
   => \"[\\\"to\\\", \\\"cc\\\"]\"
 "
   (concat "[\"" (mapconcat 'identity list "\", \"") "\"]"))
@@ -149,7 +148,7 @@ For example:
   "Convert an elisp test list to a Sieve test list.
 
 For example:
-\(gnus-sieve-test-list '((address \"sender\" \"boss@company.com\") (size :over 4K)))
+\(gnus-sieve-test-list \\='((address \"sender\" \"boss@company.com\") (size :over 4K)))
   => \"(address \\\"sender\\\" \\\"boss@company.com\\\", size :over 4K)\""
   (concat "(" (mapconcat 'gnus-sieve-test list ", ") ")"))
 
@@ -158,13 +157,13 @@ For example:
   "Convert an elisp test token to a Sieve test token.
 
 For example:
-\(gnus-sieve-test-token 'address)
+\(gnus-sieve-test-token \\='address)
   => \"address\"
 
 \(gnus-sieve-test-token \"sender\")
   => \"\\\"sender\\\"\"
 
-\(gnus-sieve-test-token '(\"to\" \"cc\"))
+\(gnus-sieve-test-token \\='(\"to\" \"cc\"))
   => \"[\\\"to\\\", \\\"cc\\\"]\""
   (cond
    ((symbolp token)            ;; Keyword
@@ -185,10 +184,10 @@ For example:
   "Convert an elisp test to a Sieve test.
 
 For example:
-\(gnus-sieve-test '(address \"sender\" \"sieve-admin@extundo.com\"))
+\(gnus-sieve-test \\='(address \"sender\" \"sieve-admin@extundo.com\"))
   => \"address \\\"sender\\\" \\\"sieve-admin@extundo.com\\\"\"
 
-\(gnus-sieve-test '(anyof ((header :contains (\"to\" \"cc\") \"my@address.com\")
+\(gnus-sieve-test \\='(anyof ((header :contains (\"to\" \"cc\") \"my@address.com\")
                          (size :over 100K))))
   => \"anyof (header :contains [\\\"to\\\", \\\"cc\\\"] \\\"my@address.com\\\",
             size :over 100K)\""
@@ -235,5 +234,4 @@ This is returned as a string."
 
 (provide 'gnus-sieve)
 
-;; arch-tag: 3b906527-c7f3-4c86-9e82-62e2697998a3
 ;;; gnus-sieve.el ends here