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