MAIL$_MESSAGE_BACK
When you specify the Boolean item code MAIL$_MESSAGE_BACK,
MAIL$MESSAGE_COPY copies the message preceding the current
message.
Specify the value 0 in the buffer length and buffer address
fields of the item descriptor.
Do not specify MAIL$_MESSAGE_BACK, MAIL$_MESSAGE_ID, and MAIL$_
MESSAGE_NEXT in the same call to MAIL$MESSAGE_COPY.
MAIL$_MESSAGE_DEFAULT_NAME
MAIL$_MESSAGE_DEFAULT_NAME specifies the default file
specification of a mail file to open in order to copy a message.
The buffer address field of the item descriptor points to a
buffer that contains a character string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_MESSAGE_DELETE
When you specify the Boolean item code MAIL$_MESSAGE_DELETE,
MAIL$MESSAGE_COPY deletes the message in the current folder after
the message has been copied to a destination folder.
Specify the value 0 in the buffer length and buffer address
fields of the item descriptor.
Specify MAIL$_MESSAGE_DELETE to emulate the operation of MAIL
MOVE or FILE command.
MAIL$_MESSAGE_FILE_ACTION
MAIL$_MESSAGE_FILE_ACTION specifies the address of the mail
file action routine called if a mail file is to be created. Two
parameters are passed as follows:
o User data longword
o Address of the descriptor of the file name to be created
The buffer address field of the item descriptor points to a
longword that denotes a procedure value.
MAIL$_MESSAGE_FILENAME
MAIL$_MESSAGE_FILENAME specifies the name of the mail file to
which the current message will be moved. The buffer address
field of the item descriptor points to a buffer that contains
a character string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_MESSAGE_FOLDER
MAIL$_MESSAGE_FOLDER specifies the name of the target folder
for moving mail messages. The buffer address field of the item
descriptor points to a buffer that contains a character string 0
to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
The item code MAIL$_MESSAGE_FOLDER is required.
MAIL$_MESSAGE_FOLDER_ACTION
MAIL$_MESSAGE_FOLDER_ACTION specifies the entry point address of
the folder action routine called if a folder is to be created.
Two parameters are passed as follows:
o User data longword
o Address of a descriptor of the folder name to be created.
The buffer address field of the item descriptor points to a
longword that specifies a procedure value.
MAIL$_MESSAGE_ID
MAIL$_MESSAGE_ID specifies the message identification number of
the message on which the operation is to be performed. The buffer
address field of the item descriptor points to a longword that
contains the message identification number.
Do not specify MAIL$_MESSAGE_BACK, MAIL$_MESSAGE_ID, and MAIL$_
MESSAGE_NEXT in the same call to MAIL$MESSAGE_COPY.
MAIL$_MESSAGE_NEXT
When you specify the Boolean item code MAIL$_MESSAGE_NEXT, the
Mail utility copies the message following the current message.
Specify the value 0 in the buffer length and buffer address
fields of the item descriptor.
Do not specify MAIL$_MESSAGE_BACK, MAIL$_MESSAGE_ID, and MAIL$_
MESSAGE_NEXT in the same call to MAIL$MESSAGE_COPY.
MAIL$_MESSAGE_USER_DATA
MAIL$_MESSAGE_USER_DATA specifies data passed to the folder
action and mail file action routines. The buffer address field
of the item descriptor points to a user data longword.
Specify MAIL$_MESSAGE_USER_DATA with the item codes MAIL$_
MESSAGE_FILE_ACTION and MAIL$_MESSAGE_FOLDER_ACTION only.
out_item_list
OpenVMS usage:itmlst_3
type: longword
access: write only
mechanism: by reference
Item list specifying the information you want the routine to
return. The out_item_list argument is the address of a list of
item descriptors, each of which describes an item of information.
The list of item descriptors is terminated by longword value of
0.