zendesk-ar_mailer 1.4.6 → 2.1.5

Sign up to get free protection for your applications and to get access to all the features.
data/README.txt DELETED
@@ -1,80 +0,0 @@
1
- = ar_mailer
2
-
3
- A two-phase delivery agent for ActionMailer.
4
-
5
- This fork allows you to add some context to the ar_mailer log, i.e. you can track "lost emails" such that when a customer complains of a missing email, you are able to find out what "identifier" in your system became what SMTP message-id, and continue tracking to the SMTP server logs.
6
-
7
- This fork also logs in its own log file rather than using the Rails logger.
8
-
9
- This fork is based on the fork by adzap (http://github.com/adzap/ar_mailer/tree/master) and includes the connectivity patches from gefilte (http://github.com/gefilte/ar_mailer/tree/master)
10
-
11
- Rubyforge Project:
12
-
13
- http://rubyforge.org/projects/seattlerb
14
-
15
- Documentation:
16
-
17
- http://seattlerb.org/ar_mailer
18
-
19
- and for forked additions
20
-
21
- http://github.com/adzap/ar_mailer/wikis
22
-
23
- Bugs:
24
-
25
- http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
26
-
27
- == About
28
-
29
- Even delivering email to the local machine may take too long when you have to
30
- send hundreds of messages. ar_mailer allows you to store messages into the
31
- database for later delivery by a separate process, ar_sendmail.
32
-
33
- == Installing ar_mailer (forked)
34
-
35
- Install the gem from GitHub gems server:
36
-
37
- First, if you haven't already
38
-
39
- $ sudo gem sources -a http://gems.github.com
40
-
41
- Then
42
-
43
- $ sudo gem install zendesk-ar_mailer
44
-
45
- See ActionMailer::ARMailer for instructions on converting to ARMailer.
46
-
47
- See ar_sendmail -h for options to ar_sendmail.
48
-
49
- NOTE: You may need to delete an smtp_tls.rb file if you have one lying
50
- around. ar_mailer supplies it own.
51
-
52
- === Getting context aware logging (this fork)
53
-
54
- If you want to log some extra information that you can use to tie a specific send email to
55
- something in your application, do this:
56
-
57
- 1. Add a +context+ column to your emails table, eg.:
58
-
59
- add_column :emails, :context, :string
60
-
61
- 2. Set the information you want ar_sendmail to log alongside the message-id in your mailer class:
62
-
63
- headers('X-Delivery-Context' => 'Hello there')
64
-
65
- This will print 'Hello there' in the line that also contains the message-id of the sent email, like so:
66
-
67
- ar_sendmail Fri Oct 17 12:04:58 +0000 2008: sent email 00000579421 [Hello there] from someone@somewhere.com to someone.else@somewhere.else.com: "250 OK id=1Kqo4g-0006Nx-MP\n"
68
-
69
- === init.d/rc.d scripts
70
-
71
- For Linux both script and demo config files are in share/linux.
72
- See ar_sendmail.conf for setting up your config. Copy the ar_sendmail file
73
- to /etc/init.d/ and make it executable. Then for Debian based distros run
74
- 'sudo update-rc.d ar_sendmail defaults' and it should work. Make sure you have
75
- the config file /etc/ar_sendmail.conf in place before starting.
76
-
77
- For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
78
- support the config file unless someone wants to submit a patch.
79
-
80
- Alternatively, use a monitoring solution like monit or god, or google: cron @reboot