/[imapfilter]/imapfilter/imapfilterrc.5
ViewVC logotype

Annotation of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.28 - (hide annotations)
Sun May 25 00:54:04 2003 UTC (20 years, 10 months ago) by lefcha
Branch: MAIN
Changes since 1.27: +1 -1 lines
Typo error fix.

1 lefcha 1.27 .Dd May 20, 2003
2 lefcha 1.2 .Dt IMAPFILTERRC 5
3     .Os
4     .Sh NAME
5     .Nm imapfilterrc
6     .Nd imapfilter configuration file
7 lefcha 1.4 .Sh SYNOPSIS
8     .Pa $HOME/.imapfilterrc
9 lefcha 1.2 .Sh DESCRIPTION
10 lefcha 1.1 The
11 lefcha 1.2 .Nm
12 lefcha 1.5 configuration file consists of a series of commands and variable settings,
13 lefcha 1.6 with each one in a separate line.
14 lefcha 1.2 .Pp
15 lefcha 1.3 Empty lines and lines beginning with the number sign
16     .Sq #
17     character,
18     which
19 lefcha 1.1 are considered comments, are ignored.
20 lefcha 1.2 .Sh COMMANDS
21     .Bl -tag -width Ds
22 lefcha 1.11 .It Cm account Ar alias username[:password]@hostname[:port] [ssl|ssl2|ssl3|tls1]
23     Defines a user account under the name
24     .Ar alias ,
25     using the
26 lefcha 1.2 .Ar username
27 lefcha 1.1 as user identification and
28 lefcha 1.2 .Ar password
29 lefcha 1.1 as the secret word, connecting to the
30 lefcha 1.2 .Ar hostname
31 lefcha 1.1 mail server, at the specified
32 lefcha 1.2 .Ar port
33 lefcha 1.7 (if not specified the default IMAP protocol port (ie. 143 or 993 when SSL/TLS is
34 lefcha 1.9 enabled) is used). SSL/TLS support is enabled with the argument
35 lefcha 1.7 .Ar ssl ,
36     which uses as default the SSL protocol version 2, though this may be changed by
37     specifying a different protocol/version.
38 lefcha 1.4 .Pp
39     The
40 lefcha 1.15 .Ar alias
41     is comprised by alphanumeric, underscore
42     .Sq _
43     and minus
44     .Sq -
45     characters.
46     .Pp
47     The
48 lefcha 1.4 .Ar username
49     and
50     .Ar password
51     strings can be given in a URL encoding like scheme, that is the
52     .Sq %
53 lefcha 1.5 character followed by two hexadecimal digits representing the encoded
54     character's
55     .Xr ascii 7
56     code. Within the
57 lefcha 1.4 .Ar username
58     and
59     .Ar password
60     field, any
61     .Sq \&: ,
62 lefcha 1.10 .Sq @ ,
63     .Sq %
64 lefcha 1.4 or
65 lefcha 1.10 .Sq \
66 lefcha 1.4 characters must be encoded in the above way.
67 lefcha 1.11 .Pp
68     The
69     .Ar password
70     field may be omitted, in which case the user is prompted for one
71     interactively, when
72     .Xr imapfilter 1
73     is run. Also, a
74     .Ar password
75     must not be supplied, if the user intends to specify one using the
76     interactive encrypted passwords' editor of
77     .Xr imapfilter 1 ,
78     in order to store the password securely in the filesystem.
79 lefcha 1.3 .It Cm folder Ar alias folder[,...]
80 lefcha 1.1 Defines folders (mailboxes) and groups them under the
81 lefcha 1.2 .Ar alias
82 lefcha 1.1 name. The mailboxes are associated with the last preceding
83 lefcha 1.2 .Ar account
84 lefcha 1.3 setting. More than one
85     .Ar folder
86     can be declared, separating them with a comma
87 lefcha 1.6 .Sq \&,
88     character. The
89 lefcha 1.3 .Ar alias
90     is comprised by alphanumeric, underscore
91     .Sq _
92     and minus
93     .Sq -
94     characters.
95 lefcha 1.2 .It Cm filter Ar alias [or|and]
96 lefcha 1.1 Starts the declaration of a filter with the name
97 lefcha 1.2 .Ar alias .
98 lefcha 1.1 Optionally the
99 lefcha 1.2 .Ar and
100 lefcha 1.1 or
101 lefcha 1.2 .Ar or
102 lefcha 1.6 flag can be set, in order to set the mode in which the filter's masks
103     will be combined (default is
104 lefcha 1.2 .Ar and
105 lefcha 1.15 mode). The
106     .Ar alias
107     is comprised by alphanumeric, underscore
108     .Sq _
109     and minus
110     .Sq -
111     characters.
112 lefcha 1.2 .It Cm [mask] Ar [or|and] [not] searchkey
113 lefcha 1.6 A filter entry contains one or more mask entries which are defined with
114     the optional
115 lefcha 1.2 .Ar mask
116 lefcha 1.1 command, the
117 lefcha 1.2 .Ar or
118 lefcha 1.1 or
119 lefcha 1.2 .Ar and
120     flag, the
121     .Ar not
122 lefcha 1.1 flag and the searching criteria, based on which matching of a filter is done.
123 lefcha 1.2 .Pp
124 lefcha 1.1 The
125 lefcha 1.2 .Ar or
126 lefcha 1.1 and
127 lefcha 1.2 .Ar and
128 lefcha 1.1 flags are used to define in which way the current
129 lefcha 1.2 .Ar mask
130 lefcha 1.1 is combined with it's previous
131 lefcha 1.2 .Ar mask .
132 lefcha 1.1 The
133 lefcha 1.2 .Ar not
134 lefcha 1.1 flag is used to revert the functionality of the specified
135 lefcha 1.2 .Ar searchkey .
136     .Pp
137 lefcha 1.3 A
138     .Ar string
139     can be a word, or a phrase enclosed in
140     .Sq \&" .
141     The matching of the
142     .Ar string
143     is case-insensitive.
144     .Pp
145 lefcha 1.1 The available searching criteria are:
146 lefcha 1.2 .Bl -tag -width Ds
147     .It Cm answered
148 lefcha 1.1 Messages that have been answered.
149 lefcha 1.2 .It Cm bcc Ar string
150 lefcha 1.1 Messages that contain the specified
151 lefcha 1.2 .Ar string
152     in the envelope structure's
153     .Dq Bcc
154 lefcha 1.3 field.
155 lefcha 1.8 .It Cm body Ar string
156     Messages that contain the specified
157     .Ar string
158     in the body of the message.
159 lefcha 1.2 .It Cm cc Ar string
160 lefcha 1.1 Messages that contain the specified
161 lefcha 1.2 .Ar string
162     in the envelope structure's
163     .Dq Cc
164 lefcha 1.3 field.
165 lefcha 1.2 .It Cm deleted
166 lefcha 1.1 Messages that are marked for deletion.
167 lefcha 1.2 .It Cm draft
168 lefcha 1.1 Messages that have not completed composition.
169 lefcha 1.2 .It Cm flagged
170 lefcha 1.1 Messages marked for urgent/special attention.
171 lefcha 1.2 .It Cm from Ar string
172 lefcha 1.1 Messages that contain the specified
173 lefcha 1.2 .Ar string
174     in the envelope structure's
175     .Dq From
176 lefcha 1.3 field.
177 lefcha 1.2 .It Cm header Ar fieldname string
178 lefcha 1.1 Messages that have a header with the specified
179 lefcha 1.2 .Ar fieldname ,
180 lefcha 1.1 and contain the specified
181 lefcha 1.2 .Ar string
182 lefcha 1.3 in the field body.
183 lefcha 1.2 .It Cm larger Ar number
184 lefcha 1.1 Messages with size larger than the specified
185 lefcha 1.2 .Ar number
186 lefcha 1.1 in octets (bytes).
187 lefcha 1.2 .It Cm new
188     Messages that have
189 lefcha 1.3 .Qq recently
190 lefcha 1.2 arrived in the mailbox (this session is the
191 lefcha 1.1 first, to have been notified about the messages) and have not been read.
192 lefcha 1.7 .It Cm newer Ar number
193     Messages whose internal date is newer than the specified
194     .Ar number
195     of days.
196 lefcha 1.2 .It Cm old
197     Messages that have not
198 lefcha 1.3 .Qq recently
199 lefcha 1.2 arrived in the mailbox and have not been
200 lefcha 1.1 read.
201 lefcha 1.7 .It Cm older Ar number
202     Messages whose internal date is older than the specified
203     .Ar number
204     of days.
205 lefcha 1.2 .It Cm recent
206     Messages that have
207 lefcha 1.3 .Qq recently
208 lefcha 1.2 arrived in the mailbox (this session is the
209 lefcha 1.1 first, to have been notified about the messages).
210 lefcha 1.2 .It Cm seen
211 lefcha 1.1 Messages that have been read.
212 lefcha 1.2 .It Cm smaller Ar number
213 lefcha 1.1 Messages with size smaller than the specified
214 lefcha 1.2 .Ar number
215 lefcha 1.1 in octets (bytes).
216 lefcha 1.2 .It Cm subject Ar string
217 lefcha 1.1 Messages that contain the specified string in the envelope structure's
218 lefcha 1.2 .Dq Subject
219 lefcha 1.3 field.
220 lefcha 1.2 .It Cm unanswered
221 lefcha 1.1 Messages that have not been answered.
222 lefcha 1.2 .It Cm undeleted
223 lefcha 1.1 Messages that are not marked for deletion.
224 lefcha 1.2 .It Cm undraft
225 lefcha 1.1 Messages that have completed composition.
226 lefcha 1.2 .It Cm unflagged
227 lefcha 1.1 Messages that are not marked for urgent/special attention.
228 lefcha 1.2 .It Cm unseen
229 lefcha 1.1 Messages that have not been read.
230 lefcha 1.2 .El
231     .It Cm action Ar type
232 lefcha 1.1 The
233 lefcha 1.2 .Cm action
234 lefcha 1.1 command is used to end the filter entry started with the
235 lefcha 1.6 .Cm filter
236     command. It assigns an action to be done when the filter is matched.
237 lefcha 1.2 .Pp
238 lefcha 1.1 The available
239 lefcha 1.2 .Ar type
240 lefcha 1.1 of actions are:
241 lefcha 1.2 .Bl -tag -width Ds
242 lefcha 1.5 .It Cm copy Ar mailbox [header,...]
243     Copies the messages to the specified
244     .Ar mailbox .
245     If the
246     .Ar mailbox
247 lefcha 1.25 does not exist, then it is created.
248     .Pp
249     Date and time conversion specifiers may be used in the name of the
250     .Ar mailbox .
251     Specifically, a conversion specification consists of a percent sign
252     .Sq %
253     and another character for the current local date and time of the system,
254     and an at sign
255     .Sq @
256     and another character for the date and time of the message processed. The
257     characters used in the conversion specification are described in
258 lefcha 1.21 .Xr strftime 3 .
259 lefcha 1.25 .Pp
260 lefcha 1.26 The default variable
261     .Dq $_
262     may be used in the name of the
263     .Ar mailbox ,
264     which aliases to the name of the mailbox in which the filter is now applied.
265     .Pp
266 lefcha 1.21 Optionally, fetches and displays the
267 lefcha 1.5 .Ar header
268     of the messages that were copied.
269 lefcha 1.3 .It Cm delete Ar [header,...]
270 lefcha 1.1 Deletes the messages. User can also, optionally, define the
271 lefcha 1.3 .Ar header
272     of the deleted messages to be displayed. More than one
273     .Ar header
274     can be declared and fetched, by separating them with a comma
275     .Sq \&,
276     character.
277 lefcha 1.13 .It Cm flag Ar mode flag[,...] [header,...]
278     Sets the flags of the messages. The
279     .Ar mode
280     can be
281     .Ar replace ,
282     .Ar add ,
283     or
284     .Ar remove .
285     The
286     .Ar flag
287     can be
288     .Ar none ,
289     .Ar seen ,
290     .Ar answered ,
291     .Ar flagged ,
292     .Ar deleted ,
293     or
294     .Ar draft .
295     Optionally, the
296     .Ar header
297     of the messages is displayed.
298 lefcha 1.5 .It Cm list Ar [header,...]
299     Just displays the
300 lefcha 1.3 .Ar header
301 lefcha 1.5 of the messages.
302 lefcha 1.3 .It Cm move Ar mailbox [header,...]
303 lefcha 1.1 Moves the messages to the specified
304 lefcha 1.2 .Ar mailbox .
305 lefcha 1.1 If the
306 lefcha 1.2 .Ar mailbox
307 lefcha 1.25 does not exist, then it is created.
308 lefcha 1.26 Date and time conversion specifiers and the default variable
309     may be used in the name of the
310 lefcha 1.25 .Ar mailbox
311     (see the
312     .Ar copy
313     action for more information). Optionally, fetches and displays the
314 lefcha 1.3 .Ar header
315 lefcha 1.2 of the messages that were moved.
316 lefcha 1.13 .It Cm rcopy Ar account mailbox [header,...]
317 lefcha 1.11 Copies the messages to the specified
318     .Ar mailbox
319     residing on a specific
320     .Ar account .
321 lefcha 1.26 Date and time conversion specifiers and the default variable
322     may be used in the name of the
323 lefcha 1.25 .Ar mailbox
324     (see the
325     .Ar copy
326     action for more information). Optionally, displays the
327 lefcha 1.13 .Ar header
328     of the messages.
329 lefcha 1.17 Unlike all other
330     .Ar type
331     of actions, this requires that the message is downloaded from the source
332     mail server and then uploaded to the target mail server.
333 lefcha 1.15 .It Cm rmove Ar account mailbox [header,...]
334 lefcha 1.11 Moves the messages to the specified
335     .Ar mailbox
336     residing on a specific
337     .Ar account .
338 lefcha 1.26 Date and time conversion specifiers and the default variable
339     may be used in the name of the
340 lefcha 1.25 .Ar mailbox
341     (see the
342     .Ar copy
343     action for more information). Optionally, displays the
344 lefcha 1.13 .Ar header
345     of the messages.
346 lefcha 1.17 Unlike all other
347     .Ar type
348     of actions, this requires that the message is downloaded from the source
349     mail server and then uploaded to the target mail server.
350 lefcha 1.2 .El
351 lefcha 1.3 .It Cm job Ar filter[,...] folder[,...]
352 lefcha 1.1 This command is used to define which
353 lefcha 1.3 .Ar filter
354 lefcha 1.1 must be applied to which
355 lefcha 1.3 .Ar folder .
356     More than one
357     .Ar filter
358     and/or
359     .Ar folder
360     can be declared, by separating them with a comma
361     .Sq \&,
362     character.
363 lefcha 1.7 .It Cm [set] Ar variable=value
364     Manipulate and set the configuration variables.
365 lefcha 1.3 .El
366 lefcha 1.4 .Sh VARIABLES
367 lefcha 1.3 .Bl -tag -width Ds
368 lefcha 1.24 .It Va charset
369     Indicates to the server the character set of the strings that appear in the
370     search criteria. It takes a string as an argument.
371 lefcha 1.11 .It Va daemon
372 lefcha 1.24 Enables the daemon mode of
373 lefcha 1.11 .Xr imapfilter 1 .
374     It takes a numeric
375     argument, the polling interval in seconds.
376 lefcha 1.18 .It Va errors
377     By enabling this option any error messages during program's execution get
378     appended to the log file, besides being written to stderr. The argument
379     must be
380     .Dq yes
381     or
382     .Dq no .
383     Default is
384     .Dq no.
385 lefcha 1.12 .It Va expunge
386     Normally messages are marked for deletion and are actually deleted when the
387     mailbox is closed. When this option is enabled, messages are expunged after
388     they are marked deleted. The argument must be
389     .Dq yes
390     or
391     .Dq no .
392     Default is
393     .Dq no .
394 lefcha 1.4 .It Va headers
395 lefcha 1.3 By enabling this variable, message headers (if requested) are displayed,
396 lefcha 1.4 besides being written to the log file. The argument must be
397 lefcha 1.3 .Dq yes
398     or
399     .Dq no .
400     Default is
401     .Dq no .
402 lefcha 1.5 .It Va logfile
403     Full path to log file where filtering information and possible error
404     messages are saved to. The command line
405     .Fl l
406     option overrides this setting.
407 lefcha 1.10 .It Va namespace
408     When enabled, the program gets the namespace of the user's personal mailboxes,
409     and applies automatically the prefix and hierarchy delimiter to any mailboxes
410 lefcha 1.22 residing on the mail server; the user must use the
411     .Sq /
412     character as the delimiter and
413     .Dq
414 lefcha 1.23 (ie. nothing) as the prefix, regardless the folder format of the mail server.
415 lefcha 1.22 This must be disabled, if the user wants to manually specify mailbox names
416     (eg. because they are not part of the user's personal namespace
417     mailboxes), in which case he/she should apply the prefix and hierarchy
418     delimiter that is used by the mail server. The argument must be
419 lefcha 1.10 .Dq yes
420     or
421     .Dq no .
422     Default is
423 lefcha 1.12 .Dq yes .
424 lefcha 1.14 .It Va subscribe
425     By enabling this variable newly created mailboxes get also subscribed; they
426     are set
427     .Dq active
428     in order for IMAP clients to recognize them. The argument must be
429     .Dq yes
430     or
431     .Dq no .
432     Default is
433     .Dq no .
434 lefcha 1.10 .It Va timeout
435     The time in seconds, for the program to wait for a mail server's response.
436     If not set, then the client will block indefinitely.
437 lefcha 1.2 .El
438     .Sh EXAMPLES
439 lefcha 1.1 See
440 lefcha 1.2 .Pa sample.imapfilterrc .
441 lefcha 1.28 .Sh ENVIRONMENT
442 lefcha 1.4 .Bl -tag -width Ds
443 lefcha 1.11 .It Ev HOME
444 lefcha 1.4 User's home directory.
445     .El
446 lefcha 1.2 .Sh SEE ALSO
447     .Xr imapfilter 1
448 lefcha 1.4 .Sh AUTHORS
449 lefcha 1.11 .An Lefteris Chatzibarbas Aq lefcha@hellug.gr

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26