9 |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
10 |
The |
The |
11 |
.Nm |
.Nm |
12 |
configuration file consists of a series of commands, every one of which must |
configuration file consists of a series of commands and variable settings, |
13 |
be contained in a separate line. |
every one of which must be contained in a separate line. |
14 |
.Pp |
.Pp |
15 |
Empty lines and lines beginning with the number sign |
Empty lines and lines beginning with the number sign |
16 |
.Sq # |
.Sq # |
36 |
.Ar password |
.Ar password |
37 |
strings can be given in a URL encoding like scheme, that is the |
strings can be given in a URL encoding like scheme, that is the |
38 |
.Sq % |
.Sq % |
39 |
character followed two digits representing the character's ASCII code. |
character followed by two hexadecimal digits representing the encoded |
40 |
Within the |
character's |
41 |
|
.Xr ascii 7 |
42 |
|
code. Within the |
43 |
.Ar username |
.Ar username |
44 |
and |
and |
45 |
.Ar password |
.Ar password |
197 |
.Ar type |
.Ar type |
198 |
of actions are: |
of actions are: |
199 |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
200 |
|
.It Cm copy Ar mailbox [header,...] |
201 |
|
Copies the messages to the specified |
202 |
|
.Ar mailbox . |
203 |
|
If the |
204 |
|
.Ar mailbox |
205 |
|
does not exist, then it is created. Optionally, fetches and displays the |
206 |
|
.Ar header |
207 |
|
of the messages that were copied. |
208 |
.It Cm delete Ar [header,...] |
.It Cm delete Ar [header,...] |
209 |
Deletes the messages. User can also, optionally, define the |
Deletes the messages. User can also, optionally, define the |
210 |
.Ar header |
.Ar header |
213 |
can be declared and fetched, by separating them with a comma |
can be declared and fetched, by separating them with a comma |
214 |
.Sq \&, |
.Sq \&, |
215 |
character. |
character. |
216 |
.It Cm copy Ar mailbox [header,...] |
.It Cm list Ar [header,...] |
217 |
Copies the messages to the specified |
Just displays the |
|
.Ar mailbox . |
|
|
If the |
|
|
.Ar mailbox |
|
|
does not exist, then it is created. Optionally, fetches and displays the |
|
218 |
.Ar header |
.Ar header |
219 |
of the messages that were copied. |
of the messages. |
220 |
.It Cm move Ar mailbox [header,...] |
.It Cm move Ar mailbox [header,...] |
221 |
Moves the messages to the specified |
Moves the messages to the specified |
222 |
.Ar mailbox . |
.Ar mailbox . |
225 |
does not exist, then it is created. Optionally, fetches and displays the |
does not exist, then it is created. Optionally, fetches and displays the |
226 |
.Ar header |
.Ar header |
227 |
of the messages that were moved. |
of the messages that were moved. |
|
.It Cm list Ar [header,...] |
|
|
Just displays the |
|
|
.Ar header |
|
|
of the messages. |
|
228 |
.El |
.El |
229 |
.It Cm job Ar filter[,...] folder[,...] |
.It Cm job Ar filter[,...] folder[,...] |
230 |
This command is used to define which |
This command is used to define which |
241 |
.El |
.El |
242 |
.Sh VARIABLES |
.Sh VARIABLES |
243 |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Va logfile |
|
|
Full path to log file where filtering information and possible error |
|
|
messages are saved to. The command line |
|
|
.Fl l |
|
|
option overrides this setting. |
|
244 |
.It Va headers |
.It Va headers |
245 |
By enabling this variable, message headers (if requested) are displayed, |
By enabling this variable, message headers (if requested) are displayed, |
246 |
besides being written to the log file. The argument must be |
besides being written to the log file. The argument must be |
249 |
.Dq no . |
.Dq no . |
250 |
Default is |
Default is |
251 |
.Dq no . |
.Dq no . |
252 |
|
.It Va logfile |
253 |
|
Full path to log file where filtering information and possible error |
254 |
|
messages are saved to. The command line |
255 |
|
.Fl l |
256 |
|
option overrides this setting. |
257 |
.El |
.El |
258 |
.Sh EXAMPLES |
.Sh EXAMPLES |
259 |
See |
See |