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: "*******")
|
2017-09-07 21:19:45 +00:00
|
|
|
mailboxes = imap.list
|
2017-08-29 22:00:02 +00:00
|
|
|
if mailboxes.size > 0
|
|
|
|
|
mailbox = mailboxes[0]
|
2017-08-30 19:04:54 +00:00
|
|
|
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
|
|
|
|
|
```
|
|
|
|
|
|
2017-08-30 21:00:15 +00:00
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
Need to start writing tests.
|
2017-08-30 21:01:37 +00:00
|
|
|
* https://github.com/ruby/ruby/tree/ruby_2_4/test/net/imap for inspiration
|
2017-09-07 21:26:19 +00:00
|
|
|
* https://github.com/tedious/DovecotTesting
|
2017-08-30 21:00:15 +00:00
|
|
|
|
2017-08-29 22:00:02 +00:00
|
|
|
## 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
|
