xmailbox(1) UNIX System V xmailbox(1)
NAME
xmailbox - mailbox list and browser
SYNOPSIS
xmailbox [-toolkitoption ...] [-option ...]
DESCRIPTION
Xmailbox is a read-only mailbox interface. It can provide much more
information than xbiff(1) without bringing up an entire mail interface.
The program is organized into 3 windows: a list window, a biff window,
and a message window.
The list window (name: xmlist; class: XMlist) contains a scrolling list
of the first 5000 mail messages in the mailbox file. Each entry contains
up to 30 characters of the sender's address and up to 80 characters of
the Subject: line or, if there is no Subject data, the first line of the
message. Selecting a list entry will bring up a message window
displaying the selected message.
The biff window (name: xmbiff; class: XMbiff) works just like xbiff(1),
and is supplied for people who prefer a smaller indicator at times.
The message window (name: xmmessage; class: XMmessage) displays the first
32,767 characters of the message in a scrolling text window (headers can
be stripped for better use of screen space -- see the LeaveHeaders and
StripHeaders resources). Also in this window are buttons to dismiss the
window, show the next message, and show the previous message.
By using the hide() and show() actions described later, it is possible to
to switch between various combinations of windows shown. By default,
mouse button 3 will switch between showing the list window and the biff
window. By setting the geometry of these two windows to be the same, you
can use the biff window normally, and "expand" it to a list when there
are new messages.
Up to 3 shell commands may be defined and called by keyboard translations
or, in the message window, attached to buttons. The resources
UserCommand, UserCommand2, and UserCommand3 may be defined as shell
command strings (they are executed by system(3) which uses /bin/sh).
These are executed from the all windows by using the userCommand,
userCommand2, and userCommand3 actions. In the message window, buttons
(named userButton, userButton2, and userButton3) are created which will
execute the commands.
OPTIONS
Xmp accepts all of the standard X Toolkit command line options along with
the additional options listed below:
-help This option indicates that a brief summary of the allowed options
should be printed on the standard error.
10/89 Page 1
xmailbox(1) UNIX System V xmailbox(1)
-update seconds
This option specifies the frequency in seconds at which xbiff
should update its display. If the mailbox is obscured and then
exposed, it will be updated immediately. The default is 30
seconds.
-mailbox filename
This option specifies the name of the mailbox file. The default
is system-dependent.
-highlight
With this option on, a bell will sound and the list window will
reverse the foreground and background when new mail comes in.
The foreground and background are restored when the mailbox is
accessed (such as when mail is read). This is the default.
-nohighlight
Turn off highlighting for new messages.
-list Display the list window. By default, if no windows are
specified, the list window is displayed.
-biff Display the biff window.
-message
Display the message window.
RESOURCES
Xmailbox (name: xmailbox; class: XMailbox) has a number of global
resources (classes shown in parentheses):
mailbox (Mailbox)
Sets the name of the mailbox file. The default is system-
defined.
update (Update)
Sets the number of seconds to wait between checks of the mailbox.
The default is 30.
highlight (Highlight)
Turns on list highlighting. The default is True.
listShow (ListShow)
Causes the list window to be displayed. The default is False,
but if no windows are to be displayed, it is changed to true.
biffShow (BiffShow)
Causes the biff window to be displayed. The default is False.
messageShow (MessageShow)
Causes the message window to be displayed. The default is False.
Page 2 10/89
xmailbox(1) UNIX System V xmailbox(1)
userCommand (UserCommand)
Sets the shell command to be executed by the userCommand action.
userCommand2 (UserCommand2)
Sets the shell command to be executed by the userCommand2 action.
userCommand3 (UserCommand3)
Sets the shell command to be executed by the userCommand3 action.
Resources for the list window are:
highlight (Highlight)
Turns on list highlighting. This resource is overridden by the
xmailbox*highlight resource. The default is True.
highlightForeground (HighlightForeground)
Set the foreground color to be used when highlighting. The
default is to use the normal background.
highlightBackground (HighlightBackground)
Set the background color to be used when highlighting. The
default is to use the normal foreground.
errorListString (ErrorString)
This is the message displayed in the list when the list space
can't be allocated. The default is "Error generating list".
tooManyString (ErrorString)
This is the message displayed in the list when there are more
than 5000 messages. The default is "TOO MANY MESSAGES - see
manual".
emptyListString (ErrorString)
This is the message displayed in the list when there are no
messages. The default is "<No messages>".
The biff window resources are the same as those for xbiff(1).
The message window resources are
leaveHeaders (LeaveHeaders)
This resource is a comma-separated list of words that specify
which headers should be displayed (such as "from" and "subject").
All others are not displayed. Case is ignored.
stripHeaders (StripHeaders)
This resource is a comma-separated list of words that specify
which headers should not be displayed (such as "message-id" and
"date"). All others are displayed. Case is ignored. If both
leaveHeaders and stripHeaders are given, stripHeaders is used.
10/89 Page 3
xmailbox(1) UNIX System V xmailbox(1)
See the app-defaults file (/usr/local/lib/app-defaults/XMailbox) for
information on the widgets used in the windows.
ACTIONS
The list and biff windows have the following actions:
rescan Rescan the mailbox.
userCommand
Execute the command associated with the userCommand resource.
userCommand2
Execute the command associated with the userCommand2 resource.
userCommand3
Execute the command associated with the userCommand3 resource.
quit Terminate the program.
show(list)
Display the named windows (list, biff, message).
hide(list)
Hide the named windows (list, biff, message). Note that it is
possible to hide all the windows, in which case the program will
not exit, but will not be useful.
The message window has the userCommand actions, as well as the following:
dismiss Hide the message window.
next Show the next message, if any.
prev Show the previous message, if any.
EXAMPLES
The following set of resources are useful for an MH user, in that they
define a user-command for incorporating the available mail, thus clearing
the mailbox (without losing any mail). The command is executed by typing
'c' in the list or biff windows, or by clicking the red "Clear" button in
the message window, which will also dismiss the message window.
xmailbox*userCommand: inc > /dev/null 2>&1
xmlist*translations: #override \
<Key>c: userCommand()
xmbiff*translations: #override \
<Key>c: userCommand()
xmmessage*userButton*label: Clear
xmmessage*userButton*background: red
Page 4 10/89
xmailbox(1) UNIX System V xmailbox(1)
xmmessage*userButton*translations: #override \
<Btn1Down>: userCommand() dismiss()
The following resource cause only the From:, Subject:, and Date: headers
to be displayed on any message.
xmmessage*leaveHeaders: from,subject,date
SEE ALSO
xbiff(1), xmh(1)
AUTHOR
David Elliott, Sony Microsystems Corp.
The idea was taken from the Interviews mailbox program.
10/89 Page 5