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