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