/usr/share/doc/mailutils-doc/mailutils.html/Format-String-Diffs.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 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 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: Format String Diffs</title>

<meta name="description" content="GNU Mailutils Manual: Format String Diffs">
<meta name="keywords" content="GNU Mailutils Manual: Format String Diffs">
<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="Diffs.html#Diffs" rel="up" title="Diffs">
<link href="Profile-Variable-Diffs.html#Profile-Variable-Diffs" rel="next" title="Profile Variable Diffs">
<link href="Diffs.html#Diffs" rel="prev" title="Diffs">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
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.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Format-String-Diffs"></a>
<div class="header">
<p>
Next: <a href="Profile-Variable-Diffs.html#Profile-Variable-Diffs" accesskey="n" rel="next">Profile Variable Diffs</a>, Up: <a href="Diffs.html#Diffs" accesskey="u" rel="up">Diffs</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="New-and-Differing-MH-Format-Specifications"></a>
<h4 class="subsubsection">3.16.1.1 New and Differing MH Format Specifications</h4>

<a name="decode-function"></a><dl>
<dt><a name="index-decode"></a>MH Format: <em>string</em> <strong>decode</strong> <em>(string <var>str</var>)</em></dt>
<dd>
<p>Decodes the input string <var>str</var> as per RFC 2047.  Useful in printing
&lsquo;<samp>From:</samp>&rsquo;, &lsquo;<samp>To:</samp>&rsquo; and &lsquo;<samp>Subject:</samp>&rsquo; headers.
</p>
<p>Notice that, unlike the similar NMH function, <code>decode</code> checks the value
of the global profile variable <code>Charset</code> (see <a href="Profile-Variable-Diffs.html#Charset-variable">Charset variable</a>)
to determine the charset to output the result in.  If this variable is
not set, <code>decode</code> returns its argument without any change.  If
this variable is set to <code>auto</code>, <code>decode</code> tries to determine
the charset name from the setting of <code>LC_ALL</code> environment
variable.  Otherwise, the value of <code>Charset</code> is taken to be the
name of the character set.
</p></dd></dl>

<dl>
<dt><a name="index-package"></a>MH Format: <em>string</em> <strong>package</strong> <em>()</em></dt>
<dd>
<p>Returns package name (string &lsquo;<samp>mailutils</samp>&rsquo;).
</p></dd></dl>

<dl>
<dt><a name="index-package_005fstring"></a>MH Format: <em>string</em> <strong>package_string</strong> <em>()</em></dt>
<dd>
<p>Returns full package string (e.g.  &lsquo;<samp>GNU Mailutils 2.1</samp>&rsquo;)
</p></dd></dl>

<dl>
<dt><a name="index-version"></a>MH Format: <em>string</em> <strong>version</strong> <em>()</em></dt>
<dd>
<p>Returns mailutils version.
</p></dd></dl>

<dl>
<dt><a name="index-unre"></a>MH Format: <em>string</em> <strong>unre</strong> <em>(string <var>str</var>)</em></dt>
<dd>
<p>The function removes any leading whitespace and eventual &lsquo;<samp>Re:</samp>&rsquo; prefix
from its argument.  Useful for creating subjects in reply messages:
</p>
<div class="smallexample">
<pre class="smallexample">  %&lt;{subject}Subject: Re: %(unre{subject})\\n%&gt;
</pre></div>
</dd></dl>

<a name="reply_005fregex-function"></a><dl>
<dt><a name="index-reply_005fregex"></a>MH Format: <em>void</em> <strong>reply_regex</strong> <em>(string <var>r</var>)</em></dt>
<dd>
<p>Sets the regular expression used to recognize reply messages.  The
argument <var>r</var> should be a POSIX extended regular expression. 
Matching is case insensitive. 
</p>
<p>For example, the following invocation
</p>
<div class="smallexample">
<pre class="smallexample">  %(reply_regex ^\(re|aw|ang|odp\)\(\\[[0-9]+\\]\)?:[[:blank:]])
</pre></div>

<p>corresponds to English &lsquo;<samp>Re</samp>&rsquo;, Polish &lsquo;<samp>Odp</samp>&rsquo;, Norwegian &lsquo;<samp>Aw</samp>&rsquo; or
German &lsquo;<samp>Ang</samp>&rsquo;, optionally followed by a number in brackets, followed
by colon and any amount of whitespace.  Notice proper quoting of the
regex metacharacters.
</p>
<p>See also <code>Reply-Regex</code> (see <a href="Profile-Variable-Diffs.html#Reply_002dRegex-variable">Reply-Regex variable</a>) and
<code>isreply</code> (see <a href="#isreply-MH-function">isreply MH function</a>) below.
</p>
</dd></dl>

<a name="isreply-MH-function"></a><dl>
<dt><a name="index-isreply"></a>MH Format: <em>boolean</em> <strong>isreply</strong> <em>([string <var>str</var>])</em></dt>
<dd>
<p>If <var>str</var> is not given, the value of &lsquo;<samp>Subject:</samp>&rsquo; header is taken.
</p>
<p>The function returns true if its argument matches the &ldquo;reply subject&rdquo;
regular expression.  This expression is set via the global profile variable
<code>Reply-Regex</code> (see <a href="Profile-Variable-Diffs.html#Reply_002dRegex-variable">Reply-Regex variable</a>) or via the format
function <code>reply_regex</code>. 
</p>
<p>This function is useful for creating &lsquo;<samp>Subject:</samp>&rsquo; headers in reply
messages.  For example, consider the following construction:
</p>
<div class="smallexample">
<pre class="smallexample">%&lt;{subject}%(lit)%&lt;(isreply)%?\
(profile reply-prefix)%(concat)%|%(concat Re:)%&gt;\
%(concat{subject})%(printhdr Subject: )\n%&gt;
</pre></div>

<p>If the &lsquo;<samp>Subject:</samp>&rsquo; header already contained reply prefix, this construct
leaves it unchanged.  Otherwise it prepends to it the value of
<code>Reply-Prefix</code> profile variable, or, if it is unset, the string
&lsquo;<samp>Re:</samp>&rsquo;. 
</p>
<p>This expression is used in default <samp>replcomps</samp> and
<samp>replgroupcomps</samp> files.
</p></dd></dl>

<dl>
<dt><a name="index-rcpt"></a>MH Format: <em>boolean</em> <strong>rcpt</strong> <em>(&lsquo;<samp>to</samp>&rsquo; | &lsquo;<samp>cc</samp>&rsquo; | &lsquo;<samp>me</samp>&rsquo; | &lsquo;<samp>all</samp>&rsquo;)</em></dt>
<dd>
<p>This function returns true if the given element is present in the
recipient mask (as modified by <samp>--cc</samp> or <samp>--nocc</samp> options) and
false otherwise.  It is used in default formats for <code>repl</code> and
<code>comp</code>, e.g.: 
</p>
<div class="smallexample">
<pre class="smallexample">%(lit)%&lt;(rcpt to)%(formataddr{to})%&gt;
</pre></div>

<p>Notice that this means that usual <samp>replcomps</samp> file will be ignoring
<samp>--cc</samp> and <samp>--nocc</samp> options, unless it has been modified
as shown above. 
</p></dd></dl>

<dl>
<dt><a name="index-concat"></a>MH Format: <em>string</em> <strong>concat</strong> <em>()</em></dt>
<dd>
<p>Appends whitespace + arg to string register.
</p></dd></dl>

<dl>
<dt><a name="index-printhdr"></a>MH Format: <em>string</em> <strong>printhdr</strong> <em>(string <var>str</var>)</em></dt>
<dd>
<p>Prints the value of string register, prefixed by <var>str</var>.
The output is formatted as a RFC 822 header, i.e.
it is split at whitespace characters nearest to the width boundary
and each subsequent segment is prefixed with horizontal tabulation.
</p></dd></dl>

<dl>
<dt><a name="index-in_005freply_005fto"></a>MH Format: <em>string</em> <strong>in_reply_to</strong> <em>()</em></dt>
<dd>
<p>Generates the value for &lsquo;<samp>In-reply-to:</samp>&rsquo; header according to RFC
2822. 
</p></dd></dl>

<dl>
<dt><a name="index-references"></a>MH Format: <em>string</em> <strong>references</strong> <em>()</em></dt>
<dd>
<p>Generates the value for &lsquo;<samp>References:</samp>&rsquo; header according to RFC 2822.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Profile-Variable-Diffs.html#Profile-Variable-Diffs" accesskey="n" rel="next">Profile Variable Diffs</a>, Up: <a href="Diffs.html#Diffs" accesskey="u" rel="up">Diffs</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.98-2 / usr / share / doc / mailutils-doc / mailutils.html / Format-String-Diffs.html
