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