Class: InternetMessage::HeaderField

Inherits:
Object
  • Object
show all
Defined in:
lib/internet_message/header_field.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, value, raw) ⇒ HeaderField

Returns a new instance of HeaderField.

Parameters:

  • name (String) —

    field name

  • value (MmapScanner) —

    field value

  • raw (MmapScanner) —

    field line



8
9
10
 
# File 'lib/internet_message/header_field.rb', line 8

def initialize(name, value, raw)
  @name, @orig_value, @raw = name, value, raw
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



3
4
5
 
# File 'lib/internet_message/header_field.rb', line 3

def name
  @name
end

#orig_value ⇒ Object (readonly)

Returns the value of attribute orig_value.



3
4
5
 
# File 'lib/internet_message/header_field.rb', line 3

def orig_value
  @orig_value
end

#raw ⇒ Object (readonly)

Returns the value of attribute raw.



3
4
5
 
# File 'lib/internet_message/header_field.rb', line 3

def raw
  @raw
end

Class Method Details

.parse_addrlist(str, decode_mime_header = nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/internet_message/header_field.rb', line 73

def self.parse_addrlist(str, decode_mime_header=nil)
  ret = []
  tokens = Tokenizer.new(str).tokenize2
  until tokens.empty?
    i = tokens.index(Token.new(:CHAR, ','))
    if i == 0
      tokens.shift
      next
    end
    j = tokens.index(Token.new(:CHAR, ':'))
    if i && j && j < i || !i && j
      i = tokens.index(Token.new(:CHAR, ';')) || -1
      ret.push Group.parse(tokens.slice!(0..i), decode_mime_header)
    elsif i
      ret.push Mailbox.parse(tokens.slice!(0..i-1), decode_mime_header)
    else
      ret.push Mailbox.parse(tokens, decode_mime_header)
      tokens.clear
    end
  end
  ret
end

.parse_keywords(str, decode_mime_header = nil) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/internet_message/header_field.rb', line 97

def self.parse_keywords(str, decode_mime_header=nil)
  keys = []
  tokens = Tokenizer.new(str).tokenize2
  while true
    i = tokens.index(Token.new(:CHAR, ','))
    break unless i
    if i > 0
      key = decode_mime_header ? InternetMessage.decode_mime_header_words(tokens[0, i]) : tokens[0, i].join(' ')
      keys.push key
    end
    tokens.shift i+1
  end
  unless tokens.empty?
    key = decode_mime_header ? InternetMessage.decode_mime_header_words(tokens) : tokens.join(' ')
    keys.push key
  end
  keys
end

.parse_mailboxlist(str, decode_mime_header = nil) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/internet_message/header_field.rb', line 53

def self.parse_mailboxlist(str, decode_mime_header=nil)
  ret = []
  tokens = Tokenizer.new(str).tokenize2
  until tokens.empty?
    i = tokens.index(Token.new(:CHAR, ','))
    if i == 0
      tokens.shift
      next
    end
    if i
      ret.push Mailbox.parse(tokens.slice!(0..i-1), decode_mime_header)
    else
      ret.push Mailbox.parse(tokens, decode_mime_header)
      tokens.clear
    end
  end
  ret
end

.parse_return_path(str) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/internet_message/header_field.rb', line 117

def self.parse_return_path(str)
  tokens = Tokenizer.new(str).tokenize2
  i = tokens.index(Token.new(:CHAR, '<'))
  return unless i
  tokens.shift i+1
  i = tokens.index(Token.new(:CHAR, '>'))
  return unless i
  tokens = tokens[0, i]
  i = tokens.rindex(Token.new(:CHAR, '@'))
  i && Address.new(tokens[0, i].join, tokens[i+1..-1].join)
end

Instance Method Details

#parse(decode_mime_header = nil) ⇒ Object

Returns parsed value.

Parameters:

  • decode_mime_header (true, false) (defaults to: nil) —

    Set true to decode MIME header (RFC2047).

Returns:

  • parsed value



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
 
# File 'lib/internet_message/header_field.rb', line 19

def parse(decode_mime_header=nil)
  case @name
  when 'date', 'resent-date'
    DateTime.parse(value.gsub(/\r?\n/, '')) rescue nil
  when 'from', 'resent-from'
    self.class.parse_mailboxlist(value, decode_mime_header)
  when 'from', 'sender', 'resent-from', 'resent-sender'
    Mailbox.parse(value, decode_mime_header)
  when 'message-id', 'content-id', 'resent-message-id'
    MessageId.parse(value)
  when 'in-reply-to', 'references'
    MessageId.parse_list(value)
  when 'mime-version', 'content-transfer-encoding'
    tokens = Tokenizer.new(value).tokenize2
    tokens.empty? ? nil : tokens.join
  when 'content-type'
    ContentType.parse(value)
  when 'content-disposition'
    ContentDisposition.parse(value)
  when 'reply-to', 'to', 'cc', 'bcc', 'resent-to', 'resent-cc', 'resent-bcc'
    self.class.parse_addrlist(value, decode_mime_header)
  when 'keywords'
    self.class.parse_keywords(value, decode_mime_header)
  when 'return-path'
    self.class.parse_return_path(value)
  when 'received'
    Received.parse value
  else
    s = value.gsub(/\r?\n/, '')
    decode_mime_header ? InternetMessage.decode_mime_header_str(s) : s
  end
end

#value ⇒ String

Returns value as String.

Returns:

  • (String) —

    value as String



13
14
15
 
# File 'lib/internet_message/header_field.rb', line 13

def value
  @orig_value.to_s
end