1 |
lefcha |
1.1 |
.TH IMAPFILTERRC 5 "11 September 2001" "CVS" "File formats and conventions" |
2 |
|
|
.SH NAME |
3 |
|
|
imapfilterrc - imapfilter configuration file |
4 |
|
|
.SH DESCRIPTION |
5 |
|
|
The |
6 |
|
|
.B imapfilter |
7 |
|
|
configuration file consists of a series of commands, every one of which must |
8 |
|
|
be contained in a separate line. |
9 |
|
|
.PP |
10 |
|
|
Empty lines and lines beginning with the number sign character '#', which |
11 |
|
|
are considered comments, are ignored. |
12 |
|
|
.SH COMMANDS |
13 |
|
|
.TP |
14 |
|
|
.B account username:password@hostname[:port] |
15 |
|
|
Defines a user account, using the |
16 |
|
|
.B username |
17 |
|
|
as user identification and |
18 |
|
|
.B password |
19 |
|
|
as the secret word, connecting to the |
20 |
|
|
.B hostname |
21 |
|
|
mail server, at the specified |
22 |
|
|
.B port |
23 |
|
|
(if not specified the default IMAP protocol port (ie. 143) is used). |
24 |
|
|
.TP |
25 |
|
|
.B folder alias folder1[,folder2] [...] |
26 |
|
|
Defines folders (mailboxes) and groups them under the |
27 |
|
|
.B alias |
28 |
|
|
name. The mailboxes are associated with the last preceding |
29 |
|
|
.B account |
30 |
|
|
setting. |
31 |
|
|
.TP |
32 |
|
|
.B filter alias [or|and] |
33 |
|
|
Starts the declaration of a filter with the name |
34 |
|
|
.BR alias . |
35 |
|
|
Optionally the |
36 |
|
|
.B and |
37 |
|
|
or |
38 |
|
|
.B or |
39 |
|
|
flag can be set, in order to set the mode in which filter's masks will be |
40 |
|
|
combined (default is |
41 |
|
|
.B and |
42 |
|
|
mode). |
43 |
|
|
.TP |
44 |
|
|
.B [mask] [or|and] [not] searchkey |
45 |
|
|
A |
46 |
|
|
.B filter |
47 |
|
|
entry contains one or more mask entries which are defined with the optional |
48 |
|
|
.B mask |
49 |
|
|
command, the |
50 |
|
|
.B or |
51 |
|
|
or |
52 |
|
|
.B and flag, the |
53 |
|
|
.B not |
54 |
|
|
flag and the searching criteria, based on which matching of a filter is done. |
55 |
|
|
|
56 |
|
|
The |
57 |
|
|
.B or |
58 |
|
|
and |
59 |
|
|
.B and |
60 |
|
|
flags are used to define in which way the current |
61 |
|
|
.B mask |
62 |
|
|
is combined with it's previous |
63 |
|
|
.BR mask . |
64 |
|
|
The |
65 |
|
|
.B not |
66 |
|
|
flag is used to revert the functionality of the specified |
67 |
|
|
.BR searchkey . |
68 |
|
|
|
69 |
|
|
The available searching criteria are: |
70 |
|
|
.RS |
71 |
|
|
.TP |
72 |
|
|
.B all |
73 |
|
|
All messages in the mailbox. |
74 |
|
|
.TP |
75 |
|
|
.B answered |
76 |
|
|
Messages that have been answered. |
77 |
|
|
.TP |
78 |
|
|
.B bcc string |
79 |
|
|
Messages that contain the specified |
80 |
|
|
.B string |
81 |
|
|
in the envelope structure's "Bcc" field. The matching of the |
82 |
|
|
.B string |
83 |
|
|
is case-insesitive. |
84 |
|
|
.TP |
85 |
|
|
.B cc string |
86 |
|
|
Messages that contain the specified |
87 |
|
|
.B string |
88 |
|
|
in the envelope structure's "Cc" field. The matching of the |
89 |
|
|
.B string |
90 |
|
|
is case-insesitive. |
91 |
|
|
.TP |
92 |
|
|
.B deleted |
93 |
|
|
Messages that are marked for deletion. |
94 |
|
|
.TP |
95 |
|
|
.B draft |
96 |
|
|
Messages that have not completed composition. |
97 |
|
|
.TP |
98 |
|
|
.B flagged |
99 |
|
|
Messages marked for urgent/special attention. |
100 |
|
|
.TP |
101 |
|
|
.B from string |
102 |
|
|
Messages that contain the specified |
103 |
|
|
.B string |
104 |
|
|
in the envelope structure's "From" field. The matching of the |
105 |
|
|
.B string |
106 |
|
|
is case-insensitive. |
107 |
|
|
.TP |
108 |
|
|
.B header fieldname string |
109 |
|
|
Messages that have a header with the specified |
110 |
|
|
.BR fieldname , |
111 |
|
|
and contain the specified |
112 |
|
|
.B string |
113 |
|
|
in the field body. The matching of the |
114 |
|
|
.B string |
115 |
|
|
is case-insesitive. |
116 |
|
|
.TP |
117 |
|
|
.B larger number |
118 |
|
|
Messages with size larger than the specified |
119 |
|
|
.B number |
120 |
|
|
in octets (bytes). |
121 |
|
|
.TP |
122 |
|
|
.B new |
123 |
|
|
Messages that have "recently" arrived in the mailbox (this session is the |
124 |
|
|
first, to have been notified about the messages) and have not been read. |
125 |
|
|
.TP |
126 |
|
|
.B old |
127 |
|
|
Messages that have not "recently" arrived in the mailbox and have not been |
128 |
|
|
read. |
129 |
|
|
.TP |
130 |
|
|
.B recent |
131 |
|
|
Messages that have "recently" arrived in the mailbox (this session is the |
132 |
|
|
first, to have been notified about the messages). |
133 |
|
|
.TP |
134 |
|
|
.B seen |
135 |
|
|
Messages that have been read. |
136 |
|
|
.TP |
137 |
|
|
.B smaller number |
138 |
|
|
Messages with size smaller than the specified |
139 |
|
|
.B number |
140 |
|
|
in octets (bytes). |
141 |
|
|
.TP |
142 |
|
|
.B subject string |
143 |
|
|
Messages that contain the specified string in the envelope structure's |
144 |
|
|
"Subject" field. The matching of the |
145 |
|
|
.B string |
146 |
|
|
is case-insensitive. |
147 |
|
|
.TP |
148 |
|
|
.B unanswered |
149 |
|
|
Messages that have not been answered. |
150 |
|
|
.TP |
151 |
|
|
.B undeleted |
152 |
|
|
Messages that are not marked for deletion. |
153 |
|
|
.TP |
154 |
|
|
.B undraft |
155 |
|
|
Messages that have completed composition. |
156 |
|
|
.TP |
157 |
|
|
.B unflagged |
158 |
|
|
Messages that are not marked for urgent/special attention. |
159 |
|
|
.TP |
160 |
|
|
.B unseen |
161 |
|
|
Messages that have not been read. |
162 |
|
|
.RE |
163 |
|
|
.TP |
164 |
|
|
.B action type |
165 |
|
|
The |
166 |
|
|
.B action |
167 |
|
|
command is used to end the filter entry started with the |
168 |
|
|
.B filter |
169 |
|
|
command. It assigns an action to be done when the |
170 |
|
|
.B filter |
171 |
|
|
is matched. |
172 |
|
|
|
173 |
|
|
The available |
174 |
|
|
.B type |
175 |
|
|
of actions are: |
176 |
|
|
.RS |
177 |
|
|
.TP |
178 |
|
|
.B delete [headers] |
179 |
|
|
Deletes the messages. User can also, optionally, define the |
180 |
|
|
.B headers |
181 |
|
|
of the deleted messages to display (which are also saved in the logfile if it |
182 |
|
|
is enabled). The |
183 |
|
|
.B headers |
184 |
|
|
are separated by a comma ',' character. |
185 |
|
|
.TP |
186 |
|
|
.B copy mailbox |
187 |
|
|
Copies the messages to the specified |
188 |
|
|
.BR mailbox . |
189 |
|
|
If the |
190 |
|
|
.B mailbox |
191 |
|
|
does not exist, then it is created. |
192 |
|
|
.TP |
193 |
|
|
.B move mailbox |
194 |
|
|
Moves the messages to the specified |
195 |
|
|
.BR mailbox . |
196 |
|
|
If the |
197 |
|
|
.B mailbox |
198 |
|
|
does not exist, then it is created. |
199 |
|
|
.TP |
200 |
|
|
.B list [headers] |
201 |
|
|
Displays the |
202 |
|
|
.B headers |
203 |
|
|
of the messages. The |
204 |
|
|
.B headers |
205 |
|
|
is a comma (',' character) separated list. |
206 |
|
|
.RE |
207 |
|
|
.TP |
208 |
|
|
.B job filter1[,filter2] [...] folder1[,folder2] [...] |
209 |
|
|
This command is used to define which |
210 |
|
|
.B filters |
211 |
|
|
must be applied to which |
212 |
|
|
.BR folders . |
213 |
|
|
.SH EXAMPLES |
214 |
|
|
See |
215 |
|
|
.BR sample.imapfilterrc . |
216 |
|
|
.SH AUTHOR |
217 |
|
|
Lefteris Chatzibarbas <lefcha@users.sourceforge.net> |
218 |
|
|
.SH SEE ALSO |
219 |
|
|
imapfilter(1) |