1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
#!/usr/bin/env ruby
# -*- coding: utf-8 -*-
# Handle email responses sent to us.
#
# This script is invoked as a pipe command, i.e. with the raw email message on stdin.
# - If a message is identified as a permanent bounce, the user is marked as having a
# bounced address, and will not be sent any more messages.
# - If a message is identified as an out-of-office autoreply, it is discarded.
# - Any other messages are forwarded to config.get("FORWARD_NONBOUNCE_RESPONSES_TO")
# We want to avoid loading rails unless we need it, so we start by just loading the
# config file ourselves.
$alaveteli_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
$:.push(File.join($alaveteli_dir, "commonlib", "rblib"))
load 'config.rb'
$:.push(File.join($alaveteli_dir, "lib"))
$:.push(File.join($alaveteli_dir, "lib", "mail_handler"))
load 'configuration.rb'
MySociety::Config.set_file(File.join($alaveteli_dir, 'config', 'general'), true)
MySociety::Config.load_default
require 'active_support/all'
require 'mail_handler'
if RUBY_VERSION.to_f >= 1.9
# the default encoding for IO is utf-8, and we use utf-8 internally
Encoding.default_external = Encoding.default_internal = Encoding::UTF_8
end
def main(in_test_mode)
Dir.chdir($alaveteli_dir) do
raw_message = $stdin.read
begin
message = MailHandler.mail_from_raw_email(raw_message)
rescue
# Error parsing message. Just pass it on, to be on the safe side.
forward_on(raw_message) unless in_test_mode
return 0
end
pfas = permanently_failed_addresses(message)
if !pfas.empty?
if in_test_mode
puts pfas
else
pfas.each do |pfa|
record_bounce(pfa, raw_message)
end
end
return 1
end
content_type = MailHandler.get_content_type(message)
# If we are still here, there are no permanent failures,
# so if the message is a multipart/report then it must be
# reporting a temporary failure. In this case we discard it
if content_type == "multipart/report"
return 1
end
# Another style of temporary failure message
subject = MailHandler.get_header_string("Subject", message)
if content_type == "multipart/mixed" && subject == "Delivery Status Notification (Delay)"
return 1
end
# Discard out-of-office messages
if is_oof?(message)
return 2 # Use a different return code, to distinguish OOFs from bounces
end
# Otherwise forward the message on
forward_on(raw_message) unless in_test_mode
return 0
end
end
def permanently_failed_addresses(message)
if MailHandler.empty_return_path?(message)
# Some sort of auto-response
# Check for Exim’s X-Failed-Recipients header
failed_recipients = MailHandler.get_header_string("X-Failed-Recipients", message)
if !failed_recipients.nil?
# The X-Failed-Recipients header contains the email address that failed
# Check for the words "This is a permanent error." in the body, to indicate
# a permanent failure
if MailHandler.get_part_body(message) =~ /This is a permanent error./
return failed_recipients.split(/,\s*/)
end
end
# Next, look for multipart/report
if MailHandler.get_content_type(message) == "multipart/report"
permanently_failed_recipients = []
message.parts.each do |part|
if MailHandler.get_content_type(part) == "message/delivery-status"
sections = MailHandler.get_part_body(part).split(/\r?\n\r?\n/)
# The first section is a generic header; subsequent sections
# represent a particular recipient. Since we
sections[1..-1].each do |section|
if section !~ /^Status: (\d)/ || $1 != '5'
# Either we couldn’t find the Status field, or it was a transient failure
break
end
if section =~ /^Final-Recipient: rfc822;(.+)/
permanently_failed_recipients.push($1)
end
end
end
end
if !permanently_failed_recipients.empty?
return permanently_failed_recipients
end
end
end
subject = MailHandler.get_header_string("Subject", message)
# Then look for the style we’ve seen in WebShield bounces
# (These do not have a return path of <> in the cases I have seen.)
if subject == "Returned Mail: Error During Delivery"
if MailHandler.get_part_body(message) =~ /^\s*---- Failed Recipients ----\s*((?:<[^>]+>\n)+)/
return $1.scan(/<([^>]+)>/).flatten
end
end
return []
end
def is_oof?(message)
# Check for out-of-office
if MailHandler.get_header_string("X-POST-MessageClass", message) == "9; Autoresponder"
return true
end
subject = MailHandler.get_header_string("Subject", message).downcase
if MailHandler.empty_return_path?(message)
if subject.start_with? "out of office: "
return true
end
if subject.start_with? "automatic reply: "
return true
end
end
if MailHandler.get_header_string("Auto-Submitted", message) == "auto-generated"
if subject =~ /out of( the)? office/
return true
end
end
if subject.start_with? "out of office autoreply:"
return true
end
if subject == "out of office"
return true
end
if subject == "out of office reply"
return true
end
if subject.end_with? "is out of the office"
return true
end
return false
end
def forward_on(raw_message)
IO.popen("/usr/sbin/sendmail -i #{AlaveteliConfiguration::forward_nonbounce_responses_to}", "w") do |f|
f.write(raw_message);
f.close;
end
end
def load_rails
require File.join($alaveteli_dir, 'config', 'boot')
require File.join($alaveteli_dir, 'config', 'environment')
end
def record_bounce(email_address, bounce_message)
load_rails
User.record_bounce_for_email(email_address, bounce_message)
end
in_test_mode = (ARGV[0] == "--test")
status = main(in_test_mode)
exit(status) if in_test_mode
|
