[Spambayes-checkins] spambayes/spambayes ImapUI.py, 1.2, 1.3 Options.py, 1.29, 1.30

[Tony Meyer]

Update of /cvsroot/spambayes/spambayes/spambayes
In directory sc8-pr-cvs1:/tmp/cvs-serv32621/spambayes

Modified Files:
	ImapUI.py Options.py 
Log Message:
Improve documentation for imap options.

Index: ImapUI.py
===================================================================
RCS file: /cvsroot/spambayes/spambayes/spambayes/ImapUI.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** ImapUI.py	18 Apr 2003 22:48:57 -0000	1.2
--- ImapUI.py	19 Apr 2003 01:45:20 -0000	1.3
***************
*** 144,147 ****
--- 144,152 ----
              name_attributes = fol[:m.end()-1]
              folder_delimiter = fol[m.end()+1:m.end()+2]
+             # a bit of a hack, but we really need to know if this is
+             # the case
+             if folder_delimiter == ',':
+                 print """WARNING: Your imap server uses commas as the folder
+                 delimiter.  This may cause unpredictable errors."""
              folders.append(fol[m.end()+5:-1])
          folders.sort()

Index: Options.py
===================================================================
RCS file: /cvsroot/spambayes/spambayes/spambayes/Options.py,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** Options.py	19 Apr 2003 00:02:13 -0000	1.29
--- Options.py	19 Apr 2003 01:45:21 -0000	1.30
***************
*** 836,849 ****
  "imap" : (
  ("server", "Server", "",
! "", r"[\w\.\-]+(: [\d]+)?", False, False),
  ("port", "Port", 143,
! """The default IMAP port is 143, or 993 if using SSL""",
  r"[\d]+", False, False),
  ("username", "Username", "",
! "", r"[\w]+", False, False),
  ("password", "Password", "",
! "", r"[\w]+", False, False),
  ("expunge", "Purge//Expunge", False,
! """Permanently remove *all* messages flagged with //Deleted on logout""",
  (False, True), False, True),
  # IMAP seems to allow any character at all in a folder name,
--- 836,875 ----
  "imap" : (
  ("server", "Server", "",
! """This is the name of the imap server that stores your mail,
! and which the imap filter will connect to - for example: mail.example.com
! or imap.example.com.  If you use more than one server, then things are
! a bit more complicated for you at the moment, sorry.  You will need to have
! multiple instances of the imap filter running, each with a different
! server (and possibly username and password) value.  You can do this if you
! have a different configuration file for each instance, but you'll have to
! do it by hand for the moment.  Please let the mailing list know if you are
! in this situation so that we can consider coming up with a better solution.
! """,
! r"[\w\.\-]+(: [\d]+)?", False, False),
  ("port", "Port", 143,
! """This is the port of the imap server that stores your mail, and which the
! imap filter will connect to.  The default IMAP port is 143, or 993 if using
! SSL, you will probably have one of those values here.  If you are using
! multiple imap servers, please see the comments regarding the server value.
! """,
  r"[\d]+", False, False),
  ("username", "Username", "",
! """This is the id that you use to log into your imap server.  If your
! address is funkyguy at example.com, then your username is probably funkyguy.
! If you are using multiple imap servers, or multiple accounts on the same
! server, please see the comments regarding the server value.""",
! r"[\w]+", False, False),
  ("password", "Password", "",
! """That is that password that you use to log into your imap server. This
! will be stored in plain text in your configuration file, and if you have
! set the web user interface to allow remote connections, then it will be
! available for the whole world to see in plain text.  If I've just
! freaked you out, don't panic <wink>.  You can leave this blank and use
! the -p command line option to imapfilter.py and you will be prompted for
! your password.""",
! r"[\w]+", False, False),
  ("expunge", "Purge//Expunge", False,
! """Permanently remove *all* messages flagged with //Deleted on logout.
! If you do not know what this means, then please leave this as False.""",
  (False, True), False, True),
  # IMAP seems to allow any character at all in a folder name,
***************
*** 851,854 ****
--- 877,881 ----
  # we don't allow this.  If anyone has folders with commas in the
  # names, please let us know and we'll figure out something else.
+ # ImapUI.py prints out a warning if this is the case.
  ("filter_folders", "Folders to filter", "INBOX",
  """Comma delimited list of folders to be filtered""",