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