Module: Sisimai::Lhost::Exchange2003

Defined in:
lib/sisimai/lhost/exchange2003.rb

Overview

Sisimai::Lhost::Exchange2003 decodes a bounce email which created by Microsoft Exchange Server 2003 www.microsoft.com/microsoft-365/exchange/email. Methods in the module are called from only Sisimai::Message.

Constant Summary collapse

Indicators = 
Sisimai::Lhost.INDICATORS
Boundaries = 
['Content-Type: message/rfc822'].freeze
StartingOf = 
{
  message: ['Your message'],
  error:   ['did not reach the following recipient(s):'],
}.freeze
ErrorCodes = 
{
  'onhold' => [
    '000B099C', # Host Unknown, Message exceeds size limit, ...
    '000B09AA', # Unable to relay for, Message exceeds size limit,...
    '000B09B6', # Error messages by remote MTA
  ],
  'userunknown' => [
    '000C05A6', # Unknown Recipient,
  ],
  'systemerror' => [
    '00010256', # Too many recipients.
    '000D06B5', # No proxy for recipient (non-smtp mail?)
  ],
  'networkerror' => [
    '00120270', # Too Many Hops
  ],
  'contenterror' => [
    '00050311', # Conversion to Internet format failed
    '000502CC', # Conversion to Internet format failed
  ],
  'securityerror' => [
    '000B0981', # 502 Server does not support AUTH
  ],
  'filtered' => [
    '000C0595', # Ambiguous Recipient
  ],
}.freeze

Class Method Summary collapse

Class Method Details

.description ⇒ Object 



224
 
# File 'lib/sisimai/lhost/exchange2003.rb', line 224

def description; return 'Microsoft Exchange Server 2003'; end

.inquire(mhead, mbody) ⇒ Hash, Nil

This method is abstract.

Decodes the bounce message from Microsoft Exchange Server 2003

Parameters:

  • mhead (Hash) —

    Message headers of a bounce email

  • mbody (String) —

    Message body of a bounce email

Returns:

  • (Hash) —

    Bounce data list and message/rfc822 part

  • (Nil) —

    it failed to decode or the arguments are missing



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/sisimai/lhost/exchange2003.rb', line 48

def inquire(mhead, mbody)
  match = 0
  tryto = []

  # X-MS-TNEF-Correlator: <00000000000000000000000000000000000000@example.com>
  # X-Mailer: Internet Mail Service (5.5.1960.3)
  # X-MS-Embedded-Report:
  match += 1 if mhead['x-ms-embedded-report']
  catch :EXCHANGE_OR_NOT do
    while true
      throw :EXCHANGE_OR_NOT if match > 0

      if mhead['x-mailer']
        # X-Mailer:  Microsoft Exchange Server Internet Mail Connector Version 4.0.994.63
        # X-Mailer: Internet Mail Service (5.5.2232.9)
        tryto = ['Internet Mail Service (', 'Microsoft Exchange Server Internet Mail Connector']
        match += 1 if mhead['x-mailer'].start_with?(tryto[0], tryto[1])
        throw :EXCHANGE_OR_NOT if match > 0
      end

      if mhead['x-mimeole']
        # X-MimeOLE: Produced By Microsoft Exchange V6.5
        match += 1 if mhead['x-mimeole'].start_with?('Produced By Microsoft Exchange')
        throw :EXCHANGE_OR_NOT if match > 0
      end

      throw :EXCHANGE_OR_NOT if mhead['received'].empty?
      mhead['received'].each do |e|
        # Received: by ***.**.** with Internet Mail Service (5.5.2657.72)
        next if e.include?(' with Internet Mail Service (') == false
        match += 1
        throw :EXCHANGE_OR_NOT
      end
      break
    end
  end
  return nil if match == 0

  dscontents = [Sisimai::Lhost.DELIVERYSTATUS]; v = nil
  emailparts = Sisimai::RFC5322.part(mbody, Boundaries)
  bodyslices = emailparts[0].split("\n")
  readcursor = 0      # (Integer) Points the current cursor position
  recipients = 0      # (Integer) The number of 'Final-Recipient' header
  statuspart = false  # (Boolean) Flag, true = have got delivery status part.
  connvalues = 0      # (Integer) Flag, 1 if all the value of connheader have been set
  connheader = {
    'to'      => '',  # The value of "To"
    'date'    => '',  # The value of "Date"
    'subject' => '',  # The value of "Subject"
  }

  while e = bodyslices.shift do
    # Read error messages and delivery status lines from the head of the email to the previous
    # line of the beginning of the original message.
    if readcursor == 0
      # Beginning of the bounce message or delivery status part
      readcursor |= Indicators[:deliverystatus] if e.start_with?(StartingOf[:message][0])
      next
    end
    next if (readcursor & Indicators[:deliverystatus]) == 0 || statuspart == true

    if connvalues == connheader.keys.size
      # did not reach the following recipient(s):
      #
      # kijitora@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
      #     The recipient name is not recognized
      #     The MTS-ID of the original message is: c=jp;a= ;p=neko
      # ;l=EXCHANGE000000000000000000
      #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
      # mikeneko@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
      #     The recipient name is not recognized
      #     The MTS-ID of the original message is: c=jp;a= ;p=neko
      # ;l=EXCHANGE000000000000000000
      #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
      v = dscontents[-1]

      if Sisimai::String.aligned(e, ['@', ' on '])
        # kijitora@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
        #   kijitora@example.com on 4/29/99 9:19:59 AM
        if v["recipient"] != ""
          # There are multiple recipient addresses in the message body.
          dscontents << Sisimai::Lhost.DELIVERYSTATUS
          v = dscontents[-1]
        end
        p1 = e.downcase.index('smtp='); p1 = p1.nil? ? 0 : p1 + 5
        p2 = e.index(' on ') + 1
        v['recipient'] = Sisimai::Address.s3s4(e[p1, p2])
        v['msexch'] = false
        recipients += 1

      elsif e.start_with?(' ') && e.include?('MSEXCH:')
        #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
        v['diagnosis'] += e[e.index('MSEXCH:'), e.size]
      else
        next if v['msexch']
        if v['diagnosis'].start_with?('MSEXCH:')
          # Continued from MEEXCH in the previous line
          v['msexch'] = true
          v['diagnosis'] += " #{e}"
          statuspart = true
        else
          # Error message in the body part
          v['alterrors'] ||= ''
          v['alterrors'] += " #{e}"
        end
      end
    else
      # Your message
      #
      #  To:      shironeko@example.jp
      #  Subject: ...
      #  Sent:    Thu, 29 Apr 2010 18:14:35 +0000
      #
      case
      when e.start_with?('  To: ', '      To: ')
        #  To:      shironeko@example.jp
        next if connheader['to'].empty? == false
        connheader['to'] = e[e.rindex(' ') + 1, e.size]
        connvalues += 1

      when e.start_with?('      Subject: ', '  Subject: ')
        #  Subject: ...
        next if connheader['subject'].empty? == false
        connheader['subject'] = e[e.rindex(' ') + 1, e.size]
        connvalues += 1

      when e.start_with?('  Sent: ', '      Sent: ')
        #  Sent:    Thu, 29 Apr 2010 18:14:35 +0000
        #  Sent:    4/29/99 9:19:59 AM
        next if connheader['date'].empty? == false
        connheader['date'] = e[e.index(':') + 2, e.size]
        connvalues += 1
      end
    end
  end
  return nil if recipients == 0

  dscontents.each do |e|
    e.delete('msexch')
    
    if e['diagnosis'].start_with?('MSEXCH:')
      #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
      p1 = e['diagnosis'].index('(') || -1
      p2 = e['diagnosis'].index(')') || -1
      capturedcode = e['diagnosis'][p1 + 1, 8]
      errormessage = e['diagnosis'][p2 + 1, e['diagnosis'].size]

      ErrorCodes.each_key do |r|
        # Find captured code from the error code table
        next if ErrorCodes[r].index(capturedcode).nil?
        e['reason'] = r
        e['status'] = Sisimai::SMTP::Status.code(r)
        break
      end
      e['diagnosis'] = errormessage
    end

    if e["reason"].empty?
      # Could not detect the reason from the value of "diagnosis".
      next if e["alterrors"].empty?

      # Copy alternative error message
      e['diagnosis'] = "#{e['alterrors']} #{e['diagnosis']}"
      e.delete('alterrors')
    end
  end

  if emailparts[1].empty?
    # When original message does not included in the bounce message
    emailparts[1] += "From: #{connheader['to']}\n"
    emailparts[1] += "Date: #{connheader['date']}\n"
    emailparts[1] += "Subject: #{connheader['subject']}\n"
  end

  return { 'ds' => dscontents, 'rfc822' => emailparts[1] }
end