Trunk version of 1.4's imap documentation updates
[asterisk/asterisk.git] / doc / tex / imapstorage.tex
1 By enabling IMAP Storage,  Asterisk will use native IMAP as the storage
2 mechanism for voicemail messages instead of using the standard file structure.
3
4 Tighter integration of Asterisk voicemail and IMAP email services allows
5 additional voicemail functionality, including:
6
7 \begin{itemize}
8  \item Listening to a voicemail on the phone will set its state to "read" in
9    a user's mailbox automatically.
10  \item Deleting a voicemail on the phone will delete it from the user's
11    mailbox automatically.
12  \item Accessing a voicemail recording email message will turn off the message
13    waiting indicator (MWI) on the user's phone.
14  \item Deleting a voicemail recording email will also turn off the message
15    waiting indicator, and delete the message from the voicemail system.
16 \end{itemize}
17
18 \subsection{Installation Notes}
19
20 \subsubsection{University of Washington IMAP C-Client}
21
22 If you do not have the University of Washington's IMAP c-client
23 installed on your system, you will need to download the c-client
24 source distribution (\url{http://www.washington.edu/imap/}) and compile it.
25 Asterisk supports both the 2004 and 2006 versions of c-client, however
26 mail\_expunge\_full is enabled in the 2006 version.
27
28 Note that Asterisk only uses the 'c-client' portion of the UW IMAP toolkit,
29 but building it also builds an IMAP server and various other utilities.
30 Because of this, the build instructions for the IMAP toolkit are somewhat
31 complicated and can lead to confusion about what is needed.
32
33 If you are going to be connecting Asterisk to an existing IMAP server,
34 then you don't need to care about the server or utilities in the IMAP
35 toolkit at all. If you want to also install the UW IMAPD server, that
36 is outside the scope of this document.
37
38 Building the c-client library is fairly straightforward; for example, on a
39 Debian system there are two possibilities:
40
41 \begin{enumerate}
42     \item If you will not be using SSL to connect to the IMAP server:
43    \begin{verbatim}
44         $ make slx SSLTYPE=none!
45    \end{verbatim}
46     \item If you will be using SSL to connect to the IMAP server:
47    \begin{verbatim}
48    $ make slx EXTRACFLAGS="-I/usr/include/openssl"
49    \end{verbatim}
50 \end{enumerate}
51
52 Once this completes you can proceed with the Asterisk build; there is no
53 need to run 'make install'.
54
55 \subsubsection{Compiling Asterisk}
56
57 Configure with ./configure --with-imap=/usr/src/imap
58 or where ever you built thfe UWashington IMAP Toolkit. 
59
60 A second configure option is to not specify a directory (i.e.
61 ./configure --with-imap). This will assume that you have the
62 imap-2004g source installed in the .. directory relative to the
63 Asterisk source.
64
65 A third option is ./configure --with-imap=system. This will assume
66 that you have installed a dynamically linked version of the c-client
67 library (most likely via a package provided by your distro). This will
68 attempt to link agains -lc-client and will search for c-client headers
69 in your include path starting with the imap directory, and upon failure,
70 in the c-client directory.
71
72 Note that if you attempt one of the first two configuration options for
73 IMAP and it fails, the "system" option will be automatically attempted.
74
75 When you run 'make menuselect', choose 'Voicemail Build Options' and the
76 IMAP\_STORAGE option should be available for selection.
77
78 After selecting the IMAP\_STORAGE option, use the 'x' key to exit
79 menuselect and save your changes, and the build/install Asterisk
80 normally.
81
82 \subsection{Modify voicemail.conf}
83
84 The following directives have been added to voicemail.conf:
85 \begin{astlisting}
86 \begin{verbatim}
87 imapserver=<name or IP address of IMAP mail server>
88 imapport=<IMAP port, defaults to 143>
89 imapflags=<IMAP flags, "novalidate-cert" for example>
90 imapfolder=<IMAP folder to store messages to>
91 imapgreetings=<yes or no>
92 greetingsfolder=<IMAP folder to store greetings in if imapgreetings is enabled>
93 expungeonhangup=<yes or no>
94 authuser=<username>
95 authpassword=<password>
96 opentimeout=<TCP open timeout in seconds>
97 closetimeout=<TCP close timeout in seconds>
98 readtimeout=<TCP read timeout in seconds>
99 writetimeout=<TCP write timeout in seconds>
100 \end{verbatim}
101 \end{astlisting}
102
103 The "imapfolder" can be used to specify an alternative folder on your IMAP server
104 to store voicemails in. If not specified, the default folder 'INBOX' will be used.
105
106 The "imapgreetings" parameter can be enabled in order to store voicemail greetings
107 on the IMAP server. If disabled, then they will be stored on the local file system
108 as normal.
109
110 The "greetingsfolder" can be set to store greetings on the IMAP server when
111 "imapgreetings" is enabled in an alternative folder than that set by "imapfolder"
112 or the default folder for voicemails.
113
114 The "expungeonhangup" flag is used to determine if the voicemail system should
115 expunge all messages marked for deletion when the user hangs up the phone.
116
117 Each mailbox definition should also have imapuser=$<$imap username$>$.
118 For example:
119 \begin{astlisting}
120 \begin{verbatim}
121 4123=>4123,James Rothenberger,jar@onebiztone.com,,attach=yes|imapuser=jar
122 \end{verbatim}
123 \end{astlisting}
124
125 The directives "authuser" and "authpassword" are not needed when using
126 Kerberos. They are defined to allow Asterisk to authenticate as a single
127 user that has access to all mailboxes as an alternative to Kerberos.
128
129
130 \subsection{IMAP Folders}
131
132 Besides INBOX, users should create "Old", "Work", "Family" and "Friends"
133 IMAP folders at the same level of hierarchy as the INBOX.  These will be
134 used as alternate folders for storing voicemail messages to mimic the
135 behavior of the current (file-based) voicemail system.
136
137
138 \subsection{Separate vs. Shared Email Accounts}
139
140 As administrator you will have to decide if you want to send the voicemail
141 messages to a separate IMAP account or use each user's existing IMAP mailbox
142 for voicemail storage.  The IMAP storage mechanism will work either way.
143
144 By implementing a single IMAP mailbox, the user will see voicemail messages
145 appear in the same INBOX as other messages.  The disadvantage of this method
146 is that if the IMAP server does NOT support UIDPLUS, Asterisk voicemail will
147 expunge ALL messages marked for deletion when the user exits the voicemail
148 system, not just the VOICEMAIL messages marked for deletion.
149
150 By implementing separate IMAP mailboxes for voicemail and email, voicemail
151 expunges will not remove regular email flagged for deletion.
152
153
154 \subsection{IMAP Server Implementations}
155
156 There are various IMAP server implementations, each supports a potentially
157 different set of features.
158
159
160 \subsubsection{UW IMAP-2005 or earlier}
161
162 UIDPLUS is currently NOT supported on these versions of UW-IMAP.  Please note
163 that without UID\_EXPUNGE, Asterisk voicemail will expunge ALL messages marked
164 for deletion when a user exits the voicemail system (hangs up the phone).
165
166 \subsubsection{UW IMAP-2006 Development Branch}
167
168 This version supports UIDPLUS, which allows UID\_EXPUNGE capabilities.  This
169 feature allow the system to expunge ONLY pertinent messages, instead of the
170 default behavior, which is to expunge ALL messages marked for deletion when
171 EXPUNGE is called.  The IMAP storage mechanism is this version of Asterisk
172 will check if the UID\_EXPUNGE feature is supported by the server, and use it
173 if possible.
174
175 \subsubsection{Cyrus IMAP}
176
177 Cyrus IMAP server v2.3.3 has been tested using a hierarchy delimiter of '/'.
178
179
180 \subsection{Quota Support}
181
182 If the IMAP server supports quotas, Asterisk will check the quota when
183 accessing voicemail.  Currently only a warning is given to the user that
184 their quota is exceeded.
185
186
187 \subsection{Application Notes}
188
189 Since the primary storage mechanism is IMAP, all message information that
190 was previously stored in an associated text file, AND the recording itself,
191 is now stored in a single email message.  This means that the .gsm recording
192 will ALWAYS be attached to the message (along with the user's preference of
193 recording format if different - ie. .WAV).  The voicemail message information
194 is stored in the email message headers.  These headers include:
195
196 \begin{verbatim}
197 X-Asterisk-VM-Message-Num
198 X-Asterisk-VM-Server-Name
199 X-Asterisk-VM-Context
200 X-Asterisk-VM-Extension
201 X-Asterisk-VM-Priority
202 X-Asterisk-VM-Caller-channel
203 X-Asterisk-VM-Caller-ID-Num
204 X-Asterisk-VM-Caller-ID-Name
205 X-Asterisk-VM-Duration
206 X-Asterisk-VM-Category
207 X-Asterisk-VM-Orig-date
208 X-Asterisk-VM-Orig-time
209 \end{verbatim}