Module: Sisimai::Lhost::Gmail

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

Overview

Sisimai::Lhost::Gmail decodes a bounce email which created by Gmail mail.google.com/. Methods in the module are called from only Sisimai::Message.

Constant Summary collapse

Indicators = 
Sisimai::Lhost.INDICATORS
Boundaries = 
['----- Original message -----', '----- Message header follows -----'].freeze
StartingOf = 
{
  message: ['Delivery to the following recipient'],
  error:   ['The error that the other server returned was:'],
}.freeze
StateTable = 
{
  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 500 Remote server does not support TLS (state 6).
  '6'  => { 'command' => 'MAIL', 'reason' => 'failedstarttls' },

  # https://www.google.td/support/forum/p/gmail/thread?tid=08a60ebf5db24f7b&hl=en
  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 535 SMTP AUTH failed with the remote server. (state 8).
  '8'  => { 'command' => 'AUTH', 'reason' => 'systemerror' },

  # https://www.google.co.nz/support/forum/p/gmail/thread?tid=45208164dbca9d24&hl=en
  # Technical details of temporary failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 454 454 TLS missing certificate: error:0200100D:system library:fopen:Permission denied (#4.3.0) (state 9).
  '9'  => { 'command' => 'AUTH', 'reason' => 'failedstarttls' },

  # https://www.google.com/support/forum/p/gmail/thread?tid=5cfab8c76ec88638&hl=en
  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 500 Remote server does not support SMTP Authenticated Relay (state 12).
  '12' => { 'command' => 'AUTH', 'reason' => 'norelaying' },

  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 550 550 5.7.1 <****@gmail.com>... Access denied (state 13).
  '13' => { 'command' => 'EHLO', 'reason' => 'blocked' },

  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 550 550 5.1.1 <******@*********.**>... User Unknown (state 14).
  # 550 550 5.2.2 <*****@****.**>... Mailbox Full (state 14).
  #
  '14' => { 'command' => 'RCPT', 'reason' => 'userunknown' },

  # https://www.google.cz/support/forum/p/gmail/thread?tid=7090cbfd111a24f9&hl=en
  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 550 550 5.7.1 SPF unauthorized mail is prohibited. (state 15).
  # 554 554 Error: no valid recipients (state 15).
  '15' => { 'command' => 'DATA', 'reason' => 'filtered' },

  # https://www.google.com/support/forum/p/Google%20Apps/thread?tid=0aac163bc9c65d8e&hl=en
  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 550 550 <****@***.**> No such user here (state 17).
  # 550 550 #5.1.0 Address rejected ***@***.*** (state 17).
  '17' => { 'command' => 'DATA', 'reason' => 'filtered' },

  # Technical details of permanent failure:
  # Google tried to deliver your message, but it was rejected by the recipient domain.
  # We recommend contacting the other email provider for further information about the
  # cause of this error. The error that the other server returned was:
  # 550 550 Unknown user *****@***.**.*** (state 18).
  '18' => { 'command' => 'DATA', 'reason' => 'filtered' },
}.freeze

Class Method Summary collapse

Class Method Details

.description ⇒ Object 



232
 
# File 'lib/sisimai/lhost/gmail.rb', line 232

def description; return 'Gmail: https://mail.google.com'; end

.inquire(mhead, mbody) ⇒ Hash, Nil

This method is abstract.

Decodes the bounce message from Gmail

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



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
224
225
226
227
228
229
230
231
 
# File 'lib/sisimai/lhost/gmail.rb', line 93

def inquire(mhead, mbody)
  # From: Mail Delivery Subsystem <mailer-daemon@googlemail.com>
  # Received: from vw-in-f109.1e100.net [74.125.113.109] by ...
  #
  # * Check the body part
  #   This is an automatically generated Delivery Status Notification
  #   Delivery to the following recipient failed permanently:
  #
  #        recipient-address-here@example.jp
  #
  #   Technical details of permanent failure:
  #   Google tried to deliver your message, but it was rejected by the
  #   recipient domain. We recommend contacting the other email provider
  #   for further information about the cause of this error. The error
  #   that the other server returned was:
  #   550 550 <recipient-address-heare@example.jp>: User unknown (state 14).
  #
  #   -- OR --
  #   THIS IS A WARNING MESSAGE ONLY.
  #
  #   YOU DO NOT NEED TO RESEND YOUR MESSAGE.
  #
  #   Delivery to the following recipient has been delayed:
  #
  #        mailboxfull@example.jp
  #
  #   Message will be retried for 2 more day(s)
  #
  #   Technical details of temporary failure:
  #   Google tried to deliver your message, but it was rejected by the recipient
  #   domain. We recommend contacting the other email provider for further infor-
  #   mation about the cause of this error. The error that the other server re-
  #   turned was: 450 450 4.2.2 <mailboxfull@example.jp>... Mailbox Full (state 14).
  #
  #   -- OR --
  #
  #   Delivery to the following recipient failed permanently:
  #
  #        userunknown@example.jp
  #
  #   Technical details of permanent failure:=20
  #   Google tried to deliver your message, but it was rejected by the server for=
  #    the recipient domain example.jp by mx.example.jp. [192.0.2.59].
  #
  #   The error that the other server returned was:
  #   550 5.1.1 <userunknown@example.jp>... User Unknown
  #
  return nil if mhead['from'].end_with?('<mailer-daemon@googlemail.com>') == false
  return nil if mhead['subject'].start_with?('Delivery Status Notification') == false

  require 'sisimai/address'
  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

  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])
    end
    next if (readcursor & Indicators[:deliverystatus]) == 0 || e.empty?

    # Technical details of permanent failure:=20
    # Google tried to deliver your message, but it was rejected by the recipient =
    # domain. We recommend contacting the other email provider for further inform=
    # ation about the cause of this error. The error that the other server return=
    # ed was: 554 554 5.7.0 Header error (state 18).
    #
    # -- OR --
    #
    # Technical details of permanent failure:=20
    # Google tried to deliver your message, but it was rejected by the server for=
    # the recipient domain example.jp by mx.example.jp. [192.0.2.49].
    #
    # The error that the other server returned was:
    # 550 5.1.1 <userunknown@example.jp>... User Unknown
    #
    v = dscontents[-1]

    if e.start_with?(' ') && e.include?('@')
      # kijitora@example.jp: 550 5.2.2 <kijitora@example>... Mailbox Full
      if v["recipient"] != ""
        # There are multiple recipient addresses in the message body.
        dscontents << Sisimai::Lhost.DELIVERYSTATUS
        v = dscontents[-1]
      end

      r = Sisimai::Address.s3s4(e[e.rindex(' ') + 1, e.size])
      next if Sisimai::Address.is_emailaddress(r) == false
      v['recipient'] = r
      recipients += 1
    else
      v["diagnosis"] += "#{e }"
    end
  end
  return nil if recipients == 0

  require 'sisimai/string'
  require 'sisimai/rfc1123'
  dscontents.each do |e|
    if Sisimai::String.aligned(e['diagnosis'], [' by ', '. [', ']. '])
      # Get the value of remote host
      # Google tried to deliver your message, but it was rejected by the server for the recipient
      # domain example.jp by mx.example.jp. [192.0.2.153].
      p1 = e['diagnosis'].rindex(' by ') || -1
      p2 = e['diagnosis'].rindex('. [' ) || -1
      hostname = e['diagnosis'][p1 + 4, p2 - p1 - 4]
      ipv4addr = e['diagnosis'][p2 + 3, e['diagnosis'].rindex(']. ') - p2 - 3]

      e['rhost'] = hostname if Sisimai::RFC1123.is_internethost(hostname)
      e['rhost'] = ipv4addr if e["rhost"].empty?
    end

    while true do
      # Find "(state 18)" and pick "18" as a key of statetable
      p1 = e['diagnosis'].rindex(' (state ');   break if p1.nil?
      p2 = e['diagnosis'].rindex(')');          break if p2.nil?
                                                break if p1 > p2
      cu = e['diagnosis'][p1 + 8, p2 - p1 - 8]
      break if cu.empty?
      break if StateTable[cu].nil?
      e['reason']  = StateTable[cu]['reason']
      e['command'] = StateTable[cu]['command']
      break
    end
    next if e['reason'].empty?

    # Set pseudo status code
    e['status'] = Sisimai::SMTP::Status.find(e['diagnosis'])
    next if e['status'].size == 0 || e['status'].include?('.0')
    e['reason'] = Sisimai::SMTP::Status.name(e['status'])
  end

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