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

Contents of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (show annotations)
Wed Oct 3 17:42:44 2001 UTC (22 years, 6 months ago) by lefcha
Branch: MAIN
Changes since 1.3: +32 -8 lines
Added URL like encoding of the username and password.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26