4
# $Id: filtedit.html 391 2007-01-25 03:53:59Z mikes@u.washington.edu $
5
# ========================================================================
6
# Copyright 2006 University of Washington
8
# Licensed under the Apache License, Version 2.0 (the "License");
9
# you may not use this file except in compliance with the License.
10
# You may obtain a copy of the License at
12
# http://www.apache.org/licenses/LICENSE-2.0
14
# ========================================================================
18
<font size="+2"><b>Filter Configuration</b></font>
19
<p>This Filter Configuration screen is where you can add new filters
20
or modify existing ones.</p>
22
<p>In order to determine whether or not a message matches a filter, the
23
message is compared with the Filter's Pattern. Once a filter match is
24
found for a particular message, there are some actions which may be
27
<p>NOTE: When you set up a Pattern to delete messages, it is recommended
28
that you test the Pattern first with a "Move" folder in case unintended
29
matches occur. Messages that are deleted will be removed from the folder
30
and may be unrecoverable.</p>
33
<li><a href="#patterns"><b>Filter Patterns</b></a>
34
</li><li><a href="#actions"><b>Filter Actions</b></a>
35
</li><li><a href="#examples"><b>Examples</b></a>
38
<a name="patterns"><b>Filter Patterns</b></a><br>
41
<li><b>Nickname:</b><br>
42
This is a nickname to help you. You should have a different nickname for
43
each filtering rule you define. The nickname will be used in the Message
44
Filtering screen to allow you to pick a rule to edit.<p></p>
46
</li><li><b>To:</b><br>
47
Any text you enter as the "To pattern" will be compared to the recipients
48
from the To: line of messages when WebPine
49
opens folders. When the text you entered matches all or part of the To:
50
line of a message, then the Filter Action you
51
have specified will be carried out. (Any other non-blank parts of the
52
Pattern must match, too.)
54
<p>You may enter a complete email address, part of an address, or a
55
comma-separated list of addresses or partial
56
addresses. For example:</p>
58
<pre> To: = friend@public.com
60
To: = admin@public.com, admin@msn.com, fool@motleyfool.com
63
<p>Each of those are valid "To patterns".</p>
65
<p>Messages match those patterns if any of the addresses in the To: line
66
of the message contains the pattern. If the pattern is a comma-separated
67
list of patterns (like the last example above) then it is a match if any
68
of the patterns in the list match any of the addresses in the To: line.
69
(It is not possible to specify two addresses which must BOTH be present
70
for a match. It is only possible to specify that EITHER address1 OR
71
address2 must be present. That is exactly what the comma-separated list
74
<p>Some messages may be "bounced" to you, and will have a "Resent-To:"
75
header line. If the message contains a Resent-To: line, WebPine will look
76
for matches to your "To: patterns" there, and NOT in the original To:
79
</li><li><b>From:</b><br>
80
This is just like the "To pattern" except that it is compared with the
81
address in the From: line of the message instead of the addresses from the
82
To: line. See the help for the To pattern for more information on header
85
</li><li><b>Sender:</b><br>
86
This is just like the "To pattern" except that it is compared with the
87
address from the Sender: line of the message
88
instead of the addresses from the To: line. See the help for the To
89
pattern for more information on header patterns.<p></p>
92
This is just like the "To pattern" except that it is compared with the
93
addresses from the Cc: line of the message instead of the addresses from
94
the To: line. See the help for the To pattern for more information on
95
header patterns.<p></p>
98
<li><b>Recipient:</b><br>
99
This is just like the "To pattern" except that it is compared with the
100
addresses from both the To: line and the Cc:
101
line of the message instead of just the addresses from the To: line. In
102
other words, it is considered a match if the
103
pattern matches EITHER an address in the To: line OR an address in the Cc:
104
line. (Notice that defining the Recipient
105
pattern does not have the same effect as defining both the To and Cc
106
patterns. Recipient is To OR Cc; not To AND Cc.
107
It is equivalent to having two different rules; one with a To pattern and
108
the other with the same Cc pattern.)<p></p>
111
</li><li><b>Participants:</b><br>
112
This is just like the "To pattern" except that it is compared with the
113
addresses from the From: line, the To: line, and the Cc: line of the
114
message instead of just the addresses from the To: line. In other words,
115
it is considered a match if the pattern matches EITHER an address in the
116
From: line, OR an address in the To: line, OR an address in the Cc: line.
117
(Notice that defining the Participant pattern does not have the same
118
effect as defining all of the From, To, and Cc patterns. Participant is
119
From OR To OR Cc; not From AND To AND Cc. It is equivalent to having
120
three different rules; one with a From pattern, another with the same To
121
pattern, and a third with the same Cc pattern.)<p></p>
124
</li><li><b>Newsgroups:</b><br>
125
If this pattern is non-blank, then for this rule to be considered a match,
126
at least one of the newsgroups from the
127
Newsgroups line of the message must match this pattern. If this pattern is
128
a comma-separated list of patterns, then at
129
least one of the newsgroups must match at least one of the patterns. (Any
130
other non-blank parts of the Pattern must
133
</li><li><b>Subject:</b><br>
134
This is similar to the other parts of the Pattern. It is compared with the
135
contents from the Subject of the message.
137
<p>If you enter non-ASCII characters in this field then the search will be
138
done using the character set you have defined with the "character-set"
139
configuration variable. (The truly sophisticated may use an alternate
140
character set for a search by entering the MIME encoding of the header
144
</li><li><b>All Text:</b><br>
145
This is similar to the header patterns. Instead of comparing with text in
146
a particular header field it is compared with all of the text in the
147
message header and body.
149
<p>If you enter non-ASCII characters in this field then the search will be
150
done using the character set you have defined
151
with the "character-set" configuration variable. (The truly sophisticated
152
may use an alternate character set for a
153
search by entering the MIME encoding of the header string here.)</p>
155
<p>It is possible that you may notice degraded performance when using
156
AllText Patterns.</p>
159
</li><li><b>Message is New</b><br>
160
This part of the Pattern may have one of three possible values. The
161
default value is "Don't care", which matches any message. The other two
162
values are "Yes", which means the message must be "New" in order to be a
163
match; or "No", which means the message must not be "New" in order to be a
164
match. "New" is the same as Unseen and not "New" is the same as Seen.<p></p>
166
</li><li><b>Message is Deleted</b><br>
167
This part of the Pattern may have one of three possible values. The
168
default value is "Don't care", which matches any message. The other two
169
values are "Yes", which means the message must be marked "Deleted" in
170
order to be a match; or "No", which means the message must not be marked
171
"Deleted" in order to be a match.
173
<p>If you are thinking of using this part of the Pattern as a way to
174
prevent messages from being filtered more than once in a Filter Pattern,
175
take a look at the Filter Option "move-only-if-not-deleted" instead. It
176
should work better than using this field since it will hide the filtered
177
messages even if they are already Deleted. That option is at the bottom of
178
the Filter configuration screen.</p>
180
</li><li><b>Message is Important</b><br>
181
This part of the Pattern may have one of three possible values. The
182
default value is "Don't care", which matches any message. The other two
183
values are "Yes", which means the message must be flagged "Important" in
184
order to be a match; or "No", which means the message must not be flagged
185
"Important" in order to be a match.<p></p>
187
</li><li><b>Message is Answered</b><br>
188
This part of the Pattern may have one of three possible values. The
189
default value is "Don't care", which matches any message. The other two
190
values are "Yes", which means the message must be marked "Answered" in
191
order to be a match; or "No", which means the message must not be marked
192
"Answered" in order to be a match.
195
<a name="actions"><b>Filter Actions</b></a><br>
196
The Filter Action specifies the action to be taken when the Pattern is a
197
match. It may be either <b>Delete</b> or <b>Move</b>
199
<p>If you set it to "Move", then provide the name of the folder to which
200
the matching message should be moved in the corresponding text box. You
201
may type a list of folders separated by commas, in which case the message
202
will be copied to all of the folders in the list before it is deleted.</p>
204
<b>Move only if not deleted</b><br> If you set this option then a message
205
will be moved into the specified folder only if it is not marked for
206
deletion. This is useful if you have multiple Pine or WebPine sessions
207
running simultaneously and you don't want messages to be filtered into a
208
folder more than once. It is also useful if you want to filter only the
209
"undeleted" messages in a newsgroup into a folder. This method is not
210
foolproof. There may be cases where a message gets marked deleted and so
211
it is never filtered into the folder. For example, if you deleted it in
212
another Pine or WebPine session or another mail program that didn't use
213
the filtering rule.<br>
215
This option has no effect if the Filter Action is not set to Move.<p></p>
217
<a name="examples"><b>Examples</b></a><br>
218
To create a filter to move all incoming messages from
219
"sue@travelworld.com" to your "Vacation" folder, add the following to the
220
Filter Configuration screen:<br>
221
<b>Nickname:</b> Travelworld<br>
222
<b>From:</b> sue@travelworld.com<br>
223
<b>Move filter action:</b>Vacation<br>
225
Click <b>Save</b> to add the filter.<br>
227
<p>To create a filter to delete all incoming messages that contain the
228
text "Make Money fast!" in the subject line, add the following to your
229
Filter Configuration screen:<br>
230
<b>Nickname:</b> Make Money<br>
231
<b>Subject:</b> Make Money Fast!<br>
232
<b>Delete:</b> (Click next to this option)<br>
233
Reminder: It is a very good idea to test this with the "Move to Folder"
234
option in case unintended matches occur.<br>
236
Click <b>Save</b> to add the filter.
b'\\ No newline at end of file'
added
removed
web/cgi/alpine/help/filtedit.html
