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

Annotation of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.7 - (hide annotations)
Thu Nov 1 16:36:56 2001 UTC (22 years, 5 months ago) by lefcha
Branch: MAIN
Changes since 1.6: +17 -3 lines
Updates on SSL/TLS and older/newer searchkeys.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26