Configuration Commands

filter-hook

  filter-hook PATTERN MAILBOX

Where PATTERN is a regular expression and MAILBOX the file that any matching messages should be saved to. Before searching, all newline characters within a header are removed. The PATTERN is case insesitive and a '.*' subpattern will not match a newline character. When more PATTERNS match, only the first matching PATTERN will be used. If no PATTERN match the message will be kept at the server.

There are two special symbolic mailboxes: <delete> and <keep>.

<delete>

<keep>

set

  [set] VARIABLE [=] VALUE

Possible variables are: beep_new, pop_delete, pop_last, pop_port, pop_checkinterval, tmpdir, folder, mbox_type, pop_host, pop_user, and pop_pass. Possible values depend on each variables type. Boolean variables can only be assigned yes or no, integer variables only accept integer values, and string variables accept any string enclosed with either single (') or double (") quotes.

Configuration variables

beep_new

Type: boolean
Default: no

When this variable is set, Poppet will play the "new mail" sound whenever it has downloaded new mail.

folder

Type: path
Default: "~/Mail"

Specifies the default location of your mailboxes. A `+' or `=' at the beginning of a pathname will be expanded to the value of this variable.

mbox_type

Type: folder magic
Default: mbox

The default mailbox type used when creating new folders. May be any of mbox and Maildir.

pop_delete

Type: boolean
Default: no

If set, Poppet will delete successfully downloaded messages from the POP server. When unset, Poppet will download messages but also leave them on the POP server.

pop_host

Type: string
Default: ""

The name or address of your POP3 server.

pop_port

Type: number
Default: 110

This variable specifies which port your POP server is listening on.

pop_last

Type: boolean
Default: no

If this variable is set, Poppet will try to use the "LAST" POP command for retrieving only unread messages from the POP server.

pop_user

Type: string
Default: ""

Your login name on the POP3 server.

pop_pass

Type: string
Default: ""

Your password on the POP3 server.

tmpdir

Type: path
Default: ""

This variable allows you to specify where Poppet will place its temporary files needed for downloading messages.