PMDF popstore & MessageStore Manager's Guide

The show_message command is used to display a message stored in the popstore. The message to display is identified by its file name as given by the %msg_filename substitution string of the show_user command. Note that the message to be displayed is first checked to ensure that at least on of its recipients are in the manager's management group.

The parameter names and associated values accepted by the command are listed in Table 4-21.

Table 4-21 show_message command parameters

parameter=value		Description
filename=file-spec	Required	File name for the message file to display. Note that this is not a full file path but rather a path relative to the popstore message file directory tree.
mformat=file-spec	Required	Name of the formatting file to use to format the message. The recognized substitution strings for this formatting file are listed in Table 4-10 and Table 4-22.
on_error=file-spec	Required	Name of the formatting file to use to format the results when the command fails.
on_success=file-spec	Required	Name of the formatting file to use to format the results when the command succeeds.

An example command to show the message file A0123450 is shown below:

command=show_message&filename=A0123450&mformat=msg.txt& on_success=msg_success.txt&on_error=msg_error.txt

A sample formatting file is shown in Example 4-4.

Example 4-4 show_message formatting file

Recipient count: %msg_rcpt_count Reference count: %msg_ref_count From: %msg_env_from To: %msg_env_to %msg_content

Table 4-22 show_message command substitution strings

Substitution string	Type	Format	Description
%msg_channel	string	%s	Name of the channel which delivered the message to the popstore.
%msg_content	string	%s	Content of the message (both RFC822 message header and body). Each line of the message content will be formatted using the formatting string and terminated with a CRLF pair.
%msg_created	string	%s	Date and time at which the message file was created.
%msg_env_from	string	%s	Message's envelope From: address.
%msg_env_id	string	%s	Message's envelope identifier.
%msg_env_to	string	%s	Message's envelope To: address. When there is more than one envelope To: address, each address will listed with comma separators.
%msg_filename	string	%-s	Name of the file containing this message.
%msg_header	string	%s	The message's RFC822 header. Each line of the message header will be formatted using the formatting string and terminated with a CRLF pair.
%msg_id	string	%s	Content of the message's RFC822 Message-id: header field.
%msg_rcpt_count	uint	%u	Number of popstore users which were recipients of this message.
%msg_ref_count	uint	%u	Number of popstore users which currently have references to this message. This is the number of popstore users who have not deleted their copy of this message.
%msg_size_b	uint	%u	Size of the message content as measured in bytes.
%msg_size_k %msg_size_m %msg_size_b	float	%.2f	Size of the message content as measured, respectively, in kbytes ( _k), mbytes ( _m), or gbytes ( _g).
%msg_version	uint	%u	Value of the message file's format version field.