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

Annotation of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations)
Sun Sep 30 20:18:34 2001 UTC (22 years, 6 months ago) by lefcha
Branch: MAIN
Changes since 1.1: +129 -139 lines
Transition from man to mdoc.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26