trAvis - MANAGER

Edit File: mailbot.html

<?xml version="1.0"?>
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>mailbot</title><link rel="stylesheet" type="text/css" href="style.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/><link rel="home" href="#idm255216686912" title="mailbot"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--

--></head><body><div class="refentry"><a id="idm255216686912" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2>mailbot — A MIME-aware autoresponder utility</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">mailbot</code> [options] {<code>program</code>} [arg...]</div><div class="informalexample">In <code class="filename">.mailfilter:</code><pre class="programlisting" xml:space="preserve">
if (/^Subject: *info/)
{
 cc "| mailbot -t /usr/share/autoresponse/info -d autoresponsedb \
 -A 'From: info@domain.com' /usr/bin/sendmail -f ''"
}
</pre></div></div><div class="refsect1"><a id="idm255218054800" shape="rect"> </a><h2>DESCRIPTION</h2>mailbot reads an E-mail message on standard input
and creates an E-mail message replying to the original message's sender.
A
program is specified as an argument to
mailbot after all of mailbot options.
program is expected to read the
created autoreply on its standard input, and mail it.
If program is not specified,
mailbot runs '<code class="literal">sendmail -f ""</code>'.
mailbot has several options for suppressing duplicate
autoresponse messages.
If mailbot chooses not to send an autoresponse, it quietly
terminates without running program.
The autoresponse is optionally
formatted as a MIME delivery status notification.
The text of the autoresponse is specified by the <code class="option">-t</code> or
the <code class="option">-m</code> argument. Either one is required.
Everything else is optional.
The only exception is the <code class="option">-T replydraft</code> option, which requires
the <code class="option">-l</code> option instead of either <code class="option">-t</code> or
<code class="option">-m</code>.
The default behavior is to send an autoresponse unless the original message
has the "<code class="literal">Precedence: junk</code>" or the
"<code class="literal">Precedence: bulk</code>" header, or the
"<code class="literal">Precedence: list</code>" header, or the
"<code class="literal">List-ID:</code>" header,
or if
its MIME content type is "<code class="literal">multipart/report</code>"
(this is the MIME content type for delivery status notifications).
The <code class="option">-M</code> option formats the
the autoresponse itself as a MIME delivery status notification.</div><div class="refsect1"><a id="idm255212760032" shape="rect"> </a><h2>OPTIONS</h2><div class="variablelist"><dl class="variablelist"><dt>-A "<code>header: value</code>"</dt><dd>
	 Add a header to the autoresponse. Multiple <code class="option">-A</code>
	 options are allowed.
	 In most situations, the <code class="option">-A</code> option must be
	 used to set the “From:” header in the autogenerated
	 response.
	 </dd><dt>-f<code>address</code></dt><dd>
Address the autoresponse to <code>address</code>, which must
be an
<a class="ulink" href="http://tools.ietf.org/html/rfc2822" target="_top" shape="rect">RFC 2822</a>
address.
By default mailbot takes the autoresponse
address from the
<code class="literal">From:</code> (or the <code class="literal">Reply-To:</code>) header
in the original message.
<code class="option">-f</code>, if present, overrides and explicitly sets the
autoresponse address.
"<code>address</code>" must immediately follow the
<code class="option">-f</code> option without an intervening space
(it's a single command line argument).
An <code class="option">-f</code> option without an <code>address</code>
takes the address from the <code class="envar">SENDER</code> environment variable.</dd><dt>-t <code>filename</code></dt><dd>
Read text autoresponse from <code>filename</code>,
which must contain a plain text message in “flowed-text” format.
In a “flowed-text”-formatted message, each line that ends with
a space character indicates that the line logically flows into the next line.
This allows the message to be reformatted for any shown display width.
	 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
Messages in languages (see the <code class="option">-c</code>
option) which use spaces as word delimiters must have two
spaces at the end of a flowed line. The last space on a flowed line is logically
removed, and the first space separates the
last word on the previous line from the first word on the next line. Otherwise,
the two words will not have a logical space between them if they get
repositioned as part of adjusting the message's width for display.
	 
Messages in ideographic languages that do not use spaces as word delimiters
need only one space trailing a flowed line.</div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
The trailing whitespace has no visual impact when shown by software
that does not implemented flowed text format, and always displays messages
using their original width.</div></dd><dt>-c <code>charset</code></dt><dd>
Set the autoresponse's MIME character set to
<code>charset</code>.
Run mailbot without any arguments to see the
default character set.</dd><dt>-m <code>filename</code></dt><dd>
	 Read a MIME autoresponse from <code class="filename">filename</code>.
	 This is similar to the <code class="option">-t</code> option,
	 except that <code>filename</code> contains MIME headers,
	 followed by a blank line, and the corresponding
	 MIME content. The contents of <code>filename</code> are
	 inserted in the autoresponse without further processing.
	 The specified file must contain the
	 “Content-Type” header specifying the
	 “text/plain” MIME type, with the
	 “format=flowed”,
	 “delsp=yes”, and the
	 “charset” attributes, which override the
	 <code class="option">-c</code> parameter.
	 If the specified file has a “Content-Transfer-Encoding”
	 header it must be either “7bit” or “8bit”,
	 it may not be “quoted-printable”.
	 mailbot always drops any
	 existing “Content-Transfer-Encoding” header and
	 always adds the
	 “Content-Transfer-Encoding: 8bit” header, even with
	 the <code class="option">-m</code>, since the salutation inserted into the
	 message includes the sender's name, which may contain 8-bit
	 characters. Example:
	 <div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
Content-Type: text/plain; format=flowed; delsp=yes; charset="iso-8859-1"

Mary had a little lamb, 
Its fleece was white as snow. 
And everywhere Mary went, 
The lamb was sure to go.</pre></div></blockquote></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
When the <code class="option">-m</code> option is specified
mailbot ignores the locale's character
set and formats the autoreply according to the character set read from the
“Content-Type” header.</div></dd><dt>-M <code>address</code></dt><dd>
	 Format the autoresponse as a delivery status notification
	 (<a class="ulink" href="http://tools.ietf.org/html/rfc1894" target="_top" shape="rect">RFC 1894</a>).
	 <code>address</code> is an
	 <a class="ulink" href="http://tools.ietf.org/html/rfc2822" target="_top" shape="rect">RFC 2822</a>
	 E-mail address that generates the DSN.
	 Note that the <code class="option">-A</code> option should still be used in 
	 addition to <code class="option">-M</code> in order to set the
	 <code class="literal">From:</code> header on the autoresponse.
	 <code class="option">-M</code> sets the DSN address only.
	 The <code class="option">-M</code> option automatically sets
	 <code class="option">-T <code class="literal">replydsn</code></code>
	 </dd><dt>-R <code>type</code></dt><dd>
	 Specify the feedback report type, with
	 <code>type</code> set to
	 <code class="literal">abuse</code>,
	 <code class="literal">fraud</code>,
	 <code class="literal">other</code>, or
	 <code class="literal">virus</code>.
	 Must be used together with “-T feedback” or
	 “-T replyfeedback”.
	 </dd><dt>-T <code>format</code></dt><dd>
	 Set the reply format. <code>format</code>
	 must be one of the following values:
	 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
		“reply” - the default reply format.
	 </li><li class="listitem">
		“replyall” - like “reply”, except
		also puts the recipients in the original message's
		“To:” and “Cc:” headers into the
		“Cc:” header of the generated reply.
	 </li><li class="listitem">
		“replydsn” - like “reply”, except
		the message is formatted as a delivery status notification.
	 </li><li class="listitem">
		“replydraft” - like “reply”, with
		the text of the autoresponse coming from a maildir specified
		by the <code class="option">-l</code> option. See “Autoreplies
		 from a maildir folder”, below.
	 </li><li class="listitem">
		“forward” - attach the original message as
		forwarded text.
	 </li><li class="listitem">
		“forwardatt” - attach the original message as
		a forwarded message attachment.
	 </li><li class="listitem">
		“feedback” - generate an Email Feedback Report
		message (see <a class="ulink" href="http://tools.ietf.org/html/rfc5965" target="_top" shape="rect">RFC
		 5965</a>). The “-R” option is required when
		this is specified.
	 </li><li class="listitem">
		“replyfeedback” - like “feedback”, but
		also adds a “To:” header, addressed to the original
		message's sender.
	 </li></ul></div></dd><dt>-N</dt><dd>
	 Do not quote the contents of the original message in the message
	 created by
	 “<code class="literal">reply</code>”,
	 “<code class="literal">replyall</code>”,
	 “<code class="literal">replydsn</code>”,
	 “<code class="literal">feedback</code>”, and
	 “<code class="literal">replyfeedback</code>” options.
	 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
	 The original message gets quoted, in the absence of this option,
	 only if the original message was formatted as plain text.
	 mailbot is unable to quote an original
	 message which was formatted as <acronym class="acronym">HTML</acronym>, or any
	 other non-plaintext format.
	 </div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
	 For “<code class="literal">replydsn</code>”,
	 “<code class="literal">feedback</code>”, and
	 “<code class="literal">replyfeedback</code>” options,
	 the convention is to attach the original message, or only its
	 headers, separately; so this option should always be specified
	 for these three reply formats.
	 </div></dd><dt>-a</dt><dd>
	 Attach the entire message, for
	 “<code class="literal">replydsn</code>”,
	 “<code class="literal">feedback</code>”, and
	 “<code class="literal">replyfeedback</code>”, instead of only its
	 headers.
	 </dd><dt>-e</dt><dd>
	 Generate a reply (“reply”-formats) to the
	 address listed in any “Errors-To” or
	 “Return-Path” header, if present, instead of the
	 “From” header.
	 </dd><dt>-S “salutation”</dt><dd>
	 Use the given <code>salutation</code>
	 in the “reply”.
	 The default value is “%F writes:”.
	 The following substitutions are recognized in the salutation
	 string:
	 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
		<code class="literal">%%</code> - an explicit <code class="literal">%</code>
		character.
	 </li><li class="listitem">
		<code class="literal">%n</code> - a newline character.
	 </li><li class="listitem">
		<code class="literal">%C</code> - the
		“X-Newsgroup:” header from the original message.
	 </li><li class="listitem">
		<code class="literal">%N</code> - the “Newsgroups:”
		header from the original message.
	 </li><li class="listitem">
		<code class="literal">%i</code> - the “Message-ID:”
		header from the original message.
	 </li><li class="listitem">
		<code class="literal">%f</code> - the original message's sender's address.
	 </li><li class="listitem">
		<code class="literal">%F</code> - the original message's sender's name.
	 </li><li class="listitem">
		<code class="literal">%S</code> - the
		“Subject:” header from the original message
	 </li><li class="listitem">
		<code class="literal">%d</code> - the original message's date, in the
		local timezone.
	 </li><li class="listitem">
		<code class="literal">%{<code>...</code>}d</code>
		- use <code class="function">strftime</code>() to format the original
		message's date.
	 A plain <code class="literal">%d</code> is equivalent to
		<code class="literal">%{%a, %d %b %Y %H:%M:%S %z}d</code>.
	 </li></ul></div>
	 All other characters in the salutation string are left as is.
	 </dd><dt>-F “marker”</dt><dd>
	 When generating a <code class="literal">forward</code>, use the
	 <code>marker</code> to separate the forwarded
	 message from the autoreply text, instead of the default
	 “--- Forwarded message ---”
	 </dd><dt>-r <code>addrlist</code></dt><dd>
<code>addrlist</code> is a comma-separated list of
<a class="ulink" href="http://tools.ietf.org/html/rfc2822" target="_top" shape="rect">RFC 2822</a>
E-mail addresses.
mailbot sends an autoresponse only if
the original message has at least one of the specified addresses in any
<code class="literal">To:</code> or <code class="literal">Cc:</code> header.</dd><dt>-d <code>filename</code></dt><dd>
Create a small database, <code>filename</code>,
that keeps track of senders' E-mail addresses,
and prevent duplicate autoresponses going to the same address
(suppress autoresponses going back to the same senders, for subsequent
received messages).
The <code class="option">-d</code> option is only available if
maildrop has GDBM/DB extensions enabled.</dd><dt>-D <code>x</code></dt><dd>
Do not send duplicate autoresponses (see the
<code class="option">-d</code> option) for at least
<code>x</code> days (default: 1 day). The
<code class="option">-d</code> option creates a database of E-mail addresses and
the times an
autoresponse was last mailed to them. Another autoresponse to the same
address will not be mailed until at least the amount of time specified by
the <code class="option">-D</code> option has elapsed.</dd><dt>-s "<code>subject</code>"</dt><dd>
Set the <code class="literal">Subject:</code> header on the autoresponse to
<code>subject</code>.</dd><dt>-n</dt><dd>
	 Show the resulting message, do not send it. Used for debugging
	 purposes.
	 </dd><dt>--feedback-original-envelope-id <code>"&lt;envelopeid&gt;"</code>,
	 --feedback-original-mail-from <code>"&lt;mailfrom&gt;"</code>,
	 --feedback-reporting-mta "<code>dns; hostname"</code>,
	 --feedback-source-ip <code>aaa.bbb.ccc.ddd</code>,
	 --feedback-incidents <code>n</code>,
	 --feedback-authentication-results <code>"results"</code>,
	 --feedback-original-rcpt-to <code>"&lt;rcptto&gt;"</code>,
	 --feedback-reported-domain <code>example.com</code></dt><dd>
	 Optional parameters to include in the feedback report generated by
	 “feedback” and “replyfeedback”.
	 mailbot always adds
	 “Arrival-Date” with the current time, as well as
	 “Version” and “User-Agent”.
	 
	 “--feedback-authentication-results”,
	 “--feedback-original-rcpt-to” and
	 “--feedback-reported-domain” may be specified more
	 than once.
	 </dd><dt>-l <code>maildir</code></dt><dd>
	 Specifies the maildir for the “-T replydraft”
	 option. See “Autoreplies
	 from a maildir folder”, below.
	 </dd></dl></div><div class="refsect2"><a id="idm255212630800" shape="rect"> </a><h3>Autoreplies from a maildir folder</h3>In <code class="filename">.mailfilter:</code><div class="blockquote"><blockquote class="blockquote"><div class="informalexample"><pre class="programlisting" xml:space="preserve">
cc "| mailbot -T replydraft -l './Maildir/.Vacation' \
 -d autoresponsedb \
 -A 'From: info@domain.com' /usr/bin/sendmail -f ''"
to "./Maildir"</pre></div></blockquote></div>
	The <code class="option">-T replydraft</code> reply format takes the content of
	the autoresponse from the most recent message in a maildir.
	The <code class="option">-l</code> option specifies the maildir. The above
	example takes the message from <code class="literal">$HOME/Maildir/.Drafts</code>
	which should be a maildir (with the usual <code class="filename">cur</code>,
	<code class="filename">new</code>, and <code class="filename">tmp</code> subdirectories).
	It would typically get created by Courier-IMAP as a folder named
	“Vacation”.
 
	This makes it possible to install autoreplies via an IMAP client by
	creating a folder named “Vacation”, and copying a message
	into it. The contents of the message become the autoresponse.
 
	If the named maildir does not exist, or is empty,
	mailbot does nothing. If the named maildir has
	more than one message, the most recent message gets used.
 
	The above example uses additional mailbot options
	to suppress duplicate autoresponses, and to set the “From:”
	header on the autoresponse.
 </div></div><div class="refsect1"><a id="idm255212619520" shape="rect"> </a><h2>SEE ALSO</h2>
<a class="ulink" href="maildrop.html" target="_top" shape="rect">maildrop(1)</a>,
<a class="ulink" href="reformail.html" target="_top" shape="rect">reformail(1)</a>,
<a class="ulink" href="reformime.html" target="_top" shape="rect">reformime(1)</a>.
</div></div></body></html>