mailutils-doc 1:2.99.99-1ubuntu2 / usr / share / doc / mailutils-doc / mailutils.html / External-Actions.html

This file is indexed.

/usr/share/doc/mailutils-doc/mailutils.html/External-Actions.html is in mailutils-doc 1:2.99.99-1ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<!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: External Actions</title>

<meta name="description" content="GNU Mailutils Manual: External Actions">
<meta name="keywords" content="GNU Mailutils Manual: External Actions">
<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="Actions.html#Actions" rel="up" title="Actions">
<link href="GNU-Extensions.html#GNU-Extensions" rel="next" title="GNU Extensions">
<link href="Built_002din-Actions.html#Built_002din-Actions" rel="prev" title="Built-in Actions">
<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="External-Actions"></a>
<div class="header">
<p>
Previous: <a href="Built_002din-Actions.html#Built_002din-Actions" accesskey="p" rel="prev">Built-in Actions</a>, Up: <a href="Actions.html#Actions" accesskey="u" rel="up">Actions</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="External-Actions-1"></a>
<h4 class="subsection">4.7.2 External Actions</h4>

<table class="cartouche" border="1"><tr><td>
<div align="center"><strong>Editor&rsquo;s note:</strong>
</div><p>The information in this node may be obsolete or
otherwise inaccurate.  This message will disappear, once this node revised.
</p></td></tr></table>
<p>GNU Mailutils is shipped with a set of external Sieve
actions.  These actions are compiled as loadable modules and must be
required prior to use (see <a href="Require-Statement.html#Require-Statement">Require Statement</a>).
</p>
<dl>
<dt><a name="index-moderator"></a>Action: <em></em> <strong>moderator</strong> <em>[:keep] [:address <var>address</var>(string)]                                 [:source <var>sieve-file</var>(string)]</em></dt>
<dd><br><p>Synopsis:
</p><div class="smallexample">
<pre class="smallexample">require &quot;moderator&quot;
moderator <var>args</var>;
</pre></div>
<br><p>Description:
<a name="index-mailman"></a>
This action is a moderator robot for Mailman-driven mail archives.
A Mailman moderation request is a MIME message consisting of the
following three parts:
</p>
<table>
<thead><tr><th width="20%">N</th><th width="40%">Content-Type</th><th width="40%">Description</th></tr></thead>
<tr><td width="20%">1</td><td width="40%">text/plain</td><td width="40%">Introduction for the human reader.</td></tr>
<tr><td width="20%">2</td><td width="40%">message/rfc822</td><td width="40%">Original submission.</td></tr>
<tr><td width="20%">3</td><td width="40%">message/rfc822</td><td width="40%">Mailman control message.</td></tr>
</table>

<p>Replying to part 3 (keeping the subject intact) instructs Mailman to
discard the original submission.
</p>
<p>Replying to part 3 while adding an &lsquo;Approved:&rsquo; header with the list
password in it approves the submission.
</p>
<p>The <code>moderator</code> action spawns an inferior Sieve machine and
filters the original submission (part 2) through it.  If the inferior
machine marks the message as deleted, the action replies to the
control message, thereby causing the submission to be discarded.  The
&lsquo;<samp>From:</samp>&rsquo; address of the reply can be modified using
<code>:address</code> tag.  After discarding the message, <code>moderator</code>
marks it as deleted, unless it is given <code>:keep</code> tag. 
</p>
<p>The argument of <code>:source</code> tag, if given, specifies the Sieve
source file to be used on the message.  If <code>:tag</code> is not present,
<code>moderator</code> will create and use a copy of the existing Sieve machine.
</p>
<p>The action checks the message structure: it will bail out if the message
does not have exactly 3 MIME parts, or if parts 2 and 3 are not of
&lsquo;<samp>message/rfc822</samp>&rsquo; type.  It is the responsibility of the caller to
make sure the message is actually a valid Mailman moderation request
(see the example below).
</p>
<br><p>Example:
</p><div class="smallexample">
<pre class="smallexample">if allof(header :is &quot;Sender&quot; &quot;mailman-bounces@gnu.org&quot;,
         header :is &quot;X-List-Administrivia&quot; &quot;yes&quot;)
  {
     moderator :source &quot;~/.sieve/mailman.sv&quot;;
  }
</pre></div>
</dd></dl>

<dl>
<dt><a name="index-pipe"></a>Action: <em></em> <strong>pipe</strong> <em>[:envelope] <var>command</var>(string)</em></dt>
<dd><br><p>Synopsis:
</p><div class="smallexample">
<pre class="smallexample">require &quot;pipe&quot;;
if pipe <var>args</var>
  {
     &hellip;
  }
</pre></div>
<br><p>Description:
The <code>pipe</code> action sends executes a command specified by its
argument and sends the entire message to its standard input.  The
<var>command</var> argument supplies the command line.
</p>
<p>The envelope of the message is included, if the <code>:envelope</code> tag
is given. 
</p>
<br><p>Example:
The example below uses the <code>maidag</code> utility
(see <a href="maidag.html#maidag">maidag</a>) to forward the message to user &lsquo;<samp>gray</samp>&rsquo; on
the machine &lsquo;<samp>mail.gnu.org</samp>&rsquo;.
</p>
<div class="smallexample">
<pre class="smallexample">require &quot;pipe&quot;;

pipe &quot;/usr/sbin/maidag --url smtp://gray@mail.gnu.org&quot;
</pre></div>
</dd></dl>

<dl>
<dt><a name="index-vacation"></a>Action: <em></em> <strong>vacation</strong> <em>[:days <var>ndays</var>(number)]                           [:subject <var>subject</var>(string)]                           [:aliases <var>addrlist</var>(string-list)]                           [:addresses <var>noreply-address</var>(string-list)]                           [:reply_regex <var>expr</var>(string)]                           [:reply_prefix <var>prefix</var>(string)]                           <var>reply-text</var>(string)</em></dt>
<dd><br><p>Syntax:
</p><div class="smallexample">
<pre class="smallexample">require &quot;vacation&quot;;
vacation <var>args</var>;
</pre></div>
<br><p>Description:
The <code>vacation</code> action returns a message with <var>reply-text</var> to
the sender.  It is intended to inform the sender that the recipient is
not currently reading his mail.
</p>
<p>If the <code>:subject</code> tag is given, its argument sets the subject of
the message.  Otherwise, the subject is formed by prefixing original
subject with &lsquo;<samp>Re:</samp>&rsquo;, or <var>prefix</var>, given with the
<code>:reply_prefix</code> tag.  Before prefixing, any original prefixes
matching extended regular expression <var>expr</var> (<code>:reply_regex</code>
tag) are stripped from the subject line.  If <code>:reply_regex</code> is not
specified, the default regexp is &lsquo;<samp>^re: *</samp>&rsquo;. 
</p>
<p>The <code>:aliases</code> tag instructs <code>vacation</code> to handle messages
for any address in <var>addrlist</var> in the same manner as those received
for the user&rsquo;s principal email.
</p>
<p>Before processing, <code>vacation</code> compares the sender address with
its <em>address exclusion list</em>.  Elements of this list are extended
case-insensitive regular expressions.  If the sender address matches
any of these expressions, the message will not be replied.  The default
exclusion list is:
</p>
<div class="smallexample">
<pre class="smallexample">    .*-REQUEST@.*
    .*-RELAY@.*
    .*-OWNER@.*
    ^OWNER-.*
    ^postmaster@.*
    ^UUCP@.*
    ^MAILER@.*
    ^MAILER-DAEMON@.*
</pre></div>

<p>New entries can be added to this list using <code>:addresses</code> tag.
</p>
<p>The <code>:days</code> tag sets the <em>reply interval</em>.  A reply is sent to
each sender once in <var>ndays</var> days.  GNU Sieve keeps track of
sender addresses and dates in a DBM file <samp>.vacation</samp> stored in
the user&rsquo;s home directory.  This tag is available only if Mailutils is
compiled with DBM support.
</p></dd></dl>

<hr>
<div class="header">
<p>
Previous: <a href="Built_002din-Actions.html#Built_002din-Actions" accesskey="p" rel="prev">Built-in Actions</a>, Up: <a href="Actions.html#Actions" accesskey="u" rel="up">Actions</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>

APT Browse - Built by Thomas Orozco.