____ _           _      ____  _                       
 / ___| | ___ _ __| | __ / ___|(_)_ __ ___   ___  _ __  
| |   | |/ _ \ '__| |/ / \___ \| | '_ ` _ \ / _ \| '_ \ 
| |___| |  __/ |  |   <   ___) | | | | | | | (_) | | | |
 \____|_|\___|_|  |_|\_\ |____/|_|_| |_| |_|\___/|_| |_|


# ---------------------------
# - Quick Start

# See ruby-ldap-howto if you do not have ruby-ldap installed
# Install clerk_simon
bzr co http://code.rhnh.net/clerk_simon/
cd clerk_simon
cp config.sample.yml config.yml # Edit to taste
bin/clerk_simon config.yml

# ---------------------------
# - A more civil introduction

Clerk Simon diligently checks an IMAP message box, and upon finding a forwarded message will update an LDAP address book with the details of the original sender. In addition, you can specify bonus attributes as part of the forwarded message.

Simon will process all messages in the inbox then terminate, so you may want to cron him so he will repeatedly check.

# ---------------------------
# An example!

I receive an email from Ernest, and decide to add him in to my address book because he's such a top bloke. I happen to also know his mobile number. I forward the message to my drop box account - I grabbed a free one at fastmail.fm - and add his mobile to the top of the message. Thusly:

Mobile: 0400-123-456

- -------- Original Message --------
Subject: Behold my new story 
Date: Sat, 3 Nov 2007 10:48:06 +1100
From: Ernest Hemingway <ernest@example.com>
To: Xavier Shay <xavier@rhnh.net>

Then he died. In the rain.


Clerk Simon checks the dropbox account, and translates the above email into an LDAP entry on my address book server:

dn: cn=Ernest Hemingway,ou=people,dc=rhnh,dc=net
cn: Ernest Hemingway
givenName: Ernest
sn: Hemingway
mail: ernest@example.com
mobile: 0400-123-456
ou: people
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson

He then deletes the forwarded message, and is quietly contented with the satisfactory manner in which his task was performed. If a matching entry already exists on the server, the message is deleted with no action being taken.

# ---------------------------
# History

Clerk Simon was initally employed by Xavier Shay (xavier@rhnh.net) in November 2007.