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