wvrmailbox command

Purpose

List mailboxes associated with an application profile, or change, or view details of mailboxes associated with an application profile. Note that the application profile must already exist (see wvrapplprof command).

Prerequisites

Before you can use the wvrmailbox command, you must import the admin custom server (see Importing application objects) and make sure that it is running (see Blueworx Voice Response for AIX: Managing and Monitoring the System).

Syntax

wvrmailbox
| -h
| -l -I profile_ID
| -m -I profile_ID -M mailbox_ID  [[-F field_name -V value] ...]
| -v -I profile_ID -M mailbox_ID  {-F all | -F field_name ] ...]
| -?
}

Action flags

All action flags are lowercase.

-h
Display help for the command
-l
List all the mailboxes associated with the application profile identified by profile_ID.
-m
Modify the mailbox identified by profile_ID and mailbox_ID, as specified by the other parameters.
-v
View the details of the mailbox identified by profile_ID and mailbox_ID.
-?
Display help for the command.

Attribute flags

All attribute flags are uppercase and followed by a value.

-I
The profile ID of the application profile.
-M
The number of the mailbox.
-F
The field name to be modified or viewed. To specify multiple fields, specify -F as many times as you need.
-V
The corresponding value for the field to be modified. You must specify a -V flag and value for each -F flag and field name.

Examples

List all mailboxes of application profile 123456:

wvrmailbox -l -I 123456

Activate mailbox 1 for application profile 123456:

wvrmailbox -m -I 123456 -M 1 -F mailbox_status -V 1

Modify some details of mailbox 2 for application profile 123456:

wvrmailbox -m -I 123456 -M 2 -F deputy_number -V 123333 -F email_address
-V fred@whizzsystems.com

View some details of mailbox 1 for application profile 123456:

wvrmailbox -v -I 123456 -M 1 -F mailbox_status -F clock_pref

View all the details of mailbox 1 for application profile 123456:

wvrmailbox -v -I 123456 -M 1 -F all

Field names

For an alphabetical list of field names that are valid with the -F attribute flag, see the table that follows. All of these fields are user-modifiable except those marked as display-only in the Field Data column. Corresponding fields names used in the GUI are shown in italics.
Table 1. Mailbox field names used with wvrmailbox command
Field Name Description Length Field Data
access_mode

Access Mode

This specifies how callers can use any mailboxes created for use by the application. Global access means that a caller can retrieve or leave messages in any mailbox. Read All access means that a caller can retrieve a message from any mailbox but only leave messages in the current mailbox. Read Write means that a caller can only access the current mailbox. 1

0 = Global (default)
1 = Read All
2 = Read/Write

announce_only

Announce and

Determines whether a caller who reaches the mailbox can leave a message. 1

0 = take messages (default)
1 = don't

autosave_new_msgs

Save messages automatically

Allows subscribers to elect to save new messages automically after listening. 1

0 = no (default)
1 = yes

bilingual_grt

Bilingual greeting user

Bilingual greeting user. 1

1 = play
0 = don't play

box_id

Mailbox

Indicates the mailbox number. 2

From 1 to 10
This is a mailbox property display-only
field

clock_pref

Clock preference

Clock preference used by notification schedules. 1

0 = 12-hour (default)
1 = 24-hour

delete_new_msgs

New message delete

Let subscribers delete new messages without listening to the whole message. 1

0 = no (default)
1 = yes

deputy_number

Assistant number

Assistant number 20 numeric string
email_address

Email address

Address for e-mail notification 255 text
fax_number

Default fax number

Fax number; a twenty-character numeric string 20 numeric string
first_time_user

First time user

First time user status 1

0 = New mailbox (default)
1 = Tutorial has been used

mailbox_active_grt

Active Greeting Number

Identifies which greeting an application should play to callers when the owner has recorded more than one greeting. 3

0 = Default
1 = Personal greeting 1
2 = Personal greeting 2
3 = Personal greeting 3
4 = Personal greeting 4
5 = Personal greeting 5
7 = Announcement-only greeting
9 = System default
10 = System default announcement-only
11 = Alternative system announcement-only
12 = Alternative announcement-only

mailbox_busy

Mailbox Busy

Is the mailbox currently busy on a call. 1

0 = no
1 = yes

mail_status

Active

Indicates whether mailbox is active or inactive 1

0 = inactive
1 = active

new_messages

New

Displays how many new messages are in the mailbox   This is a mailbox property display-only field
notif_sched_status

Notification schedule status

This specifies whether all notification schedules are turned On or Off. 1

0 = All off
1 = Active on

number_of_mailboxes

Total Active Mailboxes

The number of mailboxes which are active.   This is a mailbox property display-only field
operator_number

Operator number

The number of the switchboard operator at your location. This is the default number to which a call is transferred if a caller chooses that option when leaving a message. Subscribers can set their own operator number to override the system default. 20 numeric string
outgoing_messages

Outgoing

Displays how many outgoing messages are in the mailbox.   This is a mailbox property display-only field
pager_number

Pager number

Phone number of your pager 20 numeric string
pager_ref

Pager reference

Some pagers are identified by a unique reference number. If your pager uses a reference number, you can set this by entering it in this field. 20 numeric string
password

Password

This identifies a password that “opens” the mailbox for the caller to retrieve messages. Password use is optional. You can create a mailbox without a password. It is up to the application to check such things as the length against the Password Minimum Length parameter in the Application Server Interface parameter group. The default value for this is four digits. The maximum length of a password is always eight digits. Again, it is up to the application to check this. 8 max numeric string
password_change_date

Password change date

Date after which password must be changed 8 YYYYMMDD
play_headers

Play headers

Play header before message. 1

0 = no (default) - never play header
1 = yes

profile_active_grt

Profile Active Greeting

Specifies the identifier of the active greeting that will be played when a caller reaches this mailbox.   Reserved for use by Unified Messaging
prompt_level

Prompt Level

Verbosity level for prompts the subscriber hears. 1

0 = Normal prompts (default)
1 = Novice prompts
2 = Expert prompts

reachme_number

Reach-Me number

A number where the subscriber can be reached. Calls can be forwarded to this number 20 numeric string
referral_number

Referral Number

This specifies a number at which the mailbox owner can be reached. 20 numeric string
referral_type

Referral Type

This specifies whether the referral number is a telephone number or a beeper number. 1

0 = Telephone
1 = Beeper

retrieval_order

Retrieval Order

Indicates the order in which to retrieve messages from the mailbox. An application can retrieve messages in the order that they arrived, or it can retrieve the most recent messages first. The possible values are: First in first out (the order in which the messages arrived), Last in first out (the most recently received message first). 1

0 = FIFO (default)
1 = LIFO

saved_messages

Saved

Displays how many saved messages are in the mailbox   This is a mailbox property display-only field
send_msg_address

Send message

Indicates that you will specify the message address before or after recording the message. 1

0 = Message first, address after (default)
1 = Address first, message after

temp_deputy_number

Temporary assistant number

Temporary assistant number 20 numeric string
temp_fax_number

Temporary fax number

Temporary fax number 20 numeric string
temp_pager_number

Temporary pager number

Temporary paging bureau number 20 numeric string
temp_pager_ref

Temporary pager reference

Temporary pager reference number 20 numeric string
temp_reachme_number

Temporary Reach-Me
number

The PIN to be used when receiving calls transferred via the reach-me facility. 20 numeric string
temp_referral_number

Temporary referral number

Temporary call-forwarding number 20 numeric string
user_status

Application Status

Indicates whether the subscriber is in, out, sick, traveling or busy 1

0 = in (default)
1 = out
2 = sick
3 = busy
4 = traveling

vpim_address

VPIM address

Address for SMTP/MIME delivery 255 text
vpim_msg_del_pref

VPIM MDP

Message delivery preference for VPIM 1

0 = Local
1 = Remote
2 = Local and remote

vpim_voice_type

VPIM voice format

VPIM voice format 1

0 = wav
1 = au
2 = 32KADPCM
3 = DT6 elements
4 = DT6 GSM