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

Contents of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.9 - (show annotations)
Fri Nov 9 15:48:56 2001 UTC (22 years, 4 months ago) by lefcha
Branch: MAIN
CVS Tags: release-0_7
Branch point for: release-0_7-patches
Changes since 1.8: +2 -2 lines
Typo fix.

1 .Dd November 9, 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 or
54 .Sq %
55 characters must be encoded in the above way.
56 .It Cm folder Ar alias folder[,...]
57 Defines folders (mailboxes) and groups them under the
58 .Ar alias
59 name. The mailboxes are associated with the last preceding
60 .Ar account
61 setting. More than one
62 .Ar folder
63 can be declared, separating them with a comma
64 .Sq \&,
65 character. The
66 .Ar alias
67 is comprised by alphanumeric, underscore
68 .Sq _
69 and minus
70 .Sq -
71 characters.
72 .It Cm filter Ar alias [or|and]
73 Starts the declaration of a filter with the name
74 .Ar alias .
75 Optionally the
76 .Ar and
77 or
78 .Ar or
79 flag can be set, in order to set the mode in which the filter's masks
80 will be combined (default is
81 .Ar and
82 mode).
83 .It Cm [mask] Ar [or|and] [not] searchkey
84 A filter entry contains one or more mask entries which are defined with
85 the optional
86 .Ar mask
87 command, the
88 .Ar or
89 or
90 .Ar and
91 flag, the
92 .Ar not
93 flag and the searching criteria, based on which matching of a filter is done.
94 .Pp
95 The
96 .Ar or
97 and
98 .Ar and
99 flags are used to define in which way the current
100 .Ar mask
101 is combined with it's previous
102 .Ar mask .
103 The
104 .Ar not
105 flag is used to revert the functionality of the specified
106 .Ar searchkey .
107 .Pp
108 A
109 .Ar string
110 can be a word, or a phrase enclosed in
111 .Sq \&" .
112 The matching of the
113 .Ar string
114 is case-insensitive.
115 .Pp
116 The available searching criteria are:
117 .Bl -tag -width Ds
118 .It Cm answered
119 Messages that have been answered.
120 .It Cm bcc Ar string
121 Messages that contain the specified
122 .Ar string
123 in the envelope structure's
124 .Dq Bcc
125 field.
126 .It Cm body Ar string
127 Messages that contain the specified
128 .Ar string
129 in the body of the message.
130 .It Cm cc Ar string
131 Messages that contain the specified
132 .Ar string
133 in the envelope structure's
134 .Dq Cc
135 field.
136 .It Cm deleted
137 Messages that are marked for deletion.
138 .It Cm draft
139 Messages that have not completed composition.
140 .It Cm flagged
141 Messages marked for urgent/special attention.
142 .It Cm from Ar string
143 Messages that contain the specified
144 .Ar string
145 in the envelope structure's
146 .Dq From
147 field.
148 .It Cm header Ar fieldname string
149 Messages that have a header with the specified
150 .Ar fieldname ,
151 and contain the specified
152 .Ar string
153 in the field body.
154 .It Cm larger Ar number
155 Messages with size larger than the specified
156 .Ar number
157 in octets (bytes).
158 .It Cm new
159 Messages that have
160 .Qq recently
161 arrived in the mailbox (this session is the
162 first, to have been notified about the messages) and have not been read.
163 .It Cm newer Ar number
164 Messages whose internal date is newer than the specified
165 .Ar number
166 of days.
167 .It Cm old
168 Messages that have not
169 .Qq recently
170 arrived in the mailbox and have not been
171 read.
172 .It Cm older Ar number
173 Messages whose internal date is older than the specified
174 .Ar number
175 of days.
176 .It Cm recent
177 Messages that have
178 .Qq recently
179 arrived in the mailbox (this session is the
180 first, to have been notified about the messages).
181 .It Cm seen
182 Messages that have been read.
183 .It Cm smaller Ar number
184 Messages with size smaller than the specified
185 .Ar number
186 in octets (bytes).
187 .It Cm subject Ar string
188 Messages that contain the specified string in the envelope structure's
189 .Dq Subject
190 field.
191 .It Cm unanswered
192 Messages that have not been answered.
193 .It Cm undeleted
194 Messages that are not marked for deletion.
195 .It Cm undraft
196 Messages that have completed composition.
197 .It Cm unflagged
198 Messages that are not marked for urgent/special attention.
199 .It Cm unseen
200 Messages that have not been read.
201 .El
202 .It Cm action Ar type
203 The
204 .Cm action
205 command is used to end the filter entry started with the
206 .Cm filter
207 command. It assigns an action to be done when the filter is matched.
208 .Pp
209 The available
210 .Ar type
211 of actions are:
212 .Bl -tag -width Ds
213 .It Cm copy Ar mailbox [header,...]
214 Copies the messages to the specified
215 .Ar mailbox .
216 If the
217 .Ar mailbox
218 does not exist, then it is created. Optionally, fetches and displays the
219 .Ar header
220 of the messages that were copied.
221 .It Cm delete Ar [header,...]
222 Deletes the messages. User can also, optionally, define the
223 .Ar header
224 of the deleted messages to be displayed. More than one
225 .Ar header
226 can be declared and fetched, by separating them with a comma
227 .Sq \&,
228 character.
229 .It Cm list Ar [header,...]
230 Just displays the
231 .Ar header
232 of the messages.
233 .It Cm move Ar mailbox [header,...]
234 Moves the messages to the specified
235 .Ar mailbox .
236 If the
237 .Ar mailbox
238 does not exist, then it is created. Optionally, fetches and displays the
239 .Ar header
240 of the messages that were moved.
241 .El
242 .It Cm job Ar filter[,...] folder[,...]
243 This command is used to define which
244 .Ar filter
245 must be applied to which
246 .Ar folder .
247 More than one
248 .Ar filter
249 and/or
250 .Ar folder
251 can be declared, by separating them with a comma
252 .Sq \&,
253 character.
254 .It Cm [set] Ar variable=value
255 Manipulate and set the configuration variables.
256 .El
257 .Sh VARIABLES
258 .Bl -tag -width Ds
259 .It Va headers
260 By enabling this variable, message headers (if requested) are displayed,
261 besides being written to the log file. The argument must be
262 .Dq yes
263 or
264 .Dq no .
265 Default is
266 .Dq no .
267 .It Va logfile
268 Full path to log file where filtering information and possible error
269 messages are saved to. The command line
270 .Fl l
271 option overrides this setting.
272 .El
273 .Sh EXAMPLES
274 See
275 .Pa sample.imapfilterrc .
276 .Sh ENVIROMENT
277 .Bl -tag -width Ds
278 .Ev HOME
279 User's home directory.
280 .El
281 .Sh SEE ALSO
282 .Xr imapfilter 1
283 .Sh AUTHORS
284 .An Lefteris Chatzibarbas Aq lefcha@users.sourceforge.net

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26