Files
cdesktop/cde/doc/C/guides/man/man1_dt/mail.sgm

476 lines
20 KiB
Plaintext

<!-- $XConsortium: mail.sgm /main/12 1996/10/30 18:20:57 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<refentry id="CDEMX.MAN27.rsml.1">
<refmeta><refentrytitle>dtmail</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtmail</command></refname><refpurpose>the desktop
mailer</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtmail</command><arg choice="opt">&minus;h</arg><arg choice="opt">&minus;c</arg><arg choice="opt">&minus;f<replaceable>mailfile</replaceable></arg><group><arg>&minus;a <replaceable>file1</replaceable></arg><arg>...<replaceable>fileN</replaceable></arg></group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <emphasis>Dtmail</emphasis> program is a mailer for use on the desktop.
It provides an easy-to-use interface for viewing, filing, composing and
sending electronic mail containers and mail messages.</para>
<para>The Mailer provides a GUI-based interface for manipulating electronic
mail messages that can have attachments. Use the interface to compose a
message, view a message or a container holding messages, load new mail, copy
or move messages from one container to another, delete messages, reply to
messages, add and delete attachments to a message when composing, and view
contents of attachments in a message. The Mailer also provides a mail-pervasive
desktop environment by providing a public Tooltalk API. Other clients can
use the Tooltalk API to compose and send messages.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry><term>&minus;a file1 ... fileN</term>
<listitem>
<!-- ex-TP-->
<para>Bring up a Compose window with &thinsp;file1&thinsp; through &thinsp;fileN&thinsp;
as attachments.</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;c</term>
<listitem>
<!-- ex-TP-->
<para>Bring up an empty Compose window</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;f filename</term>
<listitem>
<!-- ex-TP-->
<para>This specifies the mail file to be loaded in at start up time. Ordinarily,
the mailfile pointed to by the environment variable MAIL is read in as the
user's inbox. Use of this option overrides the use of the MAIL variable.
</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;h</term>
<listitem>
<!-- ex-TP-->
<para>Display help for command line options</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>The Mailer provides the following resources:</para>
<variablelist>
<varlistentry><term>Dtmail*Message_List*doubleClickInterval</term>
<listitem>
<!-- ex-TP-->
<para>The double click time out (in milliseconds) for the scrolling message
header list. Default is 400 milliseconds.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*background</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the scrolling message header list background. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*foreground</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the scrolling message header list foreground. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*fontList</term>
<listitem>
<!-- ex-TP-->
<para>The list of fonts to use in the scrolling message header list. The
list must contain two fonts. The first must be tagged "plain" and is the
font used to render the header text. The second must be tagged "attach" and
is used to render the attachment indicator. Default is to use system dependent
fixed width fonts.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*background</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the View and Compose window text background. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*foreground</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the View and Compose window text foreground. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*fontList</term>
<listitem>
<!-- ex-TP-->
<para>The list of fonts to use in the View and Compose windows. Font tag
"plain". Default is to use a system dependent variable width font.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MAIL VARIABLES</title>
<para>In addition to the variables recognized by <Filename MoreInfo="RefEntry">mailx</Filename>(1), <command>dtmail</command> recognizes those listed below. They can be set by editing
your <Filename>.mailrc</Filename> file; however, since most of the variables
are accessible through the Mailer Options menu, we strongly recommend that
you modify them there to reduce the chance of error. Unless otherwise noted,
the default for the following variables is <emphasis>off.</emphasis></para>
<variablelist>
<varlistentry><term>additionalfields</term>
<listitem>
<!-- ex-TP-->
<para>A list of header fields to access via the <literal>Format</literal>
menu. This variable can be accessed through the <literal>Custom Fields:</literal>, <literal>Header Field:</literal>, and <literal>Default Value:</literal> portions of the Compose Window
category in the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>bell</term>
<listitem>
<!-- ex-TP-->
<para>The number of times to ring the bell when new mail arrives. This variable
can be accessed through the <symbol role="Message">Signal</symbol> <literal>New Mail</literal> portion in the Message
Header List category of the Mail Options dialog. The default is 0.</para>
</listitem>
</varlistentry>
<varlistentry><term>composeinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval in seconds for checkpointing to dead.letter. Default is
every 600 seconds (10 minutes).</para>
</listitem>
</varlistentry>
<varlistentry><term>dontlogmessages</term>
<listitem>
<!-- ex-TP-->
<para>This variable controls whether or not the <literal>Log Message</literal> item is selected in the File Menu in the Compose window.
The default is to log messages. This variable can be accessed through the <literal>Log all sent messages</literal> item in the Message Filing category of the Mail Options dialog.
</para>
</listitem>
</varlistentry>
<varlistentry><term>expert</term>
<listitem>
<!-- ex-TP-->
<para>Set expert mode in which minimal confirmations are requested. This variable
can be accessed through the <literal>Show confirmation notices</literal> check box in the Advanced category of
the Mail Options dialog. <!--filemenu2 supersedes filemenu. dtmail does not
support filemenu--><!--.TP--><!--.B filemenu--></para>
</listitem>
</varlistentry>
<varlistentry><term>filemenu2</term>
<listitem>
<!-- ex-TP-->
<para>A list of files from which to initialize the <literal>Move</literal>,
and <literal>Copy To</literal> menus. These can be absolute
pathnames or pathnames relative to the directory specified in the <emphasis>folder</emphasis> variable. This variable can be accessed through the <literal>Move Menu</literal> and <literal>Copy To Menu:</literal> scrolling list in
the Message Filing category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>filemenusize</term>
<listitem>
<!-- ex-TP-->
<para>Specifies the maximum number of entries in the <literal>Move</literal>,
and <literal>Copy To</literal> menus. The default is 10.
</para>
</listitem>
</varlistentry>
<varlistentry><term>flash</term>
<listitem>
<!-- ex-TP-->
<para>The number of times to flash the window or icon when new mail arrives.
This variable can be accessed through the Signal New Mail portion of the
Message Header List category of the Mail Options Dialog. The default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry><term>folder</term>
<listitem>
<!-- ex-TP-->
<para>The directory for saving mail files. This variable can be accessed
through the <literal>Start Looking In</literal> item in the Mail Filing category of the Mail Options Dialog.
</para>
</listitem>
</varlistentry>
<varlistentry><term>headerlines</term>
<listitem>
<!-- ex-TP-->
<para>The number of lines to display at a time in the scrolling header list.
This variable can be accessed through the <symbol role="Message">Display</symbol>
item in the Message View category of the Mail Options dialog. The default
is 15.</para>
</listitem>
</varlistentry>
<varlistentry><term>hideattachments</term>
<listitem>
<!-- ex-TP-->
<para>Hide the attachments pane in the Compose Message window by default.
This variable can be accessed through the <literal>Show Attachment List</literal> item in the Compose Window category
of the Mail Options dialog. The default is to show the attachment pane.</para>
</listitem>
</varlistentry>
<varlistentry><term>indentprefix</term>
<listitem>
<!-- ex-TP-->
<para>When indentprefix is set, the string that it is set to is used to mark
indented lines from included messages. The default indentprefix is "> ". This
variable can be accessed through the <literal>Indent String</literal> item in the Compose Window category of
the Mail Options dialog. <!-- [ 8/11/94 dipol ]--><!-- Don't think we support
this anymore--><!-- .B popuplines--><!-- The number of lines in the View Message
and Compose Message--><!-- Windows.--><!-- This variable can be accessed through
the Mail Tool--><!-- Property Sheet in the Message Window category as--><!--
.B Display--><!-- __ Lines of Text. The default is 30.--><!-- .TP--><!--
.B printmail--><!-- The command to use to print a message. This variable
can--><!-- be accessed through the Mail Tool Property Sheet in the--><!--
Message Window category as--><!-- .B Print Script.--><!-- The default is \fBlp
-s\fP.--></para>
</listitem>
</varlistentry>
<varlistentry><term>keepdeleted</term>
<listitem>
<!-- ex-TP-->
<para>Don't purge the mailbox of deleted messages when closing (exiting) dtmail.
Default is to ask the user if they would like to purge the mailbox on exit.
This variable can be set in the <literal>Destroy Deleted Messages</literal> portion in the Message Header List
category of the Mail Options dialog. See <literal>quietdelete</literal>
</para>
</listitem>
</varlistentry>
<varlistentry><term>quietdelete</term>
<listitem>
<!-- ex-TP-->
<para>Don't ask for confirmation when purging the mailbox of deleted messages
when exiting dtmail. This variable can be set in the <literal>Destroy Deleted Messages</literal> portion in the Message Header
List category of the Mail Options dialog. See <literal>keepdeleted</literal>
</para>
</listitem>
</varlistentry>
<varlistentry><term>record</term>
<listitem>
<!-- ex-TP-->
<para>The mail file in which to record outgoing messages. You can control
recording of outgoing mail on a per message basis by the <literal>Log Message</literal> item in the Compose window's File menu. The <emphasis>dontlogmessages</emphasis> variable controls whether or not this item is selected by default.
The <emphasis>record</emphasis> variable may be set through the <literal>Mailbox for Sent Messages:</literal> item in the Message Filing category of the Mail Options
Dialog. If <emphasis>record</emphasis> is not set and the user chooses to
log a message then the message will be saved in ~/sent.mail.</para>
</listitem>
</varlistentry>
<varlistentry><term>retrieveinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval in seconds to check for new mail. This variable can be
accessed through the <literal>Check for New Mail Every:</literal>
item in the Message Header List category of the Mail Options Dialog. The default
is 300 seconds.</para>
</listitem>
</varlistentry>
<varlistentry><term>saveinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval (in seconds) at which to checkpoint the state of the mail
box to disk. Default is 1800 seconds (30 minutes). This variable can be set
using the <literal>Update Mailbox State</literal> item in the Advanced category of the Mail Options dialog. <!--.TP--><!--.B
save--><!--Save contents of each Compose Message window in a dead.letter file
until the--><!--message is delivered successfully. If a Compose Message window
is quit, and--><!--a new one is brought up, the new window will reuse the
dead.letter from the--><!--previous window. The first dead.letter file is
called dead.letter, the--><!--second one is called dead.letter.1, the third
dead.letter.2, and so on.--><!--The default is--><!--.I on.--><!--.TP--></para>
</listitem>
</varlistentry>
<varlistentry><term>showmsgnum</term>
<listitem>
<!-- ex-TP-->
<para>Show message numbers in the scrolling list of message headers. This
variable can be set using the <literal>Display message numbers</literal> item in the Message Header List
category of the Mail Options dialog. Default is to not show message numbers. <literal>showto</literal> Show the "To" field of mail messages in the Header Window
if the mail is from the same user that is reading mail (eg. you). This variable
is accessed using the <literal>Show To: recipient when mail is</literal> item in the Message Header List category of the Mail Options
dialog. <!--.B sortfilemenu--><!--Sort the--><!--.B Move, Copy,--><!--and--><!--.B
Load--><!--menus alphabetically.--><!--.TP--><!--.B suppressautoretrieve--><!--Do
not automatically retrieve new mail messages.--><!--This variable can be accessed
through the Mail Tool--><!--Property Sheet in the Header Window category as--><!--the
Automatically display headers check box.--><!--Default is to automatically
retrieve new mail.--></para>
</listitem>
</varlistentry>
<varlistentry><term>strictmime</term>
<listitem>
<!-- ex-TP-->
<para>Use strict MIME character encoding for outgoing mail. In this case all
lines longer than 72 characters are broken with a newline (and a trailing
"=" is appended to the line), and all trailing spaces are encoded (appearing
as "=20"). Any time character encoding takes place all "=" must be protected
and are therefore are encoded as "=3d". Note that 8 bit characters are always
encoded, even if strictmime is not specified. If you typically send mail to
users of non MIME compliant readers you may want to consider not specifying
strictmime. This variable can be set by selecting the <literal>Use strict MIME character encoding</literal> item in the Advanced category of the Mail Options dialog.
The default is to use more relaxed character encoding (ie don't break long
lines and don't protect trailing spaces).</para>
</listitem>
</varlistentry>
<varlistentry><term>templates</term>
<listitem>
<!-- ex-TP-->
<para>A list of <emphasis>name:path</emphasis> pairs to access via the <literal>Templates</literal> item in the <literal>Format</literal> menu of the Compose
window. <symbol role="Variable">name</symbol> appears in the menu; <emphasis>path</emphasis> is the file included when name is selected. This variable
can be accessed in the Template category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>toolcols</term>
<listitem>
<!-- ex-TP-->
<para>Default width of the primary windows (in columns). This variable can
be accessed through the item in the Message View category of the Mail Options
dialog. <!--.B trash--><!--The name of the trash bin, which may be accessed
--><!--just like any other mail file.--><!--If set, all deleted messages are
moved to the trash bin. --><!--The trash bin is emptied when you commit changes.
This--><!--option degrades the performance of--><!--.B dtmail--><!--and
is not recommended.--></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MAIL COMMANDS</title>
<para>In addition to the commands recognized by <Filename MoreInfo="RefEntry">mailx</Filename>(1)
in the <emphasis>.mailrc</emphasis> file, <command>dtmail</command> also recognizes
the following commands.</para>
<variablelist>
<varlistentry><term>ignore [header-field...]</term>
<listitem>
<!-- ex-TP-->
<para>Suppress displaying of the specified header fields. Examples of header
fields to ignore are Status and Received. The fields are also ignored when
the message is printed. This variable can be accessed through the Abbreviated
Header item in the Message View category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>PRINTING</title>
<para>You can print messages using command invocation by selecting the
message or messages to be printed and then activating the <literal>Print...</literal> command in the <literal>Message</literal> pulldown menu in the <command>dtmail</command> menu bar or the <literal>Print...</literal> command in the
<literal>Mailer - Messages</literal> popup menu that is displayed on
<literal>BMenu Down</literal> events in the message list.</para>
<para>In addition, you can use the <literal>Print</literal> command button
located at the bottom of the message headers list to print the currently
selected messages. In this case, the print job is started using the print
setup context from the last print command without displaying any of the print
setup dialogs.</para>
<para>Alternatively, you can print messages using Drag and Drop invocation.
</para>
<para>Messages containing attachments are printed with summary lines in place
of the attachment. You must print attachments individually in separate
print job invocations.</para>
<para>You can choose to print multiple messages either as a single print
job or as separate print jobs. If you print multiple messages in
a single print job, you can choose to separate the messages using
a blank line or a page break.</para>
<para>To print a mailboxes, use CDE Drag and Drop to drag the icon for the
mailbox from the File Manager to the printer icon in
the desktop.</para>
<para>When you invoke printing, whether by command invocation or by
drag and drop, <command>dtmail</command> displays a Print Setup window that
allows you to set a number of generic and printer-specific printing
options. For example, you can send the output to a file
or a printer. In the case of printed output, you can specify how many copies
you want. You can also access another window to set options specific to
the printer/spooler you are using. For example, you can select paper size,
orientation, a banner page title, one- or two-sided printing, and email notification
on completion of the print job.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following are environment variables taken from the execution environment
and are not alterable within <command>dtmail</command>.</para>
<variablelist>
<varlistentry><term>HOME= directory</term>
<listitem>
<!-- ex-TP-->
<para>The user's home directory.</para>
</listitem>
</varlistentry>
<varlistentry><term>MAIL= filename</term>
<listitem>
<!-- ex-TP-->
<para>The name of the initial mailbox file to read (in lieu of the standard
system mailbox). The default is system dependent.
See FILE section.</para>
</listitem>
</varlistentry>
<varlistentry><term>MAILRC= filename</term>
<listitem>
<!-- ex-TP-->
<para>The name of the start-up file.
Default is
$HOME/.mailrc.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term>/var/mail/* (Sun)</term>
<listitem>
<para></para>
<!-- ex-TP-->
</listitem>
</varlistentry>
<varlistentry><term>/var/spool/mail/* (IBM)</term>
<listitem>
<para></para>
<!-- ex-TP-->
</listitem>
</varlistentry>
<varlistentry><term>/usr/mail* (HP)</term>
<listitem>
<!-- ex-TP-->
<para>System mailboxes</para>
</listitem>
</varlistentry>
<varlistentry><term>/etc/mail/mailx.rc</term>
<listitem>
<!-- ex-TP-->
<para>System setup file that is read in before ~/.mailrc.</para>
</listitem>
</varlistentry>
<varlistentry><term>~/.mailrc</term>
<listitem>
<!-- ex-TP-->
<para>Start-up file for
<command>mail</command> and
<command>dtmail</command>.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/bin/dtmail</term>
<listitem>
<!-- ex-TP-->
<para>Executable for the desktop Mailer.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/app-defaults/&lt;LANG>/Dtmail</term>
<listitem>
<!-- ex-TP-->
<para>Application defaults for the desktop Mailer.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000022737>