Update imapstorage.txt documentation.

Updated the imapstorage.txt documentation to reflect that issues with
c-client versions older than 2007 seem to cause crashing issues that
are not seen with more recent versions. Documentation has been updated
to reflect this.

(closes issue #14496)
Reported by: vbcrlfuser
Patches:
      __20090727-imap-documentation-patch.txt uploaded by lmadsen (license 10)
Tested by: lmadsen, mmichelson, dbrooks

git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.4@210563 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/doc/imapstorage.txt b/doc/imapstorage.txt
index 0dd66337186185e2c70b748d3923a740cfbcd283..f9b3ce39d201dfc7159859313524574c1b56edf4 100644 (file)
--- a/doc/imapstorage.txt
+++ b/doc/imapstorage.txt
@@ -38,10 +38,14 @@ Installation Notes
 --------------------------------------
 University of Washington IMAP C-Client
 --------------------------------------
-You will need a source distribution of University of Washington's IMAP
-c-client (http://www.washington.edu/imap/).  Asterisk supports both the
-2004 and 2006 versions of c-client, however mail_expunge_full is enabled
-in the 2006 version.
+If you do not have the University of Washington's IMAP c-client
+installed on your system, you will need to download the c-client
+source distribution from http://www.washington.edu/imap/ and compile it.
+Asterisk supports the 2007 version of c-client as there appears to be issues
+with older versions which cause Asterisk to crash in certain scenarios. It
+is highly recommended that you utilize a current version of the c-client
+libraries. Additionally, mail\_expunge\_full is enabled in the 2006 and later
+versions.
 
 Note that Asterisk only uses the 'client' portion of the UW IMAP toolkit,
 but building it also builds an IMAP server and various other utilities.
@@ -70,14 +74,14 @@ Compiling Asterisk
 ------------------
 
 Configure with ./configure --with-imap=/usr/src/imap
-or where ever you built thfe UWashington IMAP Toolkit. This directory
+or wherever you built thfe UWashington IMAP Toolkit. This directory
 will be searched for a source installation. If no source installation is
 found there, then a package installation of the IMAP c-client will be 
 searched for in this directory. If one is not found, then configure will fail
 
 A second configure option is to not specify a directory (i.e.
 ./configure --with-imap). This will assume that you have the
-imap-2004g source installed in the .. directory relative to the
+imap-2007e source installed in the ../imap directory relative to the
 Asterisk source. If you do not have this source, then configure will
 default to the "system" option defined in the next paragraph
 
@@ -160,9 +164,11 @@ UIDPLUS is currently NOT supported on these versions of UW-IMAP.  Please note
 that without UID_EXPUNGE, Asterisk voicemail will expunge ALL messages marked
 for deletion when a user exits the voicemail system (hangs up the phone).
 
--------------------------------
-UW IMAP-2006 Development Branch
--------------------------------
+This version is *not* recommended for Asterisk.
+
+------------
+UW IMAP-2006
+------------
 This version supports UIDPLUS, which allows UID_EXPUNGE capabilities.  This
 feature allow the system to expunge ONLY pertinent messages, instead of the
 default behavior, which is to expunge ALL messages marked for deletion when
@@ -170,6 +176,14 @@ EXPUNGE is called.  The IMAP storage mechanism is this version of Asterisk
 will check if the UID_EXPUNGE feature is supported by the server, and use it
 if possible. 
 
+This version is *not* recommended for Asterisk.
+
+------------
+UW IMAP-2007
+------------
+
+This is the currently recommended version for use with Asterisk.
+
 ----------
 Cyrus IMAP
 ----------