Introduction

A Source is a supplier of new messages. Scythe currently uses inc to bring in new mail.

Defining

A Source is defined in a file placed in $HOME/.scythe/source/. The name of the file is the name of the Source.

The contents of the file are in the form of key=value. Blank lines and lines beginning with # are ignored. Example:

# work mail account
type=pop3
global=yes
inbox=work
host=myserver.com
user=johnsmith

Common attributes

The following attributes apply to all source classes.

Key Values Required Default Description
type maildrop, pop3 Yes   Defines the class of this source. See below for further arguments dependant on the class type.
global no, yes No yes If yes the source is used as part of a global mail check.
inbox Folder name No inbox Which folder mail is placed in by default.

Maildrop

The Maildrop class incorporates mail from the system maildrop file. No further arguments are needed.

POP3

The POP3 class incorporates mail from a POP3 server. This requires POP3 support in the inc command. I suspect you may need nmh for POP3.

Passwords for each account must be defined in a file named .netrc in your home directory. The file should have 0400 permissions. Lines in this file are in the format of:

machine host login username password password
Key Values Required Default Description
host Server name Yes   The POP3 server.
user Username Yes   The username for the POP3 account.