README.md in imap_guard-0.0.3 vs README.md in imap_guard-0.0.4
- old
+ new
@@ -1,9 +1,16 @@
# ImapGuard [](https://travis-ci.org/infertux/imap_guard) [](https://gemnasium.com/infertux/imap_guard) [](https://codeclimate.com/github/infertux/imap_guard)
-A guard for your IMAP mailboxes.
+**A guard for your IMAP mailboxes.**
+ * [Source Code](https://github.com/infertux/imap_guard "Source Code on Github")
+ * [Bug Tracker](https://github.com/infertux/imap_guard/issues "Bug Tracker on Github")
+ * [API documentation](http://rubydoc.info/gems/imap_guard/frames "API Documentation on Rubydoc")
+ * [Rubygem](https://rubygems.org/gems/imap_guard "ImapGuard on Rubygems")
+ * [Continuous Integration](https://travis-ci.org/infertux/imap_guard "ImapGuard on Travis-CI")
+ * [Dependencies](https://gemnasium.com/infertux/imap_guard "ImapGuard dependencies on Gemnasium")
+
ImapGuard connects to your IMAP server and processes your emails.
You can finely pick them thanks to advanced search queries and Ruby blocks.
Then you can `move` or `delete` them in batch.
Of course, there is a _dry-run_ mode (i.e. read-only) available to double check what it would do.
@@ -14,10 +21,13 @@
$ gem install imap_guard
## Usage
+Read below for detailed explanations.
+If you prefer a quick overview, you can take a look at [this example](https://github.com/infertux/imap_guard/blob/master/examples/example.rb).
+
Example initialization:
```ruby
require 'imap_guard'
@@ -27,19 +37,19 @@
username: 'login',
password: 'pass',
read_only: true # don't perform any modification aka dry-run mode
}
-guard = IMAPGuard::Guard.new SETTINGS
+guard = ImapGuard::Guard.new SETTINGS
guard.login # authenticate the user
guard.select 'INBOX.ops' # select the mailbox
```
IMAP search query syntax can be a bit tricky.
-`IMAPGuard::Query` can help you to build queries with a simple Ruby DSL:
+`ImapGuard::Query` can help you to build queries with a simple Ruby DSL:
```ruby
-base_query = IMAPGuard::Query.new.unflagged.unanswered.seen.freeze
+base_query = ImapGuard::Query.new.unflagged.unanswered.seen.freeze
query = base_query.dup.before(7).subject("abc").from("root")
p query #=> ["UNFLAGGED", "UNANSWERED", "SEEN", "BEFORE", "13-Mar-2013", "SUBJECT", "abc", "FROM", "root"]
guard.delete query # will delete every emails which match this query
```