The Distribution List variables are Read Only variables that are set by
the GetDistributionList state table action.
Note: For a numeric list of System Variables, see
Table 1.
When GetDistributionList is used to retrieve Distribution List IDs, the
List ID (SV120), List Type (SV181), and Number of lists left (SV124) variables
are set.
When GetDistributionList is used to retrieve Message Recipients, the Number
of recipients left (SV125), Recipient list ID (SV121), Recipient mailbox ID
(SV123), and Recipient profile ID (SV122) variables are set.
- Distribution List : List ID (SV120)
- This variable identifies a distribution list that is accessible by the
caller. To set the variable, call GetDistributionList with the Distribution
List IDs and Get First options. GetDistributionList with the Get First option
for Distribution List IDs sets the variable to the ID of the first distribution
list in the specified mailbox. GetDistributionList with the Get Next option
sets the variable to the ID of the next distribution list in the mailbox.
- Distribution List : List Type (SV181)
- This variable identifies
the type of the current distribution list. Possible values are:
- 1
- Private
- 2
- Public
- Distribution List : Number of
lists left (SV124)
- This
variable contains the number of lists left for the current application profile.
To set the variable, call GetDistributionList with the Distribution List IDs
and Get First options. As subsequent calls to the GetDistributionList state
table action with the Get Next option are made, the value decreases as each
list ID is retrieved.
- Distribution List : Number of
recipients left (SV125)
- This
variable contains the number of message recipients left for the current application
profile. To set the variable, call GetDistributionList with the Message Recipient
and Get First options. As subsequent calls to the GetDistributionList state
table action with the Get Next option are made, the value decreases as each
of the message recipients is retrieved.
- Distribution List : Recipient
list ID (SV121)
- This variable identifies
the recipient distribution list. If the recipient is an individual mailbox
instead of a list, the variable is set to zero. To set this variable, call
GetDistributionList with the Get First for Message Recipients option. To set
the variable to the ID of the next recipient distribution list, call GetDistributionList
with the Get Next option.
- Distribution List : Recipient mailbox ID (SV123)
- This variable identifies
the recipient's mailbox. To set this variable, call GetDistributionList
with the Get First for Message Recipients option. To set the variable to the
ID of the next recipient's mailbox, call GetDistributionList with the
Get Next option.
- Distribution List : Recipient profile ID (SV122)
- This
variable identifies the recipient's application profile. If the recipient
is a distribution list, the value identifies the application profile that
defines the mailbox that contains the list. To set this variable, call GetDistributionList
with the Get First for Message Recipients option. To set the variable to the
ID of the next recipient's application profile, call GetDistributionList
with the Get Next option.