add readme
This commit is contained in:
parent
c31bebc2e5
commit
ca230a6e8b
18
README.md
Normal file
18
README.md
Normal file
|
@ -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
|
Loading…
Reference in New Issue
Block a user