# -----------------------------------------------------------------------
#
# ---------------------------------------------------
# copyright 2000 by voxeo corporation. (see LGPL.txt)
#
# v1.0 Coded in PERL
# v1.0 Coded by Stephen J. Lewis
# ---------------------------------------------------
#
# Voicemail is a fully functional voicemail application scripted in PERL.
# It utilizes VoiceXML and CallXML for its telephony functions.  
# The following files are required for this application:
#
#       voicemail.pl	<--- PERL script
#       * user.ini      <--- The user file (there will be one user.ini file per user)
#
# This file also requires the following audio files to play prompts correctly.
# Their names are indicative of their purpose inside the script:
#
#	VoicemailUnavailable.wav
#	DefaultGreeting.wav
#	MainMessage.wav
#	YourMessageHasBeenSaved.wav
#	GetPIN.wav
#	YouHaveTakenTooMuchTime.wav
#	AdminMenu.wav
#	HangingUp.wav
#	InvalidPIN.wav
#	MessageMenu.wav
#	NoNewMessages.wav
#	NoSavedMessages.wav
#	MessagesUndeleted.wav
#	MessageSaved.wav
#	MessageDeleted.wav
#	ChangePIN.wav
#       YouHaveEnteredPIN.wav
#	KeepThisPIN.wav
#       PINHasBeenChanged.wav
#	ChangeGreeting.wav
# 	YouHaveEnteredGreeting.wav
#	KeepThisGreeting.wav
#	GreetingFileHasBeenChanged.wav
#       MaxSilenceHangup.wav
#       PlaySavedMessages.wav
#       YouHaveEnteredInvalidPIN.wav
# 
# Our default format is PCM, 8khz, 8-bit mono unsigned (.wav)
#
# By default, the path for these files are in a folder called "audio"
# beneath the main path of the voicemail script; however, both the
# main path and the audio path are easily altered by changing variables
# inside the PERL script itself.
#			-----------
# By default, each user has a folder under "/users" that is the
# called id (i.e., the voicemail box number).  Inside that folder
# will be file called "user.ini", which holds the information 
# discussed below.  Note that this application does not CREATE the 
# user.ini file -- rather, it assumes there is an administrative
# process that ensures the creation of both a new mailbox number (called id)
# as well as a folder and user.ini file for that user.  A script can be
# written to do this, or for testing you can set them up manually.
#
# That user.ini will have between 2 and x number of lines.  It might 
# look something like this:
#
# 	Greeting file:Greeting5551234.wav
# 	PIN code:1111
# 	Voicemail message:1:Read
# 	Voicemail message:2:Saved
# 	Voicemail message:3:Read
#
# Note that currently spaces should not be included.
# The greeting file defaults to Greetingxxxxxxx.wav
# where the called id replaces the "x" values.  Thus, called id
# 5551234's greeting file would be "Greeting5551234.wav".  As 
# documented inside the PERL code itself, this is easily changed
# if an administrator wanted the possibility of a user having 
# multiple greeting files.
#
# -----------------------------------------------------------------
