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

Diff of /imapfilter/imapfilterrc.5

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

revision 1.2 by lefcha, Sun Sep 30 20:18:34 2001 UTC revision 1.3 by lefcha, Tue Oct 2 13:31:25 2001 UTC
# Line 1  Line 1 
1  .Dd September 30, 2001  .Dd October 2, 2001
2  .Dt IMAPFILTERRC 5  .Dt IMAPFILTERRC 5
3  .Os  .Os
4  .Sh NAME  .Sh NAME
# Line 10  The Line 10  The
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
14    .Sq #
15    character,
16    which
17  are considered comments, are ignored.  are considered comments, are ignored.
18  .Sh COMMANDS  .Sh COMMANDS
19  .Bl -tag -width Ds  .Bl -tag -width Ds
20  .It Cm account Ar username:password@hostname:host  .It Cm account Ar username:password@hostname[:host]
21  Defines a user account, using the  Defines a user account, using the
22  .Ar username  .Ar username
23  as user identification and  as user identification and
# Line 24  as the secret word, connecting to the Line 27  as the secret word, connecting to the
27  mail server, at the specified  mail server, at the specified
28  .Ar port  .Ar port
29  (if not specified the default IMAP protocol port (ie. 143) is used).  (if not specified the default IMAP protocol port (ie. 143) is used).
30  .It Cm folder Ar alias folder [...]  .It Cm folder Ar alias folder[,...]
31  Defines folders (mailboxes) and groups them under the  Defines folders (mailboxes) and groups them under the
32  .Ar alias  .Ar alias
33  name.  The mailboxes are associated with the last preceding  name.  The mailboxes are associated with the last preceding
34  .Ar account  .Ar account
35  setting.  setting. More than one
36    .Ar folder
37    can be declared, separating them with a comma
38    .Sq \&, .
39    The
40    .Ar alias
41    is comprised by alphanumeric, underscore
42    .Sq _
43    and minus
44    .Sq -
45    characters.
46  .It Cm filter Ar alias [or|and]  .It Cm filter Ar alias [or|and]
47  Starts the declaration of a filter with the name  Starts the declaration of a filter with the name
48  .Ar alias .  .Ar alias .
# Line 67  The Line 80  The
80  flag is used to revert the functionality of the specified  flag is used to revert the functionality of the specified
81  .Ar searchkey .  .Ar searchkey .
82  .Pp  .Pp
83    A
84    .Ar string
85    can be a word, or a phrase enclosed in
86    .Sq \&" .
87    The matching of the
88    .Ar string
89    is case-insensitive.
90    .Pp
91  The available searching criteria are:  The available searching criteria are:
92  .Bl -tag -width Ds  .Bl -tag -width Ds
93  .It Cm answered  .It Cm answered
# Line 76  Messages that contain the specified Line 97  Messages that contain the specified
97  .Ar string  .Ar string
98  in the envelope structure's  in the envelope structure's
99  .Dq Bcc  .Dq Bcc
100  field. The matching of the  field.
 .Ar string  
 is case-insesitive.  
101  .It Cm cc Ar string  .It Cm cc Ar string
102  Messages that contain the specified  Messages that contain the specified
103  .Ar string  .Ar string
104  in the envelope structure's  in the envelope structure's
105  .Dq Cc  .Dq Cc
106  field. The matching of the  field.
 .Ar string  
 is case-insesitive.  
107  .It Cm deleted  .It Cm deleted
108  Messages that are marked for deletion.  Messages that are marked for deletion.
109  .It Cm draft  .It Cm draft
# Line 98  Messages that contain the specified Line 115  Messages that contain the specified
115  .Ar string  .Ar string
116  in the envelope structure's  in the envelope structure's
117  .Dq From  .Dq From
118  field. The matching of the  field.
 .Ar string  
 is case-insensitive.  
119  .It Cm header Ar fieldname string  .It Cm header Ar fieldname string
120  Messages that have a header with the specified  Messages that have a header with the specified
121  .Ar fieldname ,  .Ar fieldname ,
122  and contain the specified  and contain the specified
123  .Ar string  .Ar string
124  in the field body. The matching of the  in the field body.
 .Ar string  
 is case-insesitive.  
125  .It Cm larger Ar number  .It Cm larger Ar number
126  Messages with size larger than the specified  Messages with size larger than the specified
127  .Ar number  .Ar number
128  in octets (bytes).  in octets (bytes).
129  .It Cm new  .It Cm new
130  Messages that have  Messages that have
131  .Dq recently  .Qq recently
132  arrived in the mailbox (this session is the  arrived in the mailbox (this session is the
133  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.
134  .It Cm old  .It Cm old
135  Messages that have not  Messages that have not
136  .Dq recently  .Qq recently
137  arrived in the mailbox and have not been  arrived in the mailbox and have not been
138  read.  read.
139  .It Cm recent  .It Cm recent
140  Messages that have  Messages that have
141  .Dq recently  .Qq recently
142  arrived in the mailbox (this session is the  arrived in the mailbox (this session is the
143  first, to have been notified about the messages).  first, to have been notified about the messages).
144  .It Cm seen  .It Cm seen
# Line 137  in octets (bytes). Line 150  in octets (bytes).
150  .It Cm subject Ar string  .It Cm subject Ar string
151  Messages that contain the specified string in the envelope structure's  Messages that contain the specified string in the envelope structure's
152  .Dq Subject  .Dq Subject
153  field. The matching of the  field.
 .Ar string  
 is case-insensitive.  
154  .It Cm unanswered  .It Cm unanswered
155  Messages that have not been answered.  Messages that have not been answered.
156  .It Cm undeleted  .It Cm undeleted
# Line 164  The available Line 175  The available
175  .Ar type  .Ar type
176  of actions are:  of actions are:
177  .Bl -tag -width Ds  .Bl -tag -width Ds
178  .It Cm delete Ar [headers]  .It Cm delete Ar [header,...]
179  Deletes the messages. User can also, optionally, define the  Deletes the messages. User can also, optionally, define the
180  .Ar headers  .Ar header
181  of the deleted messages to be displayed (which are also saved in the logfile if it  of the deleted messages to be displayed. More than one
182  is enabled). The  .Ar header
183  .Ar headers  can be declared and fetched, by separating them with a comma
184  are separated by a comma ',' character.  .Sq \&,
185  .It Cm copy Ar mailbox [headers]  character.
186    .It Cm copy Ar mailbox [header,...]
187  Copies the messages to the specified  Copies the messages to the specified
188  .Ar mailbox .  .Ar mailbox .
189  If the  If the
190  .Ar mailbox  .Ar mailbox
191  does not exist, then it is created. Optionally, fetches and displays the  does not exist, then it is created. Optionally, fetches and displays the
192  .Ar headers  .Ar header
193  of the messages that were copied.  of the messages that were copied.
194  .It Cm move Ar mailbox [headers]  .It Cm move Ar mailbox [header,...]
195  Moves the messages to the specified  Moves the messages to the specified
196  .Ar mailbox .  .Ar mailbox .
197  If the  If the
198  .Ar mailbox  .Ar mailbox
199  does not exist, then it is created. Optionally, fetches and displays the  does not exist, then it is created. Optionally, fetches and displays the
200  .Ar headers  .Ar header
201  of the messages that were moved.  of the messages that were moved.
202  .It Cm list Ar [headers]  .It Cm list Ar [header,...]
203  Displays the  Just displays the
204  .Ar headers  .Ar header
205  of the messages. The  of the messages.
 .Ar headers  
 is a comma (',' character) separated list.  
206  .El  .El
207  .It Cm job Ar filter [...] folder [...]  .It Cm job Ar filter[,...] folder[,...]
208  This command is used to define which  This command is used to define which
209  .Ar filters  .Ar filter
210  must be applied to which  must be applied to which
211  .Ar folders .  .Ar folder .
212    More than one
213    .Ar filter
214    and/or
215    .Ar folder
216    can be declared, by separating them with a comma
217    .Sq \&,
218    character.
219    .El
220    .Pp
221    Also, through the configuration file may be defined some program options:
222    .Bl -tag -width Ds
223    .It logfile
224    Full path to log file where filtering information and possible error
225    messages are saved to. The command line
226    .Fl l
227    option overrides this setting.
228    .It headers
229    By enabling this variable, message headers (if requested) are displayed,
230    in addition to be written to the log file. The argument must be
231    .Dq yes
232    or
233    .Dq no .
234    Default is
235    .Dq no .
236  .El  .El
237  .Sh EXAMPLES  .Sh EXAMPLES
238  See  See
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
webmaster@linux.gr
 ViewVC Help
Powered by ViewVC 1.1.26