Skip to content

Commit 9850521

Browse files
committed
updated copy
1 parent 8ba09c3 commit 9850521

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

readme.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
[![Build Status](https://travis-ci.org/wildbit/mailhandler.svg?branch=master)](https://travis-ci.org/wildbit/mailhandler)
66

7-
MailHandler is a simple wrapper on top of [mail gem](https://github.com/mikel/mail) and [postmark gem](https://github.com/wildbit/postmark-gem) libraries which allows you to send and retrieve emails and get details on how long these operations took.
7+
MailHandler is a simple wrapper on top of [Mail gem](https://github.com/mikel/mail) and [Postmark gem](https://github.com/wildbit/postmark-gem) libraries. It allows you to send and retrieve emails and get details on how long these operations took.
88
Main purpose of the gem is easier email sending/delivery testing with notifications if sending or retrieving email is taking too long.
99

10-
The library supports sending email by SMTP and Postmark API and checking email delivery by IMAP protocol, or by folder, if you have a local mailbox.
10+
The library supports sending email by SMTP and Postmark API and checking email delivery by IMAP protocol, or by folder if you have a local mailbox.
1111

1212
# Install the gem
1313

@@ -34,8 +34,8 @@ Folders can be the same if you don't plan to archive found emails. Retrieving em
3434

3535
``` ruby
3636
email_receiver = MailHandler.receiver(:folder) do |checker|
37-
checker.inbox_folder = folder_of_your_inbox
38-
checker.archive_folder = folder_of_your_inbox_archive_folder
37+
checker.inbox_folder = '/folder/mailbox/'
38+
checker.archive_folder = '/folder/mailbox/archive/'
3939
end
4040
```
4141

@@ -128,7 +128,7 @@ email_sender = MailHandler.sender(type) do |dispatcher|
128128
end
129129
```
130130

131-
* `:type` - type can be `:postmark_api` or `postmark_batch_api`
131+
* `:type` - type can be `:postmark_api` or `:postmark_batch_api`
132132
* `:api_token` - api token of one of your Postmark sending servers
133133

134134
### Sending email by SMTP

0 commit comments

Comments
 (0)