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