module Sisimai::Lhost::Outlook

Sisimai::Lhost::Outlook parses a bounce email which created by Microsoft Outlook.com. Methods in the module are called from only Sisimai::Message.

Constants

Indicators
MessagesOf
ReBackbone
StartingOf

Public Class Methods

description() click to toggle source
# File lib/sisimai/lhost/outlook.rb, line 129
def description; return 'Microsoft Outlook.com: https://www.outlook.com/'; end
make(mhead, mbody) click to toggle source

Parse bounce messages from Microsoft Outlook.com @param [Hash] mhead Message headers of a bounce email @param [String] mbody Message body of a bounce email @return [Hash] Bounce data list and message/rfc822 part @return [Nil] it failed to parse or the arguments are missing

# File lib/sisimai/lhost/outlook.rb, line 23
def make(mhead, mbody)
  # X-Message-Delivery: Vj0xLjE7RD0wO0dEPTA7U0NMPTk7bD0xO3VzPTE=
  # X-Message-Info: AuEzbeVr9u5fkDpn2vR5iCu5wb6HBeY4iruBjnutBzpStnUabbM...
  match  = 0
  match += 1 if mhead['subject'].start_with?('Delivery Status Notification')
  match += 1 if mhead['x-message-delivery']
  match += 1 if mhead['x-message-info']
  match += 1 if mhead['received'].any? { |a| a.include?('.hotmail.com') }
  return nil if match < 2

  require 'sisimai/rfc1894'
  fieldtable = Sisimai::RFC1894.FIELDTABLE
  permessage = {}     # (Hash) Store values of each Per-Message field

  dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
  emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
  bodyslices = emailsteak[0].split("\n")
  readslices = ['']
  readcursor = 0      # (Integer) Points the current cursor position
  recipients = 0      # (Integer) The number of 'Final-Recipient' header
  v = nil

  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.
    readslices << e # Save the current line for the next loop

    if readcursor == 0
      # Beginning of the bounce message or message/delivery-status part
      readcursor |= Indicators[:deliverystatus] if e.start_with?(StartingOf[:message][0])
      next
    end
    next if (readcursor & Indicators[:deliverystatus]) == 0
    next if e.empty?

    if f = Sisimai::RFC1894.match(e)
      # "e" matched with any field defined in RFC3464
      next unless o = Sisimai::RFC1894.field(e)
      v = dscontents[-1]

      if o[-1] == 'addr'
        # Final-Recipient: rfc822; kijitora@example.jp
        # X-Actual-Recipient: rfc822; kijitora@example.co.jp
        if o[0] == 'final-recipient'
          # Final-Recipient: rfc822; kijitora@example.jp
          if v['recipient']
            # There are multiple recipient addresses in the message body.
            dscontents << Sisimai::Lhost.DELIVERYSTATUS
            v = dscontents[-1]
          end
          v['recipient'] = o[2]
          recipients += 1
        else
          # X-Actual-Recipient: rfc822; kijitora@example.co.jp
          v['alias'] = o[2]
        end
      elsif o[-1] == 'code'
        # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
        v['spec'] = o[1]
        v['diagnosis'] = o[2]
      else
        # Other DSN fields defined in RFC3464
        next unless fieldtable[o[0]]
        v[fieldtable[o[0]]] = o[2]

        next unless f == 1
        permessage[fieldtable[o[0]]] = o[2]
      end
    else
      # Continued line of the value of Diagnostic-Code field
      next unless readslices[-2].start_with?('Diagnostic-Code:')
      next unless cv = e.match(/\A[ \t]+(.+)\z/)
      v['diagnosis'] << ' ' << cv[1]
      readslices[-1] = 'Diagnostic-Code: ' << e
    end
  end
  return nil unless recipients > 0

  dscontents.each do |e|
    # Set default values if each value is empty.
    e['lhost'] ||= permessage['rhost']
    permessage.each_key { |a| e[a] ||= permessage[a] || '' }

    e['diagnosis'] = Sisimai::String.sweep(e['diagnosis']) || ''
    if e['diagnosis'].empty?
      # No message in 'diagnosis'
      if e['action'] == 'delayed'
        # Set pseudo diagnostic code message for delaying
        e['diagnosis'] = 'Delivery to the following recipients has been delayed.'
      else
        # Set pseudo diagnostic code message
        e['diagnosis']  = 'Unable to deliver message to the following recipients, '
        e['diagnosis'] << 'due to being unable to connect successfully to the destination mail server.'
      end
    end

    MessagesOf.each_key do |r|
      # Verify each regular expression of session errors
      next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
      e['reason'] = r
      break
    end
  end

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