diff --git a/README.md b/README.md new file mode 100644 index 0000000..b24745a --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +libUnreadMail +============= + +This library implements barely enough IMAP to read unseen mail. It also +contains an example program, that fetches said mails and prints them to stdout. + +You can use either Fetch(*Parameters) or FetchPlaintext(*Parameters) provided +in libUnreadMail.go as your entry points. The former fetches the whole message +as golangs net/mail, the latter fetches the plain-text parts as strings. + +unreadMail +========== + +* go get the libUnreadMail repo +* enter the unreadMail subfolder +* go install +* use $GOPATH/bin/unreadMail -cert $cert -server foobar.com -user spam -passwd eggs to fetch mail +* the fetched mail will be marked as read \ No newline at end of file