Group 3 - Distribution List and Directory Related Items [ HP DeskManager Intrinsics ] MPE/iX 5.0 Documentation
HP DeskManager Intrinsics
Group 3 - Distribution List and Directory Related Items
The transaction records in this group range in value from 20000 to 29999
and must appear after group 2 transaction records in the file. Not all
the transaction records need to be represented, though if they are, they
may appear several times in the file. None of these transaction records
are required in transaction files supplied to HPDUserSend that describe
replies to previously read messages.
20050 - List Country Selector (tt_list_countries)
If you want to list the countries configured in the HP Desk database
using HPDNameProbe, this record is required as the first record in an
otherwise empty Transaction File. The record is overwritten with the
results.
Bytes Data Type Contents
17 on Reserved for future use
20100 - Country Identifier (tt_country)
This describes a country item in the directories returned by the "list
country" function of HPDNameProbe. Several of these transaction records
may be returned in the Transaction File. This record, as the first in an
otherwise empty file, may be submitted to HPDNameProbe as a selector in
order to list the configured locations that are associated with the
specified country.
Bytes Data Type Contents
17 - Byte Country code
24 Array
25 - Byte Country Name/Description (first 36
on Array bytes are significant)
For example, a tt_country Transaction File record could look like this:
Click here to view figure.
20200 - Location Identifier (tt_location)
This describes a location item in the directories returned by the "list
locations" function of the HPDNameProbe Intrinsic. Several of these
transaction records may be returned in the transaction file. This
record, following tt_body_type in an otherwise empty file, may itself by
submitted to HPDNameProbe as a selector in order to list the configured
sublocations that are associated with the specified location.
Bytes Data Type Contents
17 - Byte Location code (first 6 bytes
24 Array significant)
25 - Byte Location name/description (first 28
on Array bytes are significant)
For example, a tt_location Transaction File record could look like this:
Click here to view figure.
20300 - Mailnode (Location/Sublocation) Identifier (tt_mailnode)
This describes a mailnode item (location/sublocation) in the directories
returned by the "list sublocations" function of HPDNameProbe. Several of
these records may be returned in the Transaction File. This record, as
the first in an otherwise empty file, may itself be submitted to
HPDNameProbe as a selector in order to list the configured users that are
associated with the specified mailnode.
Bytes Data Type Contents
17 - Byte Mailnode code
24 Array
25 - Byte Mailnode name/description (first 28
on Array bytes are significant) - HPDNameProbe
only
For example, a tt_mailnode Transaction File record could look like this:
Click here to view figure.
20400 - User Identifier (tt_user)
Describes a user item in the directories returned by the "list users"
function of HPDNameProbe. Several of these transaction records may be
returned in the Transaction File.
This record, following tt_body_type in an otherwise empty file, may
itself be submitted to HPDNameProbe as a selector in order to list the
closest match names for a specified name, where that exact name does not
appear to exist, or where there appear to be duplicates. The results of
this list are returned with the same transaction record type.
Bytes Data Type Contents
17 - Integer Name/address format - only one type
20 will be supported with the HP Desk
Intrinsics (value 0), that is one
which conforms to standard HP Desk
conventions for names, mailnodes,
explicit foreign addresses and foreign
address aliases. Other projects may
define additional address formats.
21 - Not used.
36
37 Byte User name, mandatory in selector
-144 Array record, always returned in list.
145- Byte User mailnode, optional in selector
152 Array record, always returned in list.
153- Byte Additional user information, returned
etc Array on output if relevant Session Profile
options are selected. The format of
this field is defined in the 100100
Session Profile option or 2000 extra
user information transaction. These
define if explicit foreign address
information or foreign address
information are to be used and, if so,
where it should appear in this field
and how long it will be (subject to a
maximum of 512 bytes).
For example, a tt_user Transaction File record could look like this:
Click here to view figure.
21000 - FROM name and address (tt_from)
21100 - TO name and address (tt_to)
21200 - CC name and address (tt_cc)
21300 - BCC name and address (tt_bcc)
These transaction records describe the recipients of a message, using the
standard HP Desk conventions for recipient categories. At least one of
these records must appear in any Transaction File submitted to
HPDUserSend or HPDGateSend, and at least one will always be returned by
HPDUserReceive and HPDGateReceive. An exception is in submitting replies
to HPDUserSend. Another exception is if a 21400, tt_use_distlist
transaction is supplied.
Any of these records included in a Transaction File containing other
transaction records (for example, describing a message) can be submitted
to HPDNameProbe for verification against the HP Desk directories.
The transaction records numbered 21000 - 21300 are used to describe the
complete Distribution List for a message. However, it may be that for
messages output by HP Desk, not all the names on the list are to receive
a copy of the message, it may be that delivery of another copy of the
message is done by another route. A marker in each Distribution List
transaction record indicates whether delivery to any particular user is
required.
On input to HP Desk deliveries will not be made to any recipients with
the "do not deliver" marker set. However, their names do appear in the
resulting Distribution List. Regardless of the setting of this marker,
no more than 200 names can appear in a Transaction File that describes a
message, any over 200 will be ignored. However, there is no limit on the
number of names that can be handled by HPDNameProbe.
Any of these records can also occur in a Transaction File describing a
Distribution List as a basic item. Such files are supplied or generated
to describe any Distribution List within the message, other than the main
one. They are referenced in the main Transaction File in the same way as
any other content part of the message.
To be consistent, the format of this record is the same as for the
"sender" name and address transaction record.
Bytes Data Type Contents
17 - Integer Name/address format, only one type
20 will be supported with the HP Desk
Intrinsics (value 0), that is one
which conforms to standard HP Desk
conventions for names, mailnodes,
explicit foreign addresses and foreign
address aliases. Other products may
define additional address formats.
21 - Integer "Already delivered" indicator, only
24 used by HPDGateSend and
HPDGateReceive. It shows whether the
message is to be sent to this user or
whether the user will receive the
message by some other means or by an
alternative route. Its values can be:
0 deliver to this user
1 do not deliver to this user
This field will be noted on input to
HPDGateSend and HPDNameProbe and the
name will be ignored.
25 - Integer Reserved for future use.
28
29 - Integer Reserved for future use.
32
33 - Integer Acknowledgment level received from
36 this user. Only returned by
HPDUserReceive reading a Pending Tray
message. Its values can be:
0 No acknowledgment received
1 Transmitted acknowledgment
received
2 Receipt acknowledgment
received
3 Delivered acknowledgment
received
4 Read acknowledgment received
5 Reply acknowledgment received
6 Forms Reply acknowledgment
received
The rest of the record is dependent on the name/address format selected
above, although only one format will apply for the HP Desk Intrinsics.
37 Byte Recipient name, mandatory on input,
-144 Array except if Session Profile record
100100 (use foreign address aliases)
is selected. It is always returned on
output.
145- Byte Recipient mailnode, optional on input,
152 Array always returned on output.
153- Byte Additional user information, optional
on Array on input, returned on output if
relevant Session Profile options are
selected. The format of this field is
defined in the 100100 Session Profile
record or 2000 extra user information
format transaction. These define if
explicit foreign address information
or foreign address information are to
be used, and if so, where they should
appear in this field and how long they
are to be (subject to a maximum of 512
bytes each).
For example, a tt_to transaction record could look like this:
Click here to view figure.
21400 - Include Distribution List (tt_use_distlist)
This is provided for two reasons. To allow HPDUserSend to send to
Distribution Lists in the signed on user's Public Distribution Lists
folder or List Area (the List Area is searched first). It also allows
HPDGateSend to send to Distribution Lists in the Public Distribution
Lists folder or List Area for the Default User (the List Area is searched
first).
Bytes Data Type Contents
17 - Integer Category indicator.
20
0 Keep name categories in
included Distribution List.
1 Change all name categories in
included Distribution List to
FROM.
2 Change all name categories in
included Distribution List to
TO.
3 Change all name categories in
included Distribution List to
CC.
4 Change all name categories in
included Distribution List to
BCC.
21 - Byte Distribution List title (first 60
on Array bytes significant with HPDesk).
For example, a tt_use_distlist transaction record could look like this:
Click here to view figure.
MPE/iX 5.0 Documentation
HP 3000 Manuals