Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 34 lines (17 sloc) 1.619 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
fccbf2f @ryanb raise exception if location option is not present when setting up del…
authored
25 delivery_method LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
74cfa35 @ryanb adding readme and simplifying file paths
authored
26 end
27
28
29 == Development & Feedback
30
b64a9ed @ryanb remove project status section in readme since it is now under active …
authored
31 Questions or problems? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, fork this repository and run +bundle+ and +rake+ to run the tests. Pull requests appreciated.
74cfa35 @ryanb adding readme and simplifying file paths
authored
32
219501d @ryanb fix formatting in README
authored
33 Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template. Also thanks to {Vasiliy Ermolovich}[https://github.com/nashby] for helping manage this project.
Something went wrong with that request. Please try again.