Skip to content
Email Filter
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
doc
lib
spec
CHANGELOG
MIT-LICENSE
README
Rakefile
TODO

README

= RGTE: An email filter

RGTE is a small, opinionated email filter which processes and filters incoming email into Maildirs.

== License

RGTE is copyright 2008 Scott Barron.  It is licensed under the MIT license.  See the included MIT-LICENSE file for details.

== Installation

$ [sudo] gem install --source http://rubyi.st/gems/ rgte

One of these days I'll register a Rubyforge project for the gem, but that's such a pain.

And don't forget that trailing slash - otherwise it doesn't go.

== Usage

Set up whatever processes your incoming mail to pipe through rgte.  Examples:

Using .forward:

  $ cat ~/.forward
  "|exec /usr/local/bin/rgte"


Using procmail:

  $ cat ~/.procmail
  :0:
  | /usr/local/bin/rgte


Using fetchmail:

  $ cat ~/.fetchmailrc
  poll myaccount.email.com protocol imap:
    user "foo@example.com" there has password "blah" ssl
    is "foo" here and wants mda "/usr/local/bin/rgte"


Write your filters in ~/.rgte
  
  # Set up some configuration
  config :maildir_root => '/home/scott/Maildir', :maildir_backup => '/home/scott/Mail-backup'

  # Keep a copy of every email in :maildir_backup
  backup

  # sets up an alias, :me, containing my addresses
  group :me, 'scott@elitists.net', 'scott@somewhereelse.com'

  # Mark every message that's From the :me alias as read
  from(:me).read

  # Pipe the mail through spamprobe, file it into @spam if it's a hit and halt processing
  pipe('/usr/bin/spamprobe train', /^SPAM/, '@spam').halt

  # Put every message From this address into archive and mark it read
  from('automail@easydraft.com', 'archive').read

  # Email lists - list is a shorthand that matches To, Cc, and From
  list 'homebrew@hbd.org',                        'lists/hbd'
  list 'ruby-core@ruby-lang.org',                 'lists/rubycore'
  list 'dtrace-discuss@opensolaris.org',          'lists/dtrace'

== Contact

Send questions or feedback to Scott Barron (scott@elitists.net).

Something went wrong with that request. Please try again.