Merged revisions 56740 via svnmerge from
[asterisk/asterisk.git] / configs / voicemail.conf.sample
index 3c74e70..b292713 100644 (file)
@@ -4,8 +4,9 @@
 
 ;
 ; NOTE: Asterisk has to edit this file to change a user's password.  This does
-; note currently work with the "#include <file>" directive for Asterisk
-; configuration files.  Do not use it with this configuration file.
+; not currently work with the "#include <file>" directive for Asterisk
+; configuration files, nor when using realtime static configuration.
+; Do not use them with this configuration file.
 ;
 
 [general]
@@ -35,33 +36,44 @@ attach=yes
 ; (100) is used.  Maximum value for this option is 9999.
 ;maxmsg=100
 ; Maximum length of a voicemail message in seconds
-;maxmessage=180
+;maxsecs=180
 ; Minimum length of a voicemail message in seconds for the message to be kept
 ; The default is no minimum.
-;minmessage=3
+;minsecs=3
 ; Maximum length of greetings in seconds
 ;maxgreet=60
-; How many miliseconds to skip forward/back when rew/ff in message playback
+; How many milliseconds to skip forward/back when rew/ff in message playback
 skipms=3000
 ; How many seconds of silence before we end the recording
 maxsilence=10
-; Silence threshold (what we consider silence, the lower, the more sensitive)
+; Silence threshold (what we consider silence: the lower, the more sensitive)
 silencethreshold=128
 ; Max number of failed login attempts
 maxlogins=3
-
+;
+; User context is where entries from users.conf are registered.  The
+; default value is 'default'
+;
+;userscontext=default
+;
 ; If you need to have an external program, i.e. /usr/bin/myapp
 ; called when a voicemail is left, delivered, or your voicemailbox 
-; is checked, uncomment this.  It can also be set to 'smdi' to use
-; smdi for external notification.  If it is 'smdi', smdiport should
-; be set to a valid port as specfied in smdi.conf.
-
+; is checked, uncomment this.
 ;externnotify=/usr/bin/myapp
+
+; If you would also like to enable SMDI notification then set smdienable to yes.
+; You will also need to make sure smdiport is set to a valid port as specified in
+; smdi.conf.
+;smdienable=yes
 ;smdiport=/dev/ttyS0
 
 ; If you need to have an external program, i.e. /usr/bin/myapp
 ; called when a voicemail password is changed, uncomment this:
+; Note: If this is set, the password will NOT be changed in voicemail.conf
+; If you would like to also change the password in voicemail.conf, use
+; the externpassnotify option below instead.
 ;externpass=/usr/bin/myapp
+;externpassnotify=/usr/bin/myapp
 ; For the directory, you can override the intro file if you want
 ;directoryintro=dir-intro
 ; The character set for voicemail messages can be specified here
@@ -78,6 +90,12 @@ maxlogins=3
 ;fromstring=The Asterisk PBX
 ; Permit finding entries for forward/compose from the directory
 ;usedirectory=yes
+; Voicemail can be stored in a database using the ODBC driver.
+; The value of odbcstorage is the database connection configured
+; in res_odbc.conf.
+;odbcstorage=asterisk
+; The default table for ODBC voicemail storage is voicemessages.
+;odbctable=voicemessages
 ;
 ; Change the from, body and/or subject, variables:
 ;     VM_NAME, VM_DUR, VM_MSGNUM, VM_MAILBOX, VM_CALLERID, VM_CIDNUM,
@@ -87,7 +105,7 @@ maxlogins=3
 ;       limitation in the Asterisk configuration subsystem.
 ;emailsubject=[PBX]: New message ${VM_MSGNUM} in mailbox ${VM_MAILBOX}
 ; The following definition is very close to the default, but the default shows
-; just the CIDNAME, if it is not null, otherise just the CIDNUM, or "an unknown
+; just the CIDNAME, if it is not null, otherwise just the CIDNUM, or "an unknown
 ; caller", if they are both null.
 ;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
 ;
@@ -142,25 +160,18 @@ emaildateformat=%A, %B %d, %Y at %r
 ; R             24 hour time, including minute 
 ; 
 ; 
-[zonemessages]
-eastern=America/New_York|'vm-received' Q 'digits/at' IMp
-central=America/Chicago|'vm-received' Q 'digits/at' IMp
-central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
-military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
-european=Europe/Copenhagen|'vm-received' a d b 'digits/at' HM
-
 ;
 ; Each mailbox is listed in the form <mailbox>=<password>,<name>,<email>,<pager_email>,<options>
 ; if the e-mail is specified, a message will be sent when a message is
 ; received, to the given mailbox. If pager is specified, a message will be
 ; sent there as well. If the password is prefixed by '-', then it is
-; considered to be unchangable.
+; considered to be unchangeable.
 ;
 ; Advanced options example is extension 4069
 ; NOTE: All options can be expressed globally in the general section, and
-; overriden in the per-mailbox settings, unless listed otherwise.
+; overridden in the per-mailbox settings, unless listed otherwise.
 ; 
-; tz=central           ; Timezone from zonemessages above.  Irrelevant if envelope=no.
+; tz=central           ; Timezone from zonemessages below. Irrelevant if envelope=no.
 ; attach=yes           ; Attach the voicemail to the notification email *NOT* the pager email
 ; attachfmt=wav49      ; Which format to attach to the email.  Normally this is the
                        ; first format specified in the format parameter above, but this
@@ -192,6 +203,10 @@ sendvoicemail=yes  ; Context to Send voicemail from [option 5 from the advanced m
                        ;     This is intended for use with users who wish to receive their 
                        ;     voicemail ONLY by email. Note:  "deletevoicemail" is provided as an
                        ;     equivalent option for Realtime configuration.
+; volgain=0.0          ; Emails bearing the voicemail may arrive in a volume too
+                       ;     quiet to be heard.  This parameter allows you to specify how
+                       ;     much gain to add to the message when sending a voicemail.
+                       ;     NOTE: sox must be installed for this option to work.
 ; nextaftercmd=yes     ; Skips to the next message after hitting 7 or 9 to delete/save current message.
                        ;     [global option only at this time] 
 ; forcename=yes                ; Forces a new user to record their name.  A new user is
@@ -201,10 +216,37 @@ sendvoicemail=yes ; Context to Send voicemail from [option 5 from the advanced m
                        ;     greetings.  The default is "no".
 ; hidefromdir=yes      ; Hide this mailbox from the directory produced by app_directory
                        ;     The default is "no".
+; tempgreetwarn=yes    ; Remind the user that their temporary greeting is set
+; vm-password=custom_sound
+                       ;     Customize which sound file is used instead of the default
+                       ;     prompt that says: "password"
+; vm-newpassword=custom_sound
+                       ;     Customize which sound file is used instead of the default
+                       ;     prompt that says: "Please enter your new password followed by
+                       ;     the pound key."
+; vm-passchanged=custom_sound
+                       ;     Customize which sound file is used instead of the default
+                       ;     prompt that says: "Your password has been changed."
+; vm-reenterpassword=custom_sound
+                       ;     Customize which sound file is used instead of the default
+                       ;     prompt that says: "Please re-enter your password followed by
+                       ;     the pound key"
+; vm-mismatch=custom_sound
+                       ;     Customize which sound file is used instead of the default
+                       ;     prompt that says: "The passwords you entered and re-entered
+                       ;     did not match.  Please try again."
+
+[zonemessages]
+eastern=America/New_York|'vm-received' Q 'digits/at' IMp
+central=America/Chicago|'vm-received' Q 'digits/at' IMp
+central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
+military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
+european=Europe/Copenhagen|'vm-received' a d b 'digits/at' HM
+
 
 
 [default]
-; Define maximum number of messages per folder for partcular context.
+; Define maximum number of messages per folder for a particular context.
 ;maxmsg=50
 
 1234 => 4242,Example Mailbox,root@localhost