Merged revisions 77424,77429 via svnmerge from
[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 '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{verbatim}
42 1) if you will not be using SSL to connect to the IMAP server:
43    $ make slx SSLTYPE=none
44
45 2) if you will be using SSL to connect to the IMAP server:
46    $ make slx EXTRACFLAGS="-I/usr/include/openssl"
47 \end{verbatim}
48
49 Once this completes you can proceed with the Asterisk build; there is no
50 need to run 'make install'.
51
52 \subsubsection{Compiling Asterisk}
53
54 To use the system c-client library, configure Asterisk with
55 ./configure --with-imap=system. If you downloaded the c-client source
56 and compiled it according to the above instructions, configure
57 Asterisk with with ./configure --with-imap=/usr/src/imap or where ever
58 you built the UWashington IMAP Toolkit. When you run 'make
59 menuselect', choose 'Voicemail Build Options' and the IMAP\_STORAGE
60 option should be available for selection.
61
62 After selecting the IMAP\_STORAGE option, use the 'x' key to exit
63 menuselect and save your changes, and the build/install Asterisk
64 normally.
65
66 \subsection{Modify voicemail.conf}
67
68 The following directives have been added to voicemail.conf:
69
70 \begin{verbatim}
71 imapserver=<name or IP address of IMAP mail server>
72 imapport=<IMAP port, defaults to 143>
73 imapflags=<IMAP flags, "novalidate-cert" for example>
74 expungeonhangup=<yes or no>
75 authuser=<username>
76 authpassword=<password>
77 \end{verbatim}
78
79 The "expungeonhangup" flag is used to determine if the voicemail system should
80 expunge all messages marked for deletion when the user hangs up the phone. 
81
82 Each mailbox definition should also have imapuser=$<$imap username$>$.
83 For example:
84
85 \begin{verbatim}
86 4123=>4123,James Rothenberger,jar@onebiztone.com,,attach=yes|imapuser=jar
87 \end{verbatim}
88
89 The directives "authuser" and "authpassword" are not needed when using
90 Kerberos. They are defined to allow Asterisk to authenticate as a single 
91 user that has access to all mailboxes as an alternative to Kerberos.
92
93
94 \subsection{IMAP Folders}
95
96 Besides INBOX, users should create "Old", "Work", "Family" and "Friends" 
97 IMAP folders at the same level of hierarchy as the INBOX.  These will be 
98 used as alternate folders for storing voicemail messages to mimic the 
99 behavior of the current (file-based) voicemail system.
100
101
102 \subsection{Separate vs. Shared Email Accounts}
103
104 As administrator you will have to decide if you want to send the voicemail
105 messages to a separate IMAP account or use each user's existing IMAP mailbox
106 for voicemail storage.  The IMAP storage mechanism will work either way. 
107
108 By implementing a single IMAP mailbox, the user will see voicemail messages
109 appear in the same INBOX as other messages.  The disadvantage of this method
110 is that if the IMAP server does NOT support UIDPLUS, Asterisk voicemail will
111 expunge ALL messages marked for deletion when the user exits the voicemail 
112 system, not just the VOICEMAIL messages marked for deletion.
113
114 By implementing separate IMAP mailboxes for voicemail and email, voicemail 
115 expunges will not remove regular email flagged for deletion.
116
117
118 \subsection{IMAP Server Implementations}
119
120 There are various IMAP server implementations, each supports a potentially
121 different set of features.  
122
123
124 \subsubsection{UW IMAP-2005 or earlier}
125
126 UIDPLUS is currently NOT supported on these versions of UW-IMAP.  Please note
127 that without UID\_EXPUNGE, Asterisk voicemail will expunge ALL messages marked
128 for deletion when a user exits the voicemail system (hangs up the phone).
129
130 \subsubsection{UW IMAP-2006 Development Branch}
131
132 This version supports UIDPLUS, which allows UID\_EXPUNGE capabilities.  This
133 feature allow the system to expunge ONLY pertinent messages, instead of the
134 default behavior, which is to expunge ALL messages marked for deletion when
135 EXPUNGE is called.  The IMAP storage mechanism is this version of Asterisk
136 will check if the UID\_EXPUNGE feature is supported by the server, and use it
137 if possible. 
138
139 \subsubsection{Cyrus IMAP}
140
141 Cyrus IMAP server v2.3.3 has been tested using a hierarchy delimiter of '/'.  
142
143
144 \subsection{Quota Support}
145
146 If the IMAP server supports quotas, Asterisk will check the quota when
147 accessing voicemail.  Currently only a warning is given to the user that 
148 their quota is exceeded. 
149
150
151 \subsection{Application Notes}
152
153 Since the primary storage mechanism is IMAP, all message information that 
154 was previously stored in an associated text file, AND the recording itself,
155 is now stored in a single email message.  This means that the .gsm recording
156 will ALWAYS be attached to the message (along with the user's preference of
157 recording format if different - ie. .WAV).  The voicemail message information
158 is stored in the email message headers.  These headers include:
159
160 \begin{verbatim}
161 X-Asterisk-VM-Message-Num
162 X-Asterisk-VM-Server-Name
163 X-Asterisk-VM-Context
164 X-Asterisk-VM-Extension
165 X-Asterisk-VM-Priority
166 X-Asterisk-VM-Caller-channel
167 X-Asterisk-VM-Caller-ID-Num
168 X-Asterisk-VM-Caller-ID-Name
169 X-Asterisk-VM-Duration
170 X-Asterisk-VM-Category
171 X-Asterisk-VM-Orig-date
172 X-Asterisk-VM-Orig-time
173 \end{verbatim}