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

Annotation of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.6 - (hide annotations)
Fri Oct 5 13:19:10 2001 UTC (22 years, 5 months ago) by lefcha
Branch: MAIN
CVS Tags: release-0_6_2
Branch point for: release-0_6_2-patches
Changes since 1.5: +11 -14 lines
Typo errors fixed.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26