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

Annotation of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.32.2.1 - (hide annotations)
Sun Nov 23 22:52:54 2003 UTC (20 years, 4 months ago) by lefcha
Branch: release-0_9-patches
Changes since 1.32: +9 -1 lines
dded "peek" option that causes use of BODY or BODY.PEEK when doing FETCH.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26