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