Send call release with unallocated cause instead of normal call clearing, when
[asterisk/asterisk.git] / configs / voicemail.conf.sample
1 ;
2 ; Voicemail Configuration
3 ;
4
5 ;
6 ; NOTE: Asterisk has to edit this file to change a user's password.  This does
7 ; not currently work with the "#include <file>" directive for Asterisk
8 ; configuration files, nor when using realtime static configuration.
9 ; Do not use them with this configuration file.
10 ;
11
12 [general]
13 ; Formats for writing Voicemail.  Note that when using IMAP storage for
14 ; voicemail, only the first format specified will be used.
15 ;format=g723sf|wav49|wav
16 format=wav49|gsm|wav
17 ;
18 ; WARNING:
19 ; If you change the list of formats that you record voicemail in
20 ; when you have mailboxes that contain messages, you _MUST_ absolutely
21 ; manually go through those mailboxes and convert/delete/add the
22 ; the message files so that they appear to have been stored using
23 ; your new format list. If you don't do this, very unpleasant
24 ; things may happen to your users while they are retrieving and
25 ; manipulating their voicemail.
26 ;
27 ; In other words: don't change the format list on a production system
28 ; unless you are _VERY_  sure that you know what you are doing and are
29 ; prepared for the consequences.
30 ;
31 ; Who the e-mail notification should appear to come from
32 serveremail=asterisk
33 ;serveremail=asterisk@linux-support.net
34 ; Should the email contain the voicemail as an attachment
35 attach=yes
36 ; Maximum number of messages per folder.  If not specified, a default value
37 ; (100) is used.  Maximum value for this option is 9999.
38 ;maxmsg=100
39 ; Maximum length of a voicemail message in seconds
40 ;maxsecs=180
41 ; Minimum length of a voicemail message in seconds for the message to be kept
42 ; The default is no minimum.
43 ;minsecs=3
44 ; Maximum length of greetings in seconds
45 ;maxgreet=60
46 ; How many milliseconds to skip forward/back when rew/ff in message playback
47 skipms=3000
48 ; How many seconds of silence before we end the recording
49 maxsilence=10
50 ; Silence threshold (what we consider silence: the lower, the more sensitive)
51 silencethreshold=128
52 ; Max number of failed login attempts
53 maxlogins=3
54 ;
55 ; Move heard messages to the 'Old' folder automagically.  Defaults to on.
56 ;moveheard=yes
57 ;
58 ; User context is where entries from users.conf are registered.  The
59 ; default value is 'default'
60 ;
61 ;userscontext=default
62 ;
63 ; If you need to have an external program, i.e. /usr/bin/myapp
64 ; called when a voicemail is left, delivered, or your voicemailbox 
65 ; is checked, uncomment this.
66 ;externnotify=/usr/bin/myapp
67
68 ; If you would also like to enable SMDI notification then set smdienable to yes.
69 ; You will also need to make sure smdiport is set to a valid port as specified in
70 ; smdi.conf.
71 ;smdienable=yes
72 ;smdiport=/dev/ttyS0
73
74 ; If you need to have an external program, i.e. /usr/bin/myapp
75 ; called when a voicemail password is changed, uncomment this:
76 ; Note: If this is set, the password will NOT be changed in voicemail.conf
77 ; If you would like to also change the password in voicemail.conf, use
78 ; the externpassnotify option below instead.
79 ;externpass=/usr/bin/myapp
80 ;externpassnotify=/usr/bin/myapp
81
82 ; If you need to have an external program, i.e. /usr/bin/myapp
83 ; called when a user changes her voicemail password, uncomment this:
84 ;externpasscheck=/usr/bin/myapp
85 ; Arguments for this script are:
86 ; mailbox context oldpass newpass
87
88 ; For the directory, you can override the intro file if you want
89 ;directoryintro=dir-intro
90 ; The character set for voicemail messages can be specified here
91 ;charset=ISO-8859-1
92 ; The ADSI feature descriptor number to download to 
93 ;adsifdn=0000000F
94 ; The ADSI security lock code
95 ;adsisec=9BDBF7AC
96 ; The ADSI voicemail application version number.
97 ;adsiver=1
98 ; Skip the "[PBX]:" string from the message title
99 ;pbxskip=yes
100 ; Change the From: string
101 ;fromstring=The Asterisk PBX
102 ; Permit finding entries for forward/compose from the directory
103 ;usedirectory=yes
104 ; Voicemail can be stored in a database using the ODBC driver.
105 ; The value of odbcstorage is the database connection configured
106 ; in res_odbc.conf.
107 ;odbcstorage=asterisk
108 ; The default table for ODBC voicemail storage is voicemessages.
109 ;odbctable=voicemessages
110 ;
111 ; Change the from, body and/or subject, variables:
112 ;     VM_NAME, VM_DUR, VM_MSGNUM, VM_MAILBOX, VM_CALLERID, VM_CIDNUM,
113 ;     VM_CIDNAME, VM_DATE
114 ;
115 ; Note: The emailbody config row can only be up to 512 characters due to a
116 ;       limitation in the Asterisk configuration subsystem.
117 ;emailsubject=[PBX]: New message ${VM_MSGNUM} in mailbox ${VM_MAILBOX}
118 ; The following definition is very close to the default, but the default shows
119 ; just the CIDNAME, if it is not null, otherwise just the CIDNUM, or "an unknown
120 ; caller", if they are both null.
121 ;emailbody=Dear ${VM_NAME}:\n\n\tjust wanted to let you know you were just left a ${VM_DUR} long message (number ${VM_MSGNUM})\nin mailbox ${VM_MAILBOX} from ${VM_CALLERID}, on ${VM_DATE}, so you might\nwant to check it when you get a chance.  Thanks!\n\n\t\t\t\t--Asterisk\n
122 ;
123 ; You can also change the Pager From: string, the pager body and/or subject.
124 ; The above defined variables also can be used here
125 ;pagerfromstring=The Asterisk PBX
126 ;pagersubject=New VM
127 ;pagerbody=New ${VM_DUR} long msg in box ${VM_MAILBOX}\nfrom ${VM_CALLERID}, on ${VM_DATE}
128 ;
129 ; Set the date format on outgoing mails. Valid arguments can be found on the
130 ; strftime(3) man page
131 ;
132 ; Default
133 emaildateformat=%A, %B %d, %Y at %r
134 ; 24h date format
135 ;emaildateformat=%A, %d %B %Y at %H:%M:%S
136 ;
137 ; You can override the default program to send e-mail if you wish, too
138 ;
139 ;mailcmd=/usr/sbin/sendmail -t
140 ;
141 ;pollmailboxes=no    ;   If mailboxes are changed anywhere outside of app_voicemail,
142 ;                    ; then this option must be enabled for MWI to work.  This
143 ;                    ; enables polling mailboxes for changes.  Normally, it will
144 ;                    ; expect that changes are only made when someone called in
145 ;                    ; to one of the voicemail applications.
146 ;                    ;   Examples of situations that would require this option are 
147 ;                    ; web interfaces to voicemail or an email client in the case 
148 ;                    ; of using IMAP storage.
149 ;
150 ;pollfreq=30         ;   If the "pollmailboxes" option is enabled, this option
151 ;                    ; sets the polling frequency.  The default is once every
152 ;                    ; 30 seconds.
153 ; If using IMAP storage, specify whether voicemail greetings should be stored 
154 ; via IMAP. If no, then greetings are stored as if IMAP storage were not enabled
155 ;imapgreetings=no
156 ; If imapgreetings=yes, then specify which folder to store your greetings in. If
157 ; you do not specify a folder, then INBOX will be used
158 ;greetingsfolder=INBOX
159 ; Some IMAP server implementations store folders under INBOX instead of 
160 ; using a top level folder (ex. INBOX/Friends).  In this case, user
161 ; imapparentfolder to set the parent folder. For example, Cyrus IMAP does
162 ; NOT use INBOX as the parent. Default is to have no parent folder set.
163 ;imapparentfolder=INBOX
164
165 ; Users may be located in different timezones, or may have different 
166 ; message announcements for their introductory message when they enter 
167 ; the voicemail system. Set the message and the timezone each user 
168 ; hears here. Set the user into one of these zones with the tz= attribute 
169 ; in the options field of the mailbox. Of course, language substitution 
170 ; still applies here so you may have several directory trees that have 
171 ; alternate language choices. 
172
173 ; Look in /usr/share/zoneinfo/ for names of timezones. 
174 ; Look at the manual page for strftime for a quick tutorial on how the 
175 ; variable substitution is done on the values below. 
176
177 ; Supported values: 
178 ; 'filename'    filename of a soundfile (single ticks around the filename
179 ;               required)
180 ; ${VAR}        variable substitution 
181 ; A or a        Day of week (Saturday, Sunday, ...) 
182 ; B or b or h   Month name (January, February, ...) 
183 ; d or e        numeric day of month (first, second, ..., thirty-first) 
184 ; Y             Year 
185 ; I or l        Hour, 12 hour clock 
186 ; H             Hour, 24 hour clock (single digit hours preceded by "oh") 
187 ; k             Hour, 24 hour clock (single digit hours NOT preceded by "oh") 
188 ; M             Minute, with 00 pronounced as "o'clock" 
189 ; N             Minute, with 00 pronounced as "hundred" (US military time)
190 ; P or p        AM or PM 
191 ; Q             "today", "yesterday" or ABdY
192 ;               (*note: not standard strftime value) 
193 ; q             "" (for today), "yesterday", weekday, or ABdY
194 ;               (*note: not standard strftime value) 
195 ; R             24 hour time, including minute 
196
197
198 ;
199 ; Each mailbox is listed in the form <mailbox>=<password>,<name>,<email>,<pager_email>,<options>
200 ; if the e-mail is specified, a message will be sent when a message is
201 ; received, to the given mailbox. If pager is specified, a message will be
202 ; sent there as well. If the password is prefixed by '-', then it is
203 ; considered to be unchangeable.
204 ;
205 ; Advanced options example is extension 4069
206 ; NOTE: All options can be expressed globally in the general section, and
207 ; overridden in the per-mailbox settings, unless listed otherwise.
208
209 ; tz=central            ; Timezone from zonemessages below. Irrelevant if envelope=no.
210 ; attach=yes            ; Attach the voicemail to the notification email *NOT* the pager email
211 ; attachfmt=wav49       ; Which format to attach to the email.  Normally this is the
212                         ; first format specified in the format parameter above, but this
213                         ; option lets you customize the format sent to particular mailboxes.
214                         ; Useful if Windows users want wav49, but Linux users want gsm.
215                         ; [per-mailbox only]
216 ; saycid=yes            ; Say the caller id information before the message. If not described, 
217                         ;     or set to no, it will be in the envelope
218 ; cidinternalcontexts=intern    ; Internal Context for Name Playback instead of 
219                         ; extension digits when saying caller id.
220 ; sayduration=no        ; Turn on/off the duration information before the message. [ON by default]
221 ; saydurationm=2        ; Specify the minimum duration to say. Default is 2 minutes
222 ; dialout=fromvm ; Context to dial out from [option 4 from mailbox's advanced menu]. 
223                  ; If not specified, option 4 will not be listed and dialing out 
224                  ; from within VoiceMailMain() will not be permitted.
225 sendvoicemail=yes ; Allow the user to compose and send a voicemail while inside 
226                   ; VoiceMailMain() [option 5 from mailbox's advanced menu].
227                   ; If set to 'no', option 5 will not be listed.
228 ; searchcontexts=yes    ; Current default behavior is to search only the default context
229                         ; if one is not specified.  The older behavior was to search all contexts.
230                         ; This option restores the old behavior [DEFAULT=no]
231 ; callback=fromvm       ; Context to call back from  
232                         ;     if not listed, calling the sender back will not be permitted
233 ; exitcontext=fromvm    ; Context to go to on user exit such as * or 0
234                         ;     The default is the current context.
235 ; review=yes            ; Allow sender to review/rerecord their message before saving it [OFF by default
236 ; operator=yes          ; Allow sender to hit 0 before/after/during  leaving a voicemail to 
237                         ;     reach an operator  [OFF by default]
238 ; envelope=no           ; Turn on/off envelope playback before message playback. [ON by default] 
239                         ;     This does NOT affect option 3,3 from the advanced options menu
240 ; delete=yes            ; After notification, the voicemail is deleted from the server. [per-mailbox only]
241                         ;     This is intended for use with users who wish to receive their 
242                         ;     voicemail ONLY by email. Note:  "deletevoicemail" is provided as an
243                         ;     equivalent option for Realtime configuration.
244 ; volgain=0.0           ; Emails bearing the voicemail may arrive in a volume too
245                         ;     quiet to be heard.  This parameter allows you to specify how
246                         ;     much gain to add to the message when sending a voicemail.
247                         ;     NOTE: sox must be installed for this option to work.
248 ; nextaftercmd=yes      ; Skips to the next message after hitting 7 or 9 to delete/save current message.
249                         ;     [global option only at this time] 
250 ; forcename=yes         ; Forces a new user to record their name.  A new user is
251                         ;     determined by the password being the same as
252                         ;     the mailbox number.  The default is "no".
253 ; forcegreetings=no     ; This is the same as forcename, except for recording
254                         ;     greetings.  The default is "no".
255 ; hidefromdir=yes       ; Hide this mailbox from the directory produced by app_directory
256                         ;     The default is "no".
257 ; tempgreetwarn=yes     ; Remind the user that their temporary greeting is set
258
259 ;messagewrap=no ; Enable next/last message to wrap around to
260                         ; first (from last) and last (from first) message
261                         ; The default is "no".
262 ; minpassword=0 ; Enforce minimum password length
263
264 ; vm-password=custom_sound
265                         ;     Customize which sound file is used instead of the default
266                         ;     prompt that says: "password"
267 ; vm-newpassword=custom_sound
268                         ;     Customize which sound file is used instead of the default
269                         ;     prompt that says: "Please enter your new password followed by
270                         ;     the pound key."
271 ; vm-passchanged=custom_sound
272                         ;     Customize which sound file is used instead of the default
273                         ;     prompt that says: "Your password has been changed."
274 ; vm-reenterpassword=custom_sound
275                         ;     Customize which sound file is used instead of the default
276                         ;     prompt that says: "Please re-enter your password followed by
277                         ;     the pound key"
278 ; vm-mismatch=custom_sound
279                         ;     Customize which sound file is used instead of the default
280                         ;     prompt that says: "The passwords you entered and re-entered
281                         ;     did not match.  Please try again."
282 ; vm-invalid-password=custom_sound
283                         ;     Customize which sound file is used instead of the default
284                         ;     prompt that says: ...
285 ; listen-control-forward-key=#  ; Customize the key that fast-forwards message playback
286 ; listen-control-reverse-key=*  ; Customize the key that rewinds message playback
287 ; listen-control-pause-key=0    ; Customize the key that pauses/unpauses message playback
288 ; listen-control-restart-key=2  ; Customize the key that restarts message playback
289 ; listen-control-stop-key=13456789      ; Customize the keys that interrupt message playback, probably all keys not set above
290
291 ; Maximum number of messages allowed in the 'Deleted' folder. If set to 0
292 ; or no then no deleted messages will be moved. If non-zero (max 9999) then up
293 ; to this number of messages will be automagically saved when they are
294 ; 'deleted' on a FIFO basis.
295 ; defaults to being off
296 ; backupdeleted=100
297
298
299 [zonemessages]
300 eastern=America/New_York|'vm-received' Q 'digits/at' IMp
301 central=America/Chicago|'vm-received' Q 'digits/at' IMp
302 central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
303 military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
304 european=Europe/Copenhagen|'vm-received' a d b 'digits/at' HM
305
306
307
308 [default]
309
310 1234 => 4242,Example Mailbox,root@localhost
311 ;4200 => 9855,Mark Spencer,markster@linux-support.net,mypager@digium.com,attach=no|serveremail=myaddy@digium.com|tz=central|maxmsg=10
312 ;4300 => 3456,Ben Rigas,ben@american-computer.net
313 ;4310 => -5432,Sales,sales@marko.net
314 ;4069 => 6522,Matt Brooks,matt@marko.net,,|tz=central|attach=yes|saycid=yes|dialout=fromvm|callback=fromvm|review=yes|operator=yes|envelope=yes|moveheard=yes|sayduration=yes|saydurationm=1
315 ;4073 => 1099,Bianca Paige,bianca@biancapaige.com,,delete=1
316 ;4110 => 3443,Rob Flynn,rflynn@blueridge.net
317 ;4235 => 1234,Jim Holmes,jim@astricon.ips,,Tz=european
318
319
320 ;
321 ; Mailboxes may be organized into multiple contexts for
322 ; voicemail virtualhosting
323 ;
324
325 [other]
326 ;The intro can be customized on a per-context basis
327 ;directoryintro=dir-company2
328 1234 => 5678,Company2 User,root@localhost
329
330 ; example for our acme compartmentalized company
331 ;
332 ; Pete telecommutes from Chicago, so we'll customize timestamps for him.
333 ;
334 ;[acme]
335 ;tz=eastern
336 ;111 => 7383,Pete,pete@acme-widgets.com,,tz=central
337 ;112 => 6262,Nancy,nancy@acme-widgets.com
338 ;
339
340 ;
341 ; When using IMAP storage, imapuser and imappassword can be used to specify the
342 ; user's credentials.
343 ;
344 ;[imapvm]
345 ;4324 => 7764,Ellis Redding,red@buxton.us,,imapuser=eredding|imappassword=g3tbusy
346 ;4325 => 2392,Andrew Dufresne,andy@dufresne.info,,imapuser=adufresne|imappassword=rockh@mmer