Out Mail : Mailbox variables

Note: For a numeric list of System Variables, see Table 1.

The Out Mail : Mailbox variables are used for information about the destination mailbox when the mailbox is accessed. The values are retrieved by updating the Out Mail : Mailbox - ID variable.

Out Mail : Mailbox - ID (RW) (SV33)
This variable identifies the destination mailbox. To access a mailbox ID, use one of the following state table actions:
  • GetData
  • ReceiveData
  • AssignData

If the Mailbox ID is invalid, the state table action returns an error, and the Mailbox ID is reset to -1. The Mailbox ID is invalid if it is out of range or refers to an inactive Mailbox.

You must set Out Mail - Profile ID before setting the Mailbox ID. When you successfully set the Mailbox ID, all of the Out Mail : Mailbox variables are set.

Out Mail : Mailbox : Access mode (SV555)
This variable identifies the type of mailbox access. The possible values are:
0
Global Read Write access to all mailboxes in the application profile
1
Read access to all mailboxes in the application profile and Write access to the current mailbox only
2
Read Write access to the current mailbox only
Out Mail : Mailbox : Announce only (SV114)
This variable indicates whether or not the destination mailbox takes messages. The possible values are:
0
Announce and take messages
1
Announce and do not take messages
Out Mail : Mailbox : Greeting ID (SV117)
This variable identifies the greeting played when the destination mailbox is accessed. Valid values are 1 through 255; a value of 0 implies there is no greeting defined.
Out Mail : Mailbox : Mailbox status (SV112)
This variable contains the status of a mailbox, the status is either 1 (active) or 0 (inactive).
Out Mail : Mailbox : Message retrieval order (SV553)
This variable indicates the order in which the CheckVoiceMessages state table action is 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:
0
First in first out (the order in which the messages arrived)
1
Last in first out (the most recently received message first)
Out Mail : Mailbox : Messages, number of incoming (SV154)
This variable contains the number of all incoming messages in the destination mailbox (New, Checked, Listened, Saved, and Undeliverable messages).

The variable value can be played in prompts, evaluated in prompt tests, and used as an operand in EvaluateData or AssignData state table actions.

Out Mail : Mailbox : Messages, number of new (SV152)
This variable contains the number of messages in the destination mailbox that have not been listened to.

The variable value can be played in prompts, evaluated in prompt tests, and used as an operand in EvaluateData or AssignData state table actions. The value is valid only after the Profile ID and Mailbox ID variables have been set.

Out Mail : Mailbox : Messages, number of outgoing (SV155)
This variable contains the number of messages that have been sent from the destination mailbox but have not been retrieved from the subsequent destination mailbox.

The variable value can be played in prompts, evaluated in prompt tests, and used as an operand in EvaluateData or AssignData state table actions.

Out Mail : Mailbox : Messages, number of saved (SV153)
This variable contains the number of incoming messages in the destination mailbox that have been saved.

The variable value can be played in prompts, evaluated in prompt tests, and used as an operand in EvaluateData or AssignData state table actions. The value is valid only after the Profile ID and Mailbox ID variables have been set.

Out Mail : Mailbox : Number of distribution lists (SV560)
This variable contains the number of distribution lists in the mailbox.
Out Mail : Mailbox : Owner status (SV113)
This variable contains the status value for the owner of the destination mailbox. Possible values are:
0
In
1
Out
2
Sick
3
Busy
4
Travel
Out Mail : Mailbox : Prompt level (SV554)
This variable determines the level of instruction the caller receives when accessing the mailbox. The possible values are:
0
Normal
1
Novice
2
Expert
Out Mail : Mailbox : Referral extension (SV118)
This variable contains a telephone number that an application can use to page the owner of the destination mailbox. For example, if an emergency message is left in a mailbox, the application uses the extension number to page the owner.
Out Mail : Mailbox : Referral extension type (SV119)
This variable contains the extension type that determines whether to send a number to a beeper or to send a message to a telephone number. Possible values are:
0
Telephone
1
Beeper