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

Diff of /imapfilter/imapfilterrc.5

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26