123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::ResponseParser

Do not use. This class is for internal use only.
Relationships & Source Files
Namespace Children
Classes:
Inherits: Object
Defined in: lib/net/imap.rb

Constant Summary

Class Method Summary

Instance Method Summary

Constructor Details

.newResponseParser

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2170

def initialize
  @str = nil
  @pos = nil
  @lex_state = nil
  @token = nil
  @flag_symbols = {}
end

Instance Method Details

#address (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3205

def address
  match(T_LPAR)
  if @str.index(ADDRESS_REGEXP, @pos)
    # address does not include literal.
    @pos = $~.end(0)
    name = $1
    route = $2
    mailbox = $3
    host = $4
    for s in [name, route, mailbox, host]
      if s
        s.gsub!(/\\(["\\])/n, "\\1")
      end
    end
  else
    name = nstring
    match(T_SPACE)
    route = nstring
    match(T_SPACE)
    mailbox = nstring
    match(T_SPACE)
    host = nstring
    match(T_RPAR)
  end
  return Address.new(name, route, mailbox, host)
end

#address_list (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3175

def address_list
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  else
    result = []
    match(T_LPAR)
    while true
      token = lookahead
      case token.symbol
      when T_RPAR
        shift_token
        break
      when T_SPACE
        shift_token
      end
      result.push(address)
    end
    return result
  end
end

#astring (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3266

def astring
  token = lookahead
  if string_token?(token)
    return string
  else
    return atom
  end
end

#atom (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3301

def atom
  result = String.new
  while true
    token = lookahead
    if atom_token?(token)
      result.concat(token.value)
      shift_token
    else
      if result.empty?
        parse_error("unexpected token %s", token.symbol)
      else
        return result
      end
    end
  end
end

#atom_token?(token) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3327

def atom_token?(token)
  return ATOM_TOKENS.include?(token.symbol)
end

#body (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2482

def body
  @lex_state = EXPR_DATA
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    result = nil
  else
    match(T_LPAR)
    token = lookahead
    if token.symbol == T_LPAR
      result = body_type_mpart
    else
      result = body_type_1part
    end
    match(T_RPAR)
  end
  @lex_state = EXPR_BEG
  return result
end

#body_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2463

def body_data
  token = match(T_ATOM)
  name = token.value.upcase
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
    return name, body
  end
  name.concat(section)
  token = lookahead
  if token.symbol == T_ATOM
    name.concat(token.value)
    shift_token
  end
  match(T_SPACE)
  data = nstring
  return name, data
end

#body_ext_1part (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2669

def body_ext_1part
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return nil
  end
  md5 = nstring

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return md5
  end
  disposition = body_fld_dsp

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return md5, disposition
  end
  language = body_fld_lang

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return md5, disposition, language
  end

  extension = body_extensions
  return md5, disposition, language, extension
end

#body_ext_mpart (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2705

def body_ext_mpart
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return nil
  end
  param = body_fld_param

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return param
  end
  disposition = body_fld_dsp

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return param, disposition
  end
  language = body_fld_lang

  token = lookahead
  if token.symbol == T_SPACE
    shift_token
  else
    return param, disposition, language
  end

  extension = body_extensions
  return param, disposition, language, extension
end

#body_extension (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2795

def body_extension
  token = lookahead
  case token.symbol
  when T_LPAR
    shift_token
    result = body_extensions
    match(T_RPAR)
    return result
  when T_NUMBER
    return number
  else
    return nstring
  end
end

#body_extensions (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2781

def body_extensions
  result = []
  while true
    token = lookahead
    case token.symbol
    when T_RPAR
      return result
    when T_SPACE
      shift_token
    end
    result.push(body_extension)
  end
end

#body_fields (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2631

def body_fields
  param = body_fld_param
  match(T_SPACE)
  content_id = nstring
  match(T_SPACE)
  desc = nstring
  match(T_SPACE)
  enc = case_insensitive_string
  match(T_SPACE)
  size = number
  return param, content_id, desc, enc, size
end

#body_fld_dsp (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2741

def body_fld_dsp
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  end
  match(T_LPAR)
  dsp_type = case_insensitive_string
  match(T_SPACE)
  param = body_fld_param
  match(T_RPAR)
  return ContentDisposition.new(dsp_type, param)
end

#body_fld_lang (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2755

def body_fld_lang
  token = lookahead
  if token.symbol == T_LPAR
    shift_token
    result = []
    while true
      token = lookahead
      case token.symbol
      when T_RPAR
        shift_token
        return result
      when T_SPACE
        shift_token
      end
      result.push(case_insensitive_string)
    end
  else
    lang = nstring
    if lang
      return lang.upcase
    else
      return lang
    end
  end
end

#body_fld_param (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2644

def body_fld_param
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  end
  match(T_LPAR)
  param = {}
  while true
    token = lookahead
    case token.symbol
    when T_RPAR
      shift_token
      break
    when T_SPACE
      shift_token
    end
    name = case_insensitive_string
    match(T_SPACE)
    val = string
    param[name] = val
  end
  return param
end

#body_type_1part (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2502

def body_type_1part
  token = lookahead
  case token.value
  when /\A(?:TEXT)\z/ni
    return body_type_text
  when /\A(?:MESSAGE)\z/ni
    return body_type_msg
  when /\A(?:ATTACHMENT)\z/ni
    return body_type_attachment
  when /\A(?:MIXED)\z/ni
    return body_type_mixed
  else
    return body_type_basic
  end
end

#body_type_attachment (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2588

def body_type_attachment
  mtype = case_insensitive_string
  match(T_SPACE)
  param = body_fld_param
  return BodyTypeAttachment.new(mtype, nil, param)
end

#body_type_basic (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2518

def body_type_basic
  mtype, msubtype = media_type
  token = lookahead
  if token.symbol == T_RPAR
    return BodyTypeBasic.new(mtype, msubtype)
  end
  match(T_SPACE)
  param, content_id, desc, enc, size = body_fields
  md5, disposition, language, extension = body_ext_1part
  return BodyTypeBasic.new(mtype, msubtype,
                           param, content_id,
                           desc, enc, size,
                           md5, disposition, language, extension)
end

#body_type_mixed (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2595

def body_type_mixed
  mtype = "MULTIPART"
  msubtype = case_insensitive_string
  param, disposition, language, extension = body_ext_mpart
  return BodyTypeBasic.new(mtype, msubtype, param, nil, nil, nil, nil, nil, disposition, language, extension)
end

#body_type_mpart (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2602

def body_type_mpart
  parts = []
  while true
    token = lookahead
    if token.symbol == T_SPACE
      shift_token
      break
    end
    parts.push(body)
  end
  mtype = "MULTIPART"
  msubtype = case_insensitive_string
  param, disposition, language, extension = body_ext_mpart
  return BodyTypeMultipart.new(mtype, msubtype, parts,
                               param, disposition, language,
                               extension)
end

#body_type_msg (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2547

def body_type_msg
  mtype, msubtype = media_type
  match(T_SPACE)
  param, content_id, desc, enc, size = body_fields

  token = lookahead
  if token.symbol == T_RPAR
    # If this is not message/rfc822, we shouldn't apply the RFC822
    # spec to it.  We should handle anything other than
    # message/rfc822 using multipart extension data [rfc3501] (i.e.
    # the data itself won't be returned, we would have to retrieve it
    # with BODYSTRUCTURE instead of with BODY

    # Also, sometimes a message/rfc822 is included as a large
    # attachment instead of having all of the other details
    # (e.g. attaching a .eml file to an email)
    if msubtype == "RFC822"
      return BodyTypeMessage.new(mtype, msubtype, param, content_id,
                                 desc, enc, size, nil, nil, nil, nil,
                                 nil, nil, nil)
    else
      return BodyTypeExtension.new(mtype, msubtype,
                                   param, content_id,
                                   desc, enc, size)
    end
  end

  match(T_SPACE)
  env = envelope
  match(T_SPACE)
  b = body
  match(T_SPACE)
  lines = number
  md5, disposition, language, extension = body_ext_1part
  return BodyTypeMessage.new(mtype, msubtype,
                             param, content_id,
                             desc, enc, size,
                             env, b, lines,
                             md5, disposition, language, extension)
end

#body_type_text (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2533

def body_type_text
  mtype, msubtype = media_type
  match(T_SPACE)
  param, content_id, desc, enc, size = body_fields
  match(T_SPACE)
  lines = number
  md5, disposition, language, extension = body_ext_1part
  return BodyTypeText.new(mtype, msubtype,
                          param, content_id,
                          desc, enc, size,
                          lines,
                          md5, disposition, language, extension)
end

#capability_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3112

def capability_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  data = []
  while true
    token = lookahead
    case token.symbol
    when T_CRLF
      break
    when T_SPACE
      shift_token
      next
    end
    data.push(atom.upcase)
  end
  return UntaggedResponse.new(name, data, @str)
end

#case_insensitive_string (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3291

def case_insensitive_string
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  end
  token = match(T_QUOTED, T_LITERAL)
  return token.value.upcase
end

#continue_req (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2270

def continue_req
  match(T_PLUS)
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
    return ContinuationRequest.new(resp_text, @str)
  else
    return ContinuationRequest.new(ResponseText.new(nil, ""), @str)
  end
end

#envelope (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2394

def envelope
  @lex_state = EXPR_DATA
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    result = nil
  else
    match(T_LPAR)
    date = nstring
    match(T_SPACE)
    subject = nstring
    match(T_SPACE)
    from = address_list
    match(T_SPACE)
    sender = address_list
    match(T_SPACE)
    reply_to = address_list
    match(T_SPACE)
    to = address_list
    match(T_SPACE)
    cc = address_list
    match(T_SPACE)
    bcc = address_list
    match(T_SPACE)
    in_reply_to = nstring
    match(T_SPACE)
    message_id = nstring
    match(T_RPAR)
    result = Envelope.new(date, subject, from, sender, reply_to,
                          to, cc, bcc, in_reply_to, message_id)
  end
  @lex_state = EXPR_BEG
  return result
end

#envelope_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2387

def envelope_data
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return name, envelope
end

#flag_list (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3236

def flag_list
  if @str.index(/\(([^)]*)\)/ni, @pos)
    @pos = $~.end(0)
    return $1.scan(FLAG_REGEXP).collect { |flag, atom|
      if atom
        atom
      else
        symbol = flag.capitalize.untaint.intern
        @flag_symbols[symbol] = true
        if @flag_symbols.length > IMAP.max_flag_count
          raise FlagCountError, "number of flag symbols exceeded"
        end
        symbol
      end
    }
  else
    parse_error("invalid flag list")
  end
end

#flags_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2429

def flags_data
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return name, flag_list
end

#flags_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2888

def flags_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return UntaggedResponse.new(name, flag_list, @str)
end

#format_string(str) (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2845

def format_string(str)
  case str
  when ""
    return '""'
  when /[\x80-\xff\r\n]/n
    # literal
    return "{" + str.bytesize.to_s + "}" + CRLF + str
  when /[(){ \x00-\x1f\x7f%*"\\]/n
    # quoted string
    return '"' + str.gsub(/["\\]/n, "\\\\\\&") + '"'
  else
    # atom
    return str
  end
end

#getacl_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2966

def getacl_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  mailbox = astring
  data = []
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
    while true
      token = lookahead
      case token.symbol
      when T_CRLF
        break
      when T_SPACE
        shift_token
      end
      user = astring
      match(T_SPACE)
      rights = astring
      data.push(MailboxACLItem.new(user, rights, mailbox))
    end
  end
  return UntaggedResponse.new(name, data, @str)
end

#getquota_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2916

def getquota_response
  # If quota never established, get back
  # `NO Quota root does not exist'.
  # If quota removed, get `()' after the
  # folder spec with no mention of `STORAGE'.
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  mailbox = astring
  match(T_SPACE)
  match(T_LPAR)
  token = lookahead
  case token.symbol
  when T_RPAR
    shift_token
    data = MailboxQuota.new(mailbox, nil, nil)
    return UntaggedResponse.new(name, data, @str)
  when T_ATOM
    shift_token
    match(T_SPACE)
    token = match(T_NUMBER)
    usage = token.value
    match(T_SPACE)
    token = match(T_NUMBER)
    quota = token.value
    match(T_RPAR)
    data = MailboxQuota.new(mailbox, usage, quota)
    return UntaggedResponse.new(name, data, @str)
  else
    parse_error("unexpected token %s", token.symbol)
  end
end

#getquotaroot_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2949

def getquotaroot_response
  # Similar to getquota, but only admin can use getquota.
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  mailbox = astring
  quotaroots = []
  while true
    token = lookahead
    break unless token.symbol == T_SPACE
    shift_token
    quotaroots.push(astring)
  end
  data = MailboxQuotaRoot.new(mailbox, quotaroots)
  return UntaggedResponse.new(name, data, @str)
end

#internaldate_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2436

def internaldate_data
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  token = match(T_QUOTED)
  return name, token.value
end

#list_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2895

def list_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return UntaggedResponse.new(name, mailbox_list, @str)
end

#lookahead (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3357

def lookahead
  unless @token
    @token = next_token
  end
  return @token
end

#mailbox_list (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2902

def mailbox_list
  attr = flag_list
  match(T_SPACE)
  token = match(T_QUOTED, T_NIL)
  if token.symbol == T_NIL
    delim = nil
  else
    delim = token.value
  end
  match(T_SPACE)
  name = astring
  return MailboxList.new(attr, delim, name)
end

#match(*args) (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3346

def match(*args)
  token = lookahead
  unless args.include?(token.symbol)
    parse_error('unexpected token %s (expected %s)',
                token.symbol.id2name,
                args.collect {|i| i.id2name}.join(" or "))
  end
  shift_token
  return token
end

#media_type (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2620

def media_type
  mtype = case_insensitive_string
  token = lookahead
  if token.symbol != T_SPACE
    return mtype, nil
  end
  match(T_SPACE)
  msubtype = case_insensitive_string
  return mtype, msubtype
end

#modseq_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2868

def modseq_data
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  match(T_LPAR)
  modseq = number
  match(T_RPAR)
  return name, modseq
end

#msg_att(n) (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2349

def msg_att(n)
  match(T_LPAR)
  attr = {}
  while true
    token = lookahead
    case token.symbol
    when T_RPAR
      shift_token
      break
    when T_SPACE
      shift_token
      next
    end
    case token.value
    when /\A(?:ENVELOPE)\z/ni
      name, val = envelope_data
    when /\A(?:FLAGS)\z/ni
      name, val = flags_data
    when /\A(?:INTERNALDATE)\z/ni
      name, val = internaldate_data
    when /\A(?:RFC822(?:\.HEADER|\.TEXT)?)\z/ni
      name, val = rfc822_text
    when /\A(?:RFC822\.SIZE)\z/ni
      name, val = rfc822_size
    when /\A(?:BODY(?:STRUCTURE)?)\z/ni
      name, val = body_data
    when /\A(?:UID)\z/ni
      name, val = uid_data
    when /\A(?:MODSEQ)\z/ni
      name, val = modseq_data
    else
      parse_error("unknown attribute `%s' for {%d}", token.value, n)
    end
    attr[name] = val
  end
  return attr
end

#next_token (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3368

def next_token
  case @lex_state
  when EXPR_BEG
    if @str.index(BEG_REGEXP, @pos)
      @pos = $~.end(0)
      if $1
        return Token.new(T_SPACE, $+)
      elsif $2
        return Token.new(T_NIL, $+)
      elsif $3
        return Token.new(T_NUMBER, $+)
      elsif $4
        return Token.new(T_ATOM, $+)
      elsif $5
        return Token.new(T_QUOTED,
                         $+.gsub(/\\(["\\])/n, "\\1"))
      elsif $6
        return Token.new(T_LPAR, $+)
      elsif $7
        return Token.new(T_RPAR, $+)
      elsif $8
        return Token.new(T_BSLASH, $+)
      elsif $9
        return Token.new(T_STAR, $+)
      elsif $10
        return Token.new(T_LBRA, $+)
      elsif $11
        return Token.new(T_RBRA, $+)
      elsif $12
        len = $+.to_i
        val = @str[@pos, len]
        @pos += len
        return Token.new(T_LITERAL, val)
      elsif $13
        return Token.new(T_PLUS, $+)
      elsif $14
        return Token.new(T_PERCENT, $+)
      elsif $15
        return Token.new(T_CRLF, $+)
      elsif $16
        return Token.new(T_EOF, $+)
      else
        parse_error("[Net::IMAP BUG] BEG_REGEXP is invalid")
      end
    else
      @str.index(/\S*/n, @pos)
      parse_error("unknown token - %s", $&.dump)
    end
  when EXPR_DATA
    if @str.index(DATA_REGEXP, @pos)
      @pos = $~.end(0)
      if $1
        return Token.new(T_SPACE, $+)
      elsif $2
        return Token.new(T_NIL, $+)
      elsif $3
        return Token.new(T_NUMBER, $+)
      elsif $4
        return Token.new(T_QUOTED,
                         $+.gsub(/\\(["\\])/n, "\\1"))
      elsif $5
        len = $+.to_i
        val = @str[@pos, len]
        @pos += len
        return Token.new(T_LITERAL, val)
      elsif $6
        return Token.new(T_LPAR, $+)
      elsif $7
        return Token.new(T_RPAR, $+)
      else
        parse_error("[Net::IMAP BUG] DATA_REGEXP is invalid")
      end
    else
      @str.index(/\S*/n, @pos)
      parse_error("unknown token - %s", $&.dump)
    end
  when EXPR_TEXT
    if @str.index(TEXT_REGEXP, @pos)
      @pos = $~.end(0)
      if $1
        return Token.new(T_TEXT, $+)
      else
        parse_error("[Net::IMAP BUG] TEXT_REGEXP is invalid")
      end
    else
      @str.index(/\S*/n, @pos)
      parse_error("unknown token - %s", $&.dump)
    end
  when EXPR_RTEXT
    if @str.index(RTEXT_REGEXP, @pos)
      @pos = $~.end(0)
      if $1
        return Token.new(T_LBRA, $+)
      elsif $2
        return Token.new(T_TEXT, $+)
      else
        parse_error("[Net::IMAP BUG] RTEXT_REGEXP is invalid")
      end
    else
      @str.index(/\S*/n, @pos)
      parse_error("unknown token - %s", $&.dump)
    end
  when EXPR_CTEXT
    if @str.index(CTEXT_REGEXP, @pos)
      @pos = $~.end(0)
      if $1
        return Token.new(T_TEXT, $+)
      else
        parse_error("[Net::IMAP BUG] CTEXT_REGEXP is invalid")
      end
    else
      @str.index(/\S*/n, @pos) #/
      parse_error("unknown token - %s", $&.dump)
    end
  else
    parse_error("invalid @lex_state - %s", @lex_state.inspect)
  end
end

#nil_atom (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3341

def nil_atom
  match(T_NIL)
  return nil
end

#nstring (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3256

def nstring
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  else
    return string
  end
end

#number (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3331

def number
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  end
  token = match(T_NUMBER)
  return token.value.to_i
end

#numeric_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2333

def numeric_response
  n = number
  match(T_SPACE)
  token = match(T_ATOM)
  name = token.value.upcase
  case name
  when "EXISTS", "RECENT", "EXPUNGE"
    return UntaggedResponse.new(name, n, @str)
  when "FETCH"
    shift_token
    match(T_SPACE)
    data = FetchData.new(n, msg_att(n))
    return UntaggedResponse.new(name, data, @str)
  end
end

#parse(str)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2178

def parse(str)
  @str = str
  @pos = 0
  @lex_state = EXPR_BEG
  @token = nil
  return response
end

#parse_error(fmt, *args) (private)

Raises:

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3487

def parse_error(fmt, *args)
  if IMAP.debug
    $stderr.printf("@str: %s\n", @str.dump)
    $stderr.printf("@pos: %d\n", @pos)
    $stderr.printf("@lex_state: %s\n", @lex_state)
    if @token
      $stderr.printf("@token.symbol: %s\n", @token.symbol)
      $stderr.printf("@token.value: %s\n", @token.value.inspect)
    end
  end
  raise ResponseParseError, format(fmt, *args)
end

#resp_text (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3131

def resp_text
  @lex_state = EXPR_RTEXT
  token = lookahead
  if token.symbol == T_LBRA
    code = resp_text_code
  else
    code = nil
  end
  token = match(T_TEXT)
  @lex_state = EXPR_BEG
  return ResponseText.new(code, token.value)
end

#resp_text_code (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3144

def resp_text_code
  @lex_state = EXPR_BEG
  match(T_LBRA)
  token = match(T_ATOM)
  name = token.value.upcase
  case name
  when /\A(?:ALERT|PARSE|READ-ONLY|READ-WRITE|TRYCREATE|NOMODSEQ)\z/n
    result = ResponseCode.new(name, nil)
  when /\A(?:PERMANENTFLAGS)\z/n
    match(T_SPACE)
    result = ResponseCode.new(name, flag_list)
  when /\A(?:UIDVALIDITY|UIDNEXT|UNSEEN)\z/n
    match(T_SPACE)
    result = ResponseCode.new(name, number)
  else
    token = lookahead
    if token.symbol == T_SPACE
      shift_token
      @lex_state = EXPR_CTEXT
      token = match(T_TEXT)
      @lex_state = EXPR_BEG
      result = ResponseCode.new(name, token.value)
    else
      result = ResponseCode.new(name, nil)
    end
  end
  match(T_RBRA)
  @lex_state = EXPR_RTEXT
  return result
end

#response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2251

def response
  token = lookahead
  case token.symbol
  when T_PLUS
    result = continue_req
  when T_STAR
    result = response_untagged
  else
    result = response_tagged
  end
  while lookahead.symbol == T_SPACE
    # Ignore trailing space for Microsoft Exchange Server
    shift_token
  end
  match(T_CRLF)
  match(T_EOF)
  return result
end

#response_cond (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2326

def response_cond
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return UntaggedResponse.new(name, resp_text, @str)
end

#response_tagged (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2317

def response_tagged
  tag = atom
  match(T_SPACE)
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return TaggedResponse.new(tag, name, resp_text, @str)
end

#response_untagged (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2281

def response_untagged
  match(T_STAR)
  match(T_SPACE)
  token = lookahead
  if token.symbol == T_NUMBER
    return numeric_response
  elsif token.symbol == T_ATOM
    case token.value
    when /\A(?:OK|NO|BAD|BYE|PREAUTH)\z/ni
      return response_cond
    when /\A(?:FLAGS)\z/ni
      return flags_response
    when /\A(?:LIST|LSUB|XLIST)\z/ni
      return list_response
    when /\A(?:QUOTA)\z/ni
      return getquota_response
    when /\A(?:QUOTAROOT)\z/ni
      return getquotaroot_response
    when /\A(?:ACL)\z/ni
      return getacl_response
    when /\A(?:SEARCH|SORT)\z/ni
      return search_response
    when /\A(?:THREAD)\z/ni
      return thread_response
    when /\A(?:STATUS)\z/ni
      return status_response
    when /\A(?:CAPABILITY)\z/ni
      return capability_response
    else
      return text_response
    end
  else
    parse_error("unexpected token %s", token.symbol)
  end
end

#rfc822_size (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2456

def rfc822_size
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return name, number
end

#rfc822_text (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2444

def rfc822_text
  token = match(T_ATOM)
  name = token.value.upcase
  token = lookahead
  if token.symbol == T_LBRA
    shift_token
    match(T_RBRA)
  end
  match(T_SPACE)
  return name, nstring
end

#search_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2992

def search_response
  token = match(T_ATOM)
  name = token.value.upcase
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
    data = []
    while true
      token = lookahead
      case token.symbol
      when T_CRLF
        break
      when T_SPACE
        shift_token
      when T_NUMBER
        data.push(number)
      when T_LPAR
        # TODO: include the MODSEQ value in a response
        shift_token
        match(T_ATOM)
        match(T_SPACE)
        match(T_NUMBER)
        match(T_RPAR)
      end
    end
  else
    data = []
  end
  return UntaggedResponse.new(name, data, @str)
end

#section (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2810

def section
  str = String.new
  token = match(T_LBRA)
  str.concat(token.value)
  token = match(T_ATOM, T_NUMBER, T_RBRA)
  if token.symbol == T_RBRA
    str.concat(token.value)
    return str
  end
  str.concat(token.value)
  token = lookahead
  if token.symbol == T_SPACE
    shift_token
    str.concat(token.value)
    token = match(T_LPAR)
    str.concat(token.value)
    while true
      token = lookahead
      case token.symbol
      when T_RPAR
        str.concat(token.value)
        shift_token
        break
      when T_SPACE
        shift_token
        str.concat(token.value)
      end
      str.concat(format_string(astring))
    end
  end
  token = match(T_RBRA)
  str.concat(token.value)
  return str
end

#shift_token (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3364

def shift_token
  @token = nil
end

#status_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3085

def status_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  mailbox = astring
  match(T_SPACE)
  match(T_LPAR)
  attr = {}
  while true
    token = lookahead
    case token.symbol
    when T_RPAR
      shift_token
      break
    when T_SPACE
      shift_token
    end
    token = match(T_ATOM)
    key = token.value.upcase
    match(T_SPACE)
    val = number
    attr[key] = val
  end
  data = StatusData.new(mailbox, attr)
  return UntaggedResponse.new(name, data, @str)
end

#string (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3275

def string
  token = lookahead
  if token.symbol == T_NIL
    shift_token
    return nil
  end
  token = match(T_QUOTED, T_LITERAL)
  return token.value
end

#string_token?(token) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3287

def string_token?(token)
  return STRING_TOKENS.include?(token.symbol)
end

#text_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2878

def text_response
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  @lex_state = EXPR_TEXT
  token = match(T_TEXT)
  @lex_state = EXPR_BEG
  return UntaggedResponse.new(name, token.value)
end

#thread_branch(token) (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3050

def thread_branch(token)
  rootmember = nil
  lastmember = nil

  while true
    shift_token    # ignore first T_LPAR
    token = lookahead

    case token.symbol
    when T_NUMBER
      # new member
      newmember = ThreadMember.new(number, [])
      if rootmember.nil?
        rootmember = newmember
      else
        lastmember.children << newmember
      end
      lastmember = newmember
    when T_SPACE
      # do nothing
    when T_LPAR
      if rootmember.nil?
        # dummy member
        lastmember = rootmember = ThreadMember.new(nil, [])
      end

      lastmember.children << thread_branch(token)
    when T_RPAR
      break
    end
  end

  return rootmember
end

#thread_response (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 3023

def thread_response
  token = match(T_ATOM)
  name = token.value.upcase
  token = lookahead

  if token.symbol == T_SPACE
    threads = []

    while true
      shift_token
      token = lookahead

      case token.symbol
      when T_LPAR
        threads << thread_branch(token)
      when T_CRLF
        break
      end
    end
  else
    # no member
    threads = []
  end

  return UntaggedResponse.new(name, threads, @str)
end

#uid_data (private)

[ GitHub ]

  
# File 'lib/net/imap.rb', line 2861

def uid_data
  token = match(T_ATOM)
  name = token.value.upcase
  match(T_SPACE)
  return name, number
end