Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 39 lines (19 sloc) 1.707 kB
ac44677 @ryanb adding Travis CI badge
authored
1 = Letter Opener {<img src="https://secure.travis-ci.org/ryanb/letter_opener.png" />}[http://travis-ci.org/ryanb/letter_opener]
74cfa35 @ryanb adding readme and simplifying file paths
authored
2
0955cfd @ryanb readme improvements
authored
3 Preview email in the browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
4
74cfa35 @ryanb adding readme and simplifying file paths
authored
5
6 == Rails Setup
7
177fd2f @ryanb improving multipart support and refactored out Message class
authored
8 First add the gem to your development environment and run the +bundle+ command to install it.
74cfa35 @ryanb adding readme and simplifying file paths
authored
9
10 gem "letter_opener", :group => :development
11
177fd2f @ryanb improving multipart support and refactored out Message class
authored
12 Then set the delivery method in <tt>config/environments/development.rb</tt>
74cfa35 @ryanb adding readme and simplifying file paths
authored
13
14 config.action_mailer.delivery_method = :letter_opener
15
0955cfd @ryanb readme improvements
authored
16 Now any email will pop up in your browser instead of being sent. The messages are stored in <tt>tmp/letter_opener</tt>.
74cfa35 @ryanb adding readme and simplifying file paths
authored
17
18
0955cfd @ryanb readme improvements
authored
19 == Non Rails Setup
74cfa35 @ryanb adding readme and simplifying file paths
authored
20
0955cfd @ryanb readme improvements
authored
21 If you aren't using Rails, this can be easily set up with the Mail gem. Just set the delivery method when configuring Mail and specify a location.
74cfa35 @ryanb adding readme and simplifying file paths
authored
22
23 require "letter_opener"
24 Mail.defaults do
25 delivery_method LetterOpener::DeliveryMethod, :location => "tmp/letter_opener"
26 end
27
28
5772e55 @ryanb adding project status to readme
authored
29 == Project Status
30
31 Unfortunately I have not had time to actively work on this project recently. If you find a critical issue where it does not work as documented please {ping me on Twitter}[http://twitter.com/rbates] and I'll take a look.
32
33
74cfa35 @ryanb adding readme and simplifying file paths
authored
34 == Development & Feedback
35
177fd2f @ryanb improving multipart support and refactored out Message class
authored
36 Questions or comments? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, clone this repository and run +bundle+ and +rake+ to run the tests.
74cfa35 @ryanb adding readme and simplifying file paths
authored
37
177fd2f @ryanb improving multipart support and refactored out Message class
authored
38 Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template.
Something went wrong with that request. Please try again.