imap-lib/README.md

42 lines
956 B
Markdown
Raw Normal View History

2017-08-29 22:00:02 +00:00
# imap
A very much WIP imap library for crystal.
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
imap:
github: crisward/imap
```
## Usage
```crystal
require "imap"
imap = Imap::Client.new(host: "imap.gmail.com", port: 993, username: "email@gmail.com", password: "*******")
mailboxes = imap.get_mailboxes
if mailboxes.size > 0
mailbox = mailboxes[0]
imap.select(mailbox)
2017-08-30 20:45:23 +00:00
status = imap.status(mailbox, ["MESSAGES", "UNSEEN"])
puts "There are #{status["MESSAGES"]} message in #{mailbox} #{status["UNSEEN"]} unread."
2017-08-29 22:00:02 +00:00
end
imap.close
```
## Contributing
1. Fork it ( https://github.com/crisward/imap/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [crisward](https://github.com/crisward) Cris Ward - creator, maintainer