1 |
.Dd December 4, 2001 |
2 |
.Dt IMAPFILTERRC 5 |
3 |
.Os |
4 |
.Sh NAME |
5 |
.Nm imapfilterrc |
6 |
.Nd imapfilter configuration file |
7 |
.Sh SYNOPSIS |
8 |
.Pa $HOME/.imapfilterrc |
9 |
.Sh DESCRIPTION |
10 |
The |
11 |
.Nm |
12 |
configuration file consists of a series of commands and variable settings, |
13 |
with each one in a separate line. |
14 |
.Pp |
15 |
Empty lines and lines beginning with the number sign |
16 |
.Sq # |
17 |
character, |
18 |
which |
19 |
are considered comments, are ignored. |
20 |
.Sh COMMANDS |
21 |
.Bl -tag -width Ds |
22 |
.It Cm account Ar username:password@hostname[:port] [ssl|ssl2|ssl3|tls1] |
23 |
Defines a user account, using the |
24 |
.Ar username |
25 |
as user identification and |
26 |
.Ar password |
27 |
as the secret word, connecting to the |
28 |
.Ar hostname |
29 |
mail server, at the specified |
30 |
.Ar port |
31 |
(if not specified the default IMAP protocol port (ie. 143 or 993 when SSL/TLS is |
32 |
enabled) is used). SSL/TLS support is enabled with the argument |
33 |
.Ar ssl , |
34 |
which uses as default the SSL protocol version 2, though this may be changed by |
35 |
specifying a different protocol/version. |
36 |
.Pp |
37 |
The |
38 |
.Ar username |
39 |
and |
40 |
.Ar password |
41 |
strings can be given in a URL encoding like scheme, that is the |
42 |
.Sq % |
43 |
character followed by two hexadecimal digits representing the encoded |
44 |
character's |
45 |
.Xr ascii 7 |
46 |
code. Within the |
47 |
.Ar username |
48 |
and |
49 |
.Ar password |
50 |
field, any |
51 |
.Sq \&: , |
52 |
.Sq @ , |
53 |
.Sq % |
54 |
or |
55 |
.Sq \ |
56 |
characters must be encoded in the above way. |
57 |
.It Cm folder Ar alias folder[,...] |
58 |
Defines folders (mailboxes) and groups them under the |
59 |
.Ar alias |
60 |
name. The mailboxes are associated with the last preceding |
61 |
.Ar account |
62 |
setting. More than one |
63 |
.Ar folder |
64 |
can be declared, separating them with a comma |
65 |
.Sq \&, |
66 |
character. The |
67 |
.Ar alias |
68 |
is comprised by alphanumeric, underscore |
69 |
.Sq _ |
70 |
and minus |
71 |
.Sq - |
72 |
characters. |
73 |
.It Cm filter Ar alias [or|and] |
74 |
Starts the declaration of a filter with the name |
75 |
.Ar alias . |
76 |
Optionally the |
77 |
.Ar and |
78 |
or |
79 |
.Ar or |
80 |
flag can be set, in order to set the mode in which the filter's masks |
81 |
will be combined (default is |
82 |
.Ar and |
83 |
mode). |
84 |
.It Cm [mask] Ar [or|and] [not] searchkey |
85 |
A filter entry contains one or more mask entries which are defined with |
86 |
the optional |
87 |
.Ar mask |
88 |
command, the |
89 |
.Ar or |
90 |
or |
91 |
.Ar and |
92 |
flag, the |
93 |
.Ar not |
94 |
flag and the searching criteria, based on which matching of a filter is done. |
95 |
.Pp |
96 |
The |
97 |
.Ar or |
98 |
and |
99 |
.Ar and |
100 |
flags are used to define in which way the current |
101 |
.Ar mask |
102 |
is combined with it's previous |
103 |
.Ar mask . |
104 |
The |
105 |
.Ar not |
106 |
flag is used to revert the functionality of the specified |
107 |
.Ar searchkey . |
108 |
.Pp |
109 |
A |
110 |
.Ar string |
111 |
can be a word, or a phrase enclosed in |
112 |
.Sq \&" . |
113 |
The matching of the |
114 |
.Ar string |
115 |
is case-insensitive. |
116 |
.Pp |
117 |
The available searching criteria are: |
118 |
.Bl -tag -width Ds |
119 |
.It Cm answered |
120 |
Messages that have been answered. |
121 |
.It Cm bcc Ar string |
122 |
Messages that contain the specified |
123 |
.Ar string |
124 |
in the envelope structure's |
125 |
.Dq Bcc |
126 |
field. |
127 |
.It Cm body Ar string |
128 |
Messages that contain the specified |
129 |
.Ar string |
130 |
in the body of the message. |
131 |
.It Cm cc Ar string |
132 |
Messages that contain the specified |
133 |
.Ar string |
134 |
in the envelope structure's |
135 |
.Dq Cc |
136 |
field. |
137 |
.It Cm deleted |
138 |
Messages that are marked for deletion. |
139 |
.It Cm draft |
140 |
Messages that have not completed composition. |
141 |
.It Cm flagged |
142 |
Messages marked for urgent/special attention. |
143 |
.It Cm from Ar string |
144 |
Messages that contain the specified |
145 |
.Ar string |
146 |
in the envelope structure's |
147 |
.Dq From |
148 |
field. |
149 |
.It Cm header Ar fieldname string |
150 |
Messages that have a header with the specified |
151 |
.Ar fieldname , |
152 |
and contain the specified |
153 |
.Ar string |
154 |
in the field body. |
155 |
.It Cm larger Ar number |
156 |
Messages with size larger than the specified |
157 |
.Ar number |
158 |
in octets (bytes). |
159 |
.It Cm new |
160 |
Messages that have |
161 |
.Qq recently |
162 |
arrived in the mailbox (this session is the |
163 |
first, to have been notified about the messages) and have not been read. |
164 |
.It Cm newer Ar number |
165 |
Messages whose internal date is newer than the specified |
166 |
.Ar number |
167 |
of days. |
168 |
.It Cm old |
169 |
Messages that have not |
170 |
.Qq recently |
171 |
arrived in the mailbox and have not been |
172 |
read. |
173 |
.It Cm older Ar number |
174 |
Messages whose internal date is older than the specified |
175 |
.Ar number |
176 |
of days. |
177 |
.It Cm recent |
178 |
Messages that have |
179 |
.Qq recently |
180 |
arrived in the mailbox (this session is the |
181 |
first, to have been notified about the messages). |
182 |
.It Cm seen |
183 |
Messages that have been read. |
184 |
.It Cm smaller Ar number |
185 |
Messages with size smaller than the specified |
186 |
.Ar number |
187 |
in octets (bytes). |
188 |
.It Cm subject Ar string |
189 |
Messages that contain the specified string in the envelope structure's |
190 |
.Dq Subject |
191 |
field. |
192 |
.It Cm unanswered |
193 |
Messages that have not been answered. |
194 |
.It Cm undeleted |
195 |
Messages that are not marked for deletion. |
196 |
.It Cm undraft |
197 |
Messages that have completed composition. |
198 |
.It Cm unflagged |
199 |
Messages that are not marked for urgent/special attention. |
200 |
.It Cm unseen |
201 |
Messages that have not been read. |
202 |
.El |
203 |
.It Cm action Ar type |
204 |
The |
205 |
.Cm action |
206 |
command is used to end the filter entry started with the |
207 |
.Cm filter |
208 |
command. It assigns an action to be done when the filter is matched. |
209 |
.Pp |
210 |
The available |
211 |
.Ar type |
212 |
of actions are: |
213 |
.Bl -tag -width Ds |
214 |
.It Cm copy Ar mailbox [header,...] |
215 |
Copies the messages to the specified |
216 |
.Ar mailbox . |
217 |
If the |
218 |
.Ar mailbox |
219 |
does not exist, then it is created. Optionally, fetches and displays the |
220 |
.Ar header |
221 |
of the messages that were copied. |
222 |
.It Cm delete Ar [header,...] |
223 |
Deletes the messages. User can also, optionally, define the |
224 |
.Ar header |
225 |
of the deleted messages to be displayed. More than one |
226 |
.Ar header |
227 |
can be declared and fetched, by separating them with a comma |
228 |
.Sq \&, |
229 |
character. |
230 |
.It Cm list Ar [header,...] |
231 |
Just displays the |
232 |
.Ar header |
233 |
of the messages. |
234 |
.It Cm move Ar mailbox [header,...] |
235 |
Moves the messages to the specified |
236 |
.Ar mailbox . |
237 |
If the |
238 |
.Ar mailbox |
239 |
does not exist, then it is created. Optionally, fetches and displays the |
240 |
.Ar header |
241 |
of the messages that were moved. |
242 |
.El |
243 |
.It Cm job Ar filter[,...] folder[,...] |
244 |
This command is used to define which |
245 |
.Ar filter |
246 |
must be applied to which |
247 |
.Ar folder . |
248 |
More than one |
249 |
.Ar filter |
250 |
and/or |
251 |
.Ar folder |
252 |
can be declared, by separating them with a comma |
253 |
.Sq \&, |
254 |
character. |
255 |
.It Cm [set] Ar variable=value |
256 |
Manipulate and set the configuration variables. |
257 |
.El |
258 |
.Sh VARIABLES |
259 |
.Bl -tag -width Ds |
260 |
.It Va headers |
261 |
By enabling this variable, message headers (if requested) are displayed, |
262 |
besides being written to the log file. The argument must be |
263 |
.Dq yes |
264 |
or |
265 |
.Dq no . |
266 |
Default is |
267 |
.Dq no . |
268 |
.It Va logfile |
269 |
Full path to log file where filtering information and possible error |
270 |
messages are saved to. The command line |
271 |
.Fl l |
272 |
option overrides this setting. |
273 |
.It Va namespace |
274 |
When enabled, the program gets the namespace of the user's personal mailboxes, |
275 |
and applies automatically the prefix and hierarchy delimiter to any mailboxes |
276 |
residing on the mail server. This must be disabled in cases where the user |
277 |
wants to manually specify mailbox names (eg. because they are not part of the |
278 |
user's personal namespace mailboxes). The argument must be |
279 |
.Dq yes |
280 |
or |
281 |
.Dq no . |
282 |
Default is |
283 |
.Dq yes. |
284 |
.It Va timeout |
285 |
The time in seconds, for the program to wait for a mail server's response. |
286 |
If not set, then the client will block indefinitely. |
287 |
.El |
288 |
.Sh EXAMPLES |
289 |
See |
290 |
.Pa sample.imapfilterrc . |
291 |
.Sh ENVIROMENT |
292 |
.Bl -tag -width Ds |
293 |
.Ev HOME |
294 |
User's home directory. |
295 |
.El |
296 |
.Sh SEE ALSO |
297 |
.Xr imapfilter 1 |
298 |
.Sh AUTHORS |
299 |
.An Lefteris Chatzibarbas Aq lefcha@users.sourceforge.net |