/usr/share/doc/mailutils-doc/mailutils.html/Mail-Variables.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA

Copyright (C) 1999-2004, 2008-2012, 2014-2015 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: Mail Variables</title>

<meta name="description" content="GNU Mailutils Manual: Mail Variables">
<meta name="keywords" content="GNU Mailutils Manual: Mail Variables">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="mail.html#mail" rel="up" title="mail">
<link href="Mail-Configuration-Files.html#Mail-Configuration-Files" rel="next" title="Mail Configuration Files">
<link href="Scripting.html#Scripting" rel="prev" title="Scripting">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Mail-Variables"></a>
<div class="header">
<p>
Next: <a href="Mail-Configuration-Files.html#Mail-Configuration-Files" accesskey="n" rel="next">Mail Configuration Files</a>, Previous: <a href="Scripting.html#Scripting" accesskey="p" rel="prev">Scripting</a>, Up: <a href="mail.html#mail" accesskey="u" rel="up">mail</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="How-to-Alter-the-Behavior-of-mail"></a>
<h4 class="subsection">2.5.6 How to Alter the Behavior of <code>mail</code></h4>

<p>Following variables control the behavior of GNU <code>mail</code>:
</p>
<dl compact="compact">
<dd><a name="index-append"></a>
</dd>
<dt><code>append</code></dt>
<dd><br><p>Type: Boolean, Read-Only
<br>Default: True
<a name="index-append_002c-mail-variable"></a>
</p>
<p>Messages saved in mbox are appended to the end rather than prepended.
This is the default and cannot be changed.  This variable exists only
for compatibility with other <code>mailx</code> implementations.
</p>
<a name="index-appenddeadletter"></a>
</dd>
<dt><code>appenddeadletter</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-appenddeadletter_002c-mail-variable"></a>
</p>
<p>If this variable is <code>True</code>, the contents of canceled letter is
appended to the user&rsquo;s <samp>dead.letter</samp> file.  Otherwise it overwrites
its contents.
</p>
<a name="index-askbcc"></a>
</dd>
<dt><code>askbcc</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-askbcc_002c-mail-variable"></a>
</p>
<p>When set to <code>True</code> the user will be prompted to enter <code>Bcc</code>
field before composing the message.
</p>
<a name="index-askcc"></a>
</dd>
<dt><code>askcc</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True.
<a name="index-askcc_002c-mail-variable"></a>
</p>
<p>When set to <code>True</code> the user will be prompted to enter <code>Cc</code>
field before composing the message.
</p>
<a name="index-asksub"></a>
</dd>
<dt><code>asksub</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True in interactive mode, False otherwise.
<a name="index-asksub_002c-mail-variable"></a>
</p>
<p>When set to <code>True</code> the user will be prompted to enter <code>Subject</code>
field before composing the message.
</p>
<a name="index-autoinc"></a>
</dd>
<dt><code>autoinc</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True.
<a name="index-autoinc_002c-mail-variable"></a>
</p>
<p>Automatically incorporate newly arrived messages.
</p>
<a name="index-autoprint"></a>
</dd>
<dt><code>autoprint</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-autoprint_002c-mail-variable"></a>
</p>
<p>Causes the delete command to behave like dp - thus, after deleting a
message, the next one will be typed automatically.
</p>
<a name="index-bang"></a>
</dd>
<dt><code>bang</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-bang_002c-mail-variable"></a>
</p>
<p>When set, every occurrence of <code>!</code> in arguments to <code>!</code>
command is replaced with the last executed command.
</p>
<a name="byname"></a><a name="index-byname"></a>
</dd>
<dt><code>byname</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-byname_002c-mail-variable"></a>
</p>
<p>Record outgoing messages in a file named after the first recipient.
The name is the login-name portion of the address found first on the
&lsquo;<samp>To:</samp>&rsquo; line in the mail header.  This variable overrides the
&lsquo;<samp>record</samp>&rsquo; variable.
</p>
<p>It is set by the <samp>--byname</samp> (<samp>-F</samp>) command line option.
</p>
<a name="datefield"></a><a name="index-datefield"></a>
</dd>
<dt><code>datefield</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-datefield_002c-mail-variable"></a>
</p>
<p>By default the date in a header summary is taken from the <acronym>SMTP</acronym>
envelope of the message.  Setting this variable tells <code>mail</code>
to use the date from <code>Date:</code> header field, converted to
local time.  Notice, that for messages lacking this field <code>mail</code>
will fall back to using <acronym>SMTP</acronym> envelope.
</p>
<p>See <a href="#fromfield">fromfield</a>.
</p>
<a name="index-charset"></a>
</dd>
<dt><code>charset</code></dt>
<dd><br><p>Type: string
<br>Default: &lsquo;<samp>auto</samp>&rsquo;
<a name="index-charset_002c-mail-variable"></a>
</p>
<p>The value of this variable controls the output character set for the
header fields encoding using RFC 2047.  If the variable is unset, no
decoding is performed and the fields are printed as they are.  If the
variable is set to &lsquo;<samp>auto</samp>&rsquo;, <code>mail</code> tries to deduce the
name of the character set from the value of <code>LC_ALL</code> environment
variable.  Otherwise, its value is taken as the name of the charset.
</p>
<a name="index-cmd"></a>
</dd>
<dt><code>cmd</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-cmd_002c-mail-variable"></a>
</p>
<p>Contains default shell command for <code>pipe</code>.
</p>
<a name="index-columns"></a>
</dd>
<dt><code>columns</code></dt>
<dd><br><p>Type: Numeric.
<br>Default: Detected at startup by querying the terminal device.  If this
fails, the value of environment variable <code>COLUMNS</code> is used.
<a name="index-columns_002c-mail-variable"></a>
</p>
<p>This variable contains the number of columns on terminal screen.
</p>
<a name="index-crt"></a>
</dd>
<dt><code>crt</code></dt>
<dd><br><p>Type: Boolean or Numeric
<br>Default: True in interactive mode, False otherwise.
<a name="index-crt_002c-mail-variable"></a>
</p>
<p>The variable <code>crt</code> determines the minimum number of lines the body
of the message must contain in order to be piped through pager command
specified by environment variable <code>PAGER</code>.  If <code>crt</code> is set
to a numeric value, this value is taken as the threshold.  Otherwise,
if <code>crt</code> is set without a value, then the height of the terminal
screen is used to compute the threshold.  The number of lines on
screen is controlled by <code>screen</code> variable.
</p>
<a name="index-debug-4"></a>
</dd>
<dt><code>debug</code></dt>
<dd><br><p>Type: String to boolean
<br>Default: Not set
<a name="index-debug_002c-mail-variable"></a>
</p>
<p>Sets mailutils debug level.  If set to string, the value must be a
valid Mailutils debugging specification.  See <a href="Debug-Statement.html#Debug-Statement">Debug Statement</a>, for
a description.
</p>
<p>If unset (i.e.  <code>set nodebug</code>), clears and disables all debugging
information.  If set to &lsquo;<samp>true</samp>&rsquo; (i.e.  <code>set debug</code>), sets
maximum debugging (&lsquo;<samp>&lt;trace7</samp>&rsquo;) on mailbox and its underlying
objects.
</p>
<a name="index-decode_002dfallback"></a>
</dd>
<dt><code>decode-fallback</code></dt>
<dd><br><p>Type: String.
<br>Default: &lsquo;<samp>none</samp>&rsquo;.
<a name="index-decode_002dfallback_002c-mail-variable"></a>
</p>
<p>This variable controls the way to represent characters that cannot
be rendered using current character set.  It can have three values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Such characters are not printed at all.  The conversion process stops
at the first character that cannot be rendered.
</p>
</dd>
<dt>&lsquo;<samp>copy-pass</samp>&rsquo;</dt>
<dd><p>The characters are displayed &lsquo;<samp>as is</samp>&rsquo;.  Notice, that depending on
your setup, this may screw-up your terminal settings.
</p>
</dd>
<dt>&lsquo;<samp>copy-octal</samp>&rsquo;</dt>
<dd><p>Unprintable characters are represented by their octal codes.  Printable
ones are printed &lsquo;<samp>as is</samp>&rsquo;.
</p></dd>
</dl>

<a name="index-debug-5"></a>
</dd>
<dt><code>debug</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-debug_002c-mail-variable-1"></a>
</p>
<p>This variable is not used.  It exists for compatibility with other
<code>mailx</code> implementations and for future use.
</p>
<a name="index-dot"></a>
</dd>
<dt><code>dot</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-dot_002c-mail-variable"></a>
</p>
<p>If <code>True</code>, causes <code>mail</code> to interpret a period alone on a line as the
terminator of a message you are sending.
</p>
<a name="index-emptystart"></a>
</dd>
<dt><code>emptystart</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-emptystart_002c-mail-variable"></a>
</p>
<p>If the mailbox is empty, <code>mail</code> normally prints &lsquo;<samp>No mail for user</samp>&rsquo; and
exits immediately.  If this option is set, <code>mail</code> will start no matter is
the mailbox empty or not.
</p>
<a name="index-editheaders"></a>
</dd>
<dt><code>editheaders</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-editheaders_002c-mail-variable"></a>
</p>
<p>When set, <code>mail</code> will include message headers in the text to
be the <code>~e</code> and <code>~v</code> escapes, thus allowing you to customize
the headers.
</p>
<a name="index-escape"></a>
</dd>
<dt><code>escape</code></dt>
<dd><br><p>Type: String.
<br>Default: ~
<a name="index-escape_002c-mail-variable"></a>
</p>
<p>If defined, the first character of this option gives the character to
denoting escapes.
</p>
<a name="index-flipr"></a>
</dd>
<dt><code>flipr</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-flipr_002c-mail-variable"></a>
</p>
<p>If set, the variable <code>flipr</code> swaps the meanings of <code>reply</code>
and <code>Reply</code> commands (see <a href="Replying.html#Replying">Replying</a>).
</p>
<a name="index-folder-2"></a>
</dd>
<dt><code>folder</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-folder_002c-mail-variable"></a>
</p>
<p>The name of the directory to use for storing folders of messages.  If
unset, <code>$HOME</code> is assumed.
</p>
<a name="fromfield"></a><a name="index-fromfield"></a>
</dd>
<dt><code>fromfield</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True.
</p>
<p>By default the sender address is taken from the &lsquo;<samp>From</samp>&rsquo; header.
Unsetting this variable tells <code>mail</code> to obtain it from the
<acronym>SMTP</acronym> envelope, instead.
</p>
<p>See <a href="#datefield">datefield</a>.
</p>
<a name="index-header-2"></a>
</dd>
<dt><code>header</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True, unless started with <samp>--nosum</samp> (<samp>-N</samp>) option.
<a name="index-header_002c-mail-variable"></a>
</p>
<p>Whether to run <code>headers</code> command automatically after entering
interactive mode.
</p>
<a name="index-headline"></a>
</dd>
<dt><code>headline</code></dt>
<dd><br><p>Type: String
<br>Default: &lsquo;<samp>%&gt;%a%4m %18f %16d %3l/%-5o %s</samp>&rsquo;
</p>
<p>A format string to use for the header summary.  The &lsquo;<samp>%</samp>&rsquo; character
introduces a <em>format specifier</em>.  Valid format specifiers are:
</p>
<table>
<thead><tr><th width="20%">Letter</th><th width="80%">Meaning</th></tr></thead>
<tr><td width="20%">%a</td><td width="80%">Message attributes.</td></tr>
<tr><td width="20%">%d</td><td width="80%">The date when the message was received.</td></tr>
<tr><td width="20%">%f</td><td width="80%">The address of the message sender.</td></tr>
<tr><td width="20%">%l</td><td width="80%">The number of lines of the message.</td></tr>
<tr><td width="20%">%m</td><td width="80%">Message number.</td></tr>
<tr><td width="20%">%o</td><td width="80%">The number of octets (bytes) in the message.</td></tr>
<tr><td width="20%">%s</td><td width="80%">Message subject (if any).</td></tr>
<tr><td width="20%">%S</td><td width="80%">Message subject (if any) in double quotes.</td></tr>
<tr><td width="20%">%&gt;</td><td width="80%">A &lsquo;<samp>&gt;</samp>&rsquo; for the current message, otherwise a space.</td></tr>
<tr><td width="20%">%&lt;</td><td width="80%">A &lsquo;<samp>&lt;</samp>&rsquo; for the current message, otherwise a space.</td></tr>
<tr><td width="20%">%%</td><td width="80%">A &lsquo;%&rsquo; character.</td></tr>
</table>

<p>Some additional symbols are allowed between &lsquo;<samp>%</samp>&rsquo; and the specifier
letter.  The &lsquo;<samp>-</samp>&rsquo; character immediately following &lsquo;<samp>%</samp>&rsquo;
indicates that this field should be left aligned.  Similarly, the
&lsquo;<samp>+</samp>&rsquo; character indicates right alignment.  Default alignment
depends on the type of the specifier: the specifiers that produce
numeric values (&lsquo;<samp>%l</samp>&rsquo;, &lsquo;<samp>%m</samp>&rsquo;, and &lsquo;<samp>%o</samp>&rsquo;) are aligned to
the right, whereas the ones producing string values are aligned to the
left.
</p>
<p>A number following &lsquo;<samp>%</samp>&rsquo; or the alignment flag, indicates the
field width.  Consider, for example, the following specifiers:
</p>
<dl compact="compact">
<dt>%m</dt>
<dd><p>Print current message number.  Take as much screen columns as necessary
to output it.
</p>
</dd>
<dt>%4m</dt>
<dt>%+4m</dt>
<dd><p>Print current message number.  Occupy 4 screen columns, truncate the
output if it does not fit that width.  Align the output to the right. 
</p>
</dd>
<dt>%-4m</dt>
<dd><p>Same as above, but align to the left.
</p></dd>
</dl>

<a name="index-hold"></a>
</dd>
<dt><code>hold</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-hold_002c-mail-variable"></a>
</p>
<p>When set to <code>True</code>, the read or saved messages will be stored in
user&rsquo;s mailbox (<samp>$HOME/mbox</samp>).  Otherwise, they will be held in
system mailbox also.  This option is in effect only when operating
upon user&rsquo;s system mailbox.
</p>
<a name="index-ignore"></a>
</dd>
<dt><code>ignore</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-ignore_002c-mail-variable"></a>
</p>
<p>When set to <code>True</code>, <code>mail</code> will ignore keyboard interrupts
when composing messages.  Otherwise an interrupt will be taken as a
signal to abort composing.
</p>
<a name="index-ignoreeof"></a>
</dd>
<dt><code>ignoreeof</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-ignoreeof_002c-mail-variable"></a>
</p>
<p>Controls whether typing EOF character terminates the letter being
composed.
</p>
<a name="index-indentprefix"></a>
</dd>
<dt><code>indentprefix</code></dt>
<dd><br><p>Type: String.
<br>Default: &quot;\t&quot; (a tab character).
<a name="index-indentprefix_002c-mail-variable"></a>
</p>
<p>String used by the <code>~m</code> tilde escape for indenting quoted messages.
</p>
<a name="index-inplacealiases"></a>
</dd>
<dt><code>inplacealiases</code></dt>
<dd><br><p>Type: Boolean
<br>Default: False
</p>
<p>If set, <code>mail</code> will expand aliases in the address header field
before entering send mode (see <a href="Composing-Mail.html#Composing-Mail">Composing Mail</a>).  By default, the
address header fields are left intact while composing, the alias
expansion takes place immediately before sending message.
</p>
<a name="index-keep-1"></a>
</dd>
<dt><code>keep</code></dt>
<dd><br><p>Type: Boolean, Read-Only
<br>Default: True
<a name="index-append_002c-mail-variable-1"></a>
</p>
<p>Truncate the user&rsquo;s system mailbox when it is empty, instead of
removing it.  This is the default and cannot be changed.  This variable
exists only for compatibility with other <code>mailx</code> implementations.
</p>
<a name="index-keepsave"></a>
</dd>
<dt><code>keepsave</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-keepsave_002c-mail-variable"></a>
</p>
<p>Controls whether saved messages should be kept in system mailbox too.
This variable is in effect only when operating upon a user&rsquo;s system
mailbox.
</p>
<a name="index-mailx"></a>
</dd>
<dt><code>mailx</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-mailx_002c-mail-variable"></a>
</p>
<p>When set, enables <em>mailx compatibility mode</em>.  This mode
has the following effects:
</p>
<ul>
<li> When composing a message <code>mail</code> will ask
for <code>Cc</code> and <code>Bcc</code> addresses after composing the body.
The default behavior is to ask for these values before composing
the body.

</li><li> In send mode, if the composition was interrupted, <code>mail</code>
will exit with zero status.  By default it exits with zero status only
if the message was sent successfully.
</li></ul>

<a name="index-metamail-1"></a>
</dd>
<dt><code>metamail</code></dt>
<dd><br><p>Type: Boolean or String.
<br>Default: True.
<a name="index-metamail_002c-mail-variable"></a>
</p>
<p>This variable controls operation of <code>decode</code> command.  If
it is unset, <code>decode</code> will not attempt any interpretation
of the content of message parts.  Otherwise, if <code>metamail</code>
is set to <code>true</code>, <code>decode</code> will use internal metamail
support to interpret message parts.  Finally, if <code>metamail</code>
is assigned a string, this string is treated as command line of
the external <code>metamail</code> command which will be used to
display parts of a multipart message.  For example:
</p>
<div class="example">
<pre class="example"># Disable MIME interpretation:
set nometamail
# Enable built-in MIME support:
set metamail
# Use external program to display MIME parts:
set metamail=&quot;metamail -m mail -p&quot;
</pre></div>

<a name="index-mimenoask"></a>
</dd>
<dt><code>mimenoask</code></dt>
<dd><br><p>Type: String
<br>Default: Empty
<a name="index-mimenoask_002c-mail-variable"></a>
</p>
<p>By default <code>mail</code> asks for confirmation before running
interpreter to view a part of the multi-part message.  If this variable
is set, its value is treated as a comma-separated list of MIME types
for which no confirmation is needed.  Elements of this list may include
shell-style globbing patterns, e.g. setting
</p>
<div class="example">
<pre class="example">set mimenoask=text/*,image/jpeg
</pre></div>

<p>will disable prompting before displaying any textual files, no
matter what their subtype is, and before displaying files with
type &lsquo;<samp>image/jpeg</samp>&rsquo;.
</p>
<a name="index-metoo"></a>
</dd>
<dt><code>metoo</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-metoo_002c-mail-variable"></a>
</p>
<p>Usually, when an alias is expanded that contains the sender, the sender
is removed from the expansion.  Setting this option causes the sender to
be included in the group.
</p>
<a name="index-mode-1"></a>
</dd>
<dt><code>mode</code></dt>
<dd><br><p>Type: String, Read-Only
<br>Default: The name of current operation mode.
<a name="index-mode_002c-mail-variable"></a>
</p>
<p>This variable keeps the name of the current operation mode.  Its
possible values are:
</p>
<dl compact="compact">
<dt>headers</dt>
<dd><p>The program is started with the <samp>--headers</samp> (<samp>-H</samp>) command
line option (see <a href="Invoking-Mail.html#Invoking-Mail">Invoking Mail</a>).
</p>
</dd>
<dt>exist</dt>
<dd><p>The program is started with the <samp>--exist</samp> (<samp>-e</samp>) command
line option (see <a href="Invoking-Mail.html#Invoking-Mail">Invoking Mail</a>).
</p>
</dd>
<dt>print</dt>
<dd><p>The program is started with the <samp>--print</samp> (<samp>-p</samp>) command
line option (see <a href="Invoking-Mail.html#Invoking-Mail">Invoking Mail</a>).
</p>
</dd>
<dt>read</dt>
<dd><p>The progran operates in read mode.  This is the default.
</p>
</dd>
<dt>send</dt>
<dd><p>The program operates in send mode.  This means it was given one or more
recipient addresses in the command line.
</p></dd>
</dl>

<a name="index-nullbody"></a>
</dd>
<dt><code>nullbody</code></dt>
<dd><br><p> Type: Boolean
<br> Default: True
<a name="index-nullbody_002c-mail-variable"></a>
</p>
<p>Controls whether <code>mail</code> accepts messages with an empty
body.  The default value, <code>true</code>, means such messages are sent,
and a warning (traditionally saying &lsquo;<samp>Null message body; hope
that's ok</samp>&rsquo;) is displayed.  The text of the warning can be set using
<code>nullbodymsg</code> variable (see below).
</p>
<p>If <code>nullbody</code> is unset, <code>mail</code> will silently ignore such
messages.  This can be useful in <samp>crontab</samp> files, to avoid sending
mails when nothing important happens.  For example, the <samp>crontab</samp>
entry below will send mail only if the utility <code>some-prog</code>
outputs something on its standard output or error:
</p>
<div class="example">
<pre class="example">*/5 * * * * some-prog 2&gt;&amp;1 | \
   /bin/mail -E'set nonullbody' -s 'Periodic synchronization'
</pre></div>

<a name="index-showenvelope"></a>
</dd>
<dt><code>showenvelope</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
</p>
<p>If this variable is set, the <code>print</code> command will include the
<acronym>STMP</acronym> envelope in its output.
</p>
<a name="index-nullbodymsg"></a>
</dd>
<dt><code>nullbodymsg</code></dt>
<dd><br><p>Type: String
<br>Default: Null message body; hope that&rsquo;s ok 
<a name="index-nullbodymsg-1"></a>
</p>
<p>Keeps the text of the warning, displayed by <code>mail</code> before
sending an empty message.  When available, the translation of
this text, in accordance with the current locale, is displayed.
</p>
<p>Unsetting this variable disables the warning.
</p>
<a name="index-onehop"></a>
</dd>
<dt><code>onehop</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-onehop_002c-mail-variable"></a>
</p>
<p>This variable is not used.  It exists for compatibility with other
<code>mailx</code> implementations and for future use.
</p>
<a name="index-outfolder"></a>
</dd>
<dt><code>outfolder</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-outfolder_002c-mail-variable"></a>
</p>
<p>Contains the directory in which files created by <code>save</code>,
<code>write</code>, etc. commands will be stored.  When unset, current
directory is assumed.
</p>
<a name="index-page"></a>
</dd>
<dt><code>page</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-page_002c-mail-variable"></a>
</p>
<p>If set to <code>True</code>, the <code>pipe</code> command will emit a linefeed
character after printing each message.
</p>
<a name="index-prompt"></a>
</dd>
<dt><code>prompt</code></dt>
<dd><br><p>Type: String.
<br>Default: &quot;? &quot;
<a name="index-prompt_002c-mail-variable"></a>
</p>
<p>Contains the command prompt sequence.
</p>
<a name="index-quiet"></a>
</dd>
<dt><code>quiet</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-quiet_002c-mail-variable"></a>
</p>
<p>This variable is not used.  It exists for compatibility with other
<code>mailx</code> implementations and for future use.
</p>
<a name="index-quit"></a>
</dd>
<dt><code>quit</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False, unless started with <samp>--quit</samp> (<samp>-q</samp>) option.
<a name="index-quit_002c-mail-variable"></a>
</p>
<p>When set, causes keyboard interrupts to terminate the program.
</p>
<a name="index-rc"></a>
</dd>
<dt><code>rc</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True, unless started with <samp>--norc</samp> (<samp>-N</samp>) option.
<a name="index-rc_002c-mail-variable"></a>
</p>
<p>When this variable is set, <code>mail</code> will read the system-wide
configuration file upon startup.  See <a href="Mail-Configuration-Files.html#Mail-Configuration-Files">Mail Configuration Files</a>.
</p>
<a name="index-readonly"></a>
</dd>
<dt><code>readonly</code></dt>
<dd><br><p>Type: Boolean
<br>Default: False
<a name="index-readonly_002c-mail-variable"></a>
</p>
<p>When set, mailboxes are opened in readonly mode.  In this mode, any
<code>mail</code> commands that alter the contents of the mailbox are
disabled.  These commands include, but are not limited to: 
<code>delete</code>, <code>save</code> and <code>mbox</code>.
</p>
<a name="index-record"></a>
</dd>
<dt><code>record</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-record_002c-mail-variable"></a>
</p>
<p>When set, any outgoing message will be saved to the named file.
</p>
<a name="index-recursivealiases"></a>
</dd>
<dt><code>recursivealiases</code></dt>
<dd><br><p>Type: Boolean
<br>Default: True
</p>
<p>When set, <code>mail</code> will expand aliases recursively.
</p>
<a name="index-regex"></a>
</dd>
<dt><code>regex</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True.
<a name="index-regex_002c-mail-variable"></a>
</p>
<p>Setting this to <code>True</code> enables use of regular expressions in
&lsquo;<samp>/.../</samp>&rsquo; message specifications.
</p>
<a name="index-replyprefix"></a>
</dd>
<dt><code>replyprefix</code></dt>
<dd><br><p>Type: String
<br>Default: &lsquo;<samp>Re: </samp>&rsquo;
<a name="index-replyprefix_002c-mail-variable"></a>
</p>
<p>Sets the prefix that will be used when constructing the subject line
of a reply message.
</p>
<a name="index-replyregex"></a>
</dd>
<dt><code>replyregex</code></dt>
<dd><br><p>Type: String
<br>Default: &lsquo;<samp>^re: *</samp>&rsquo;
<a name="index-replyregex_002c-mail-variable"></a>
</p>
<p>Sets the regular expression used to recognize subjects of reply
messages.  If the <code>Subject</code> header of the message matches this
expression, the value of <code>replyprefix</code> will not be prepended to
it before replying.  The expression should be a POSIX extended regular
expression.  The comparison is case-insensitive.
</p>
<p>For example, to recognize usual English, Polish, Norwegian and German
reply subject styles, use:
</p>
<div class="example">
<pre class="example">set replyregex=&quot;^(re|odp|aw|ang)(\\[[0-9]+\\])?:[[:blank:]]&quot;
</pre></div>

<p>(Notice the quoting of backslash characters).
</p>
<a name="return_002daddress"></a><a name="index-return_002daddress"></a>
</dd>
<dt><code>return-address</code></dt>
<dd><br><p>Type: String
<br>Default: unset
<a name="index-return_002daddress_002c-mail-variable_002e"></a>
</p>
<p>Sets the return email address to use when sending messages.  If unset,
the address is composed from the current user name and the host name.
</p>
<a name="index-save"></a>
</dd>
<dt><code>save</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: True.
<a name="index-save_002c-mail-variable"></a>
</p>
<p>When set, the aborted messages will be stored in the user&rsquo;s
<samp>dead.file</samp>.  See also <code>appenddeadletter</code>.
</p>
<a name="index-screen"></a>
</dd>
<dt><code>screen</code></dt>
<dd><br><p>Type: Numeric.
<br>Default: Detected at startup by querying the terminal device.  If this
fails, the value of environment variable <code>LINES</code> is used.
<a name="index-screen_002c-mail-variable"></a>
</p>
<p>This variable contains the number of lines on terminal screen.
</p>
<a name="index-sendmail"></a>
</dd>
<dt><code>sendmail</code></dt>
<dd><br><p>Type: String.
<br>Default: sendmail:/usr/lib/sendmail
<a name="index-sendmail_002c-mail-variable"></a>
</p>
<p>Contains URL of the mail transport agent.
</p>
<a name="index-sendwait"></a>
</dd>
<dt><code>sendwait</code></dt>
<dd><br><p>Type: Boolean
<br>Default: Unset
<a name="index-sendwait_002c-mail-variable"></a>
</p>
<p>This variable is not used.  It exists for compatibility with other
<code>mailx</code> implementations and for future use.
</p>
<a name="index-showto"></a>
</dd>
<dt><code>showto</code></dt>
<dd><br><p>Type: Boolean
<br>Default: False
<a name="index-showto_002c-mail-variable"></a>
</p>
<p>If the message was sent by the user, print its recipient address in
the header summary.
</p>
<a name="index-Sign"></a>
</dd>
<dt><code>Sign</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-Sign_002c-mail-variable"></a>
</p>
<p>Contains the filename holding users signature.  The contents of this
file is appended to the end of a message being composed by <code>~A</code>
escape.
</p>
<a name="index-sign"></a>
</dd>
<dt><code>sign</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-sign_002c-mail-variable"></a>
</p>
<p>Contains the user&rsquo;s signature.  The contents of this variable is appended
to the end of a message being composed by <code>~a</code> escape.  Use
<code>Sign</code> variable, if your signature occupies more than one line.
</p>
<a name="index-showto-1"></a>
</dd>
<dt><code>showto</code></dt>
<dd><br><p>Type: Boolean
<br>Default: unset
<a name="index-showto_002c-mail-variable-1"></a>
</p>
<p>If this variable is set, <code>mail</code> will show <code>To:</code> addresses
instead of <code>From:</code> for all messages that come from the user that
invoked the program.
</p>
<a name="index-subject"></a>
</dd>
<dt><code>subject</code></dt>
<dd><br><p>Type: String.
<br>Default: Unset.
<a name="index-subject_002c-mail-variable"></a>
</p>
<p>Contains default subject line.  This will be used when <code>asksub</code> is
off.
</p>
<a name="index-toplines"></a>
</dd>
<dt><code>toplines</code></dt>
<dd><br><p>Type: Numeric.
<br>Default: 5
<a name="index-toplines_002c-mail-variable"></a>
</p>
<p>Number of lines to be displayed by <code>top</code> and <code>Top</code> commands.
</p>
<a name="index-variable_002dstrict"></a>
</dd>
<dt><code>variable-strict</code></dt>
<dt><code>varstrict</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
</p>
<p>Setting this variable enables strict control over variable
settings.  In this mode, <code>mail</code> refuses to set read-only
variables.  Also, if the user is trying to set an unknown variable,
<code>mail</code> prints a warning.
</p>
<p>See <a href="Scripting.html#Setting-and-Unsetting-the-Variables">Setting and Unsetting the Variables</a>.
</p>
<a name="index-variable_002dpretty_002dprint"></a>
</dd>
<dt><code>variable-pretty-print</code></dt>
<dt><code>varpp</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
</p>
<p>If this variable is set, the listing ouput by <code>set</code> contains short
descriptions before each variable.  See <a href="Scripting.html#Setting-and-Unsetting-the-Variables">Setting and Unsetting the Variables</a>. 
</p>
<a name="index-verbose-2"></a>
</dd>
<dt><code>verbose</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: False.
<a name="index-verbose_002c-mail-variable"></a>
</p>
<p>When set, the actual delivery of messages is displayed on the user&rsquo;s terminal.
</p>
<a name="index-xmailer"></a>
</dd>
<dt><code>xmailer</code></dt>
<dd><br><p>Type: Boolean.
<br>Default: Set.
<a name="index-xmailer_002c-mail-variable"></a>
</p>
<p>Controls whether the header &lsquo;<samp>X-Mailer</samp>&rsquo; should be added to 
outgoing messages.  The default value of this header is
</p>
<div class="example">
<pre class="example">X-Mailer: mail (GNU Mailutils 2.99.99)
</pre></div>

</dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Mail-Configuration-Files.html#Mail-Configuration-Files" accesskey="n" rel="next">Mail Configuration Files</a>, Previous: <a href="Scripting.html#Scripting" accesskey="p" rel="prev">Scripting</a>, Up: <a href="mail.html#mail" accesskey="u" rel="up">mail</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
mailutils-doc 1:2.99.99-1ubuntu2 / usr / share / doc / mailutils-doc / mailutils.html / Mail-Variables.html
