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