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