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