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