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

Contents of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.12 - (show annotations)
Sat Jul 13 14:11:08 2002 UTC (21 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.11: +11 -2 lines
Added variable to enable direct expunge of marked deleted mail.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26