show command: show a stored message
The show 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.
This command must be presented to the user information CGI which uses the URL
http://host:7633/popstore_user/The parameter names and associated values accepted by the command are listed in Table 5-2 .
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. A user can only display a message file referenced in his or her profile's list of stored messages. As such, user's cannot try displaying random file names in the hopes of seeing another user's mail. |
trim=bvalue
|
Optional | Boolean value,
0 or
1. Only honored when
part is also specified. When
bvalue is
1 header trimming will be applied. When
bvalue is
0, no header trimming is applied. The default is
bvalue=1.
|
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. |
part=bvalue
|
Optional | Non-negative integer value indicating which message part to display. To display the entire message, specify
part=0. The first message part is
part=1, the second
part=2, and so on.
|
A0123450 is
shown below:
command=show&filename=A0123450&mformat=msg.txt& on_success=msg_success.txt&on_error=msg_error.txtA sample formatting file is shown in Example 5-1 .
Example 5-1 show_messageformattingfile
%none{Message could not be accessed or no longer exists}
<PRE>
%msg_content
</PRE>
When the part parameter is specified, the message will be
interpreted as a MIME formatted message and displayed all at once, but
divided into parts. Binary parts will be represented by hypertext links
which can be clicked on to download the associated data. Header
trimming will be applied to the message's outer header as well as any
internal headers. To suppress this trimming, specify
trim=0 in the command. Header trimming uses a default
header trimming option file. Site's may supply their own header
trimming option file if they wish. See Section 5.2.2 for further
details.