Class: Mail::Body

Inherits:
Object
  • Object
show all
Defined in:
lib/mail/body.rb

Overview

Body

The body is where the text of the email is stored. Mail treats the body as a single object. The body itself has no information about boundaries used in the MIME standard, it just looks at its content as either a single block of text, or (if it is a multipart message) as an array of blocks of text.

A body has to be told to split itself up into a multipart message by calling #split with the correct boundary. This is because the body object has no way of knowing what the correct boundary is for itself (there could be many boundaries in a body in the case of a nested MIME text).

Once split is called, Mail::Body will slice itself up on this boundary, assigning anything that appears before the first part to the preamble, and anything that appears after the closing boundary to the epilogue, then each part gets initialized into a Mail::Part object.

The boundary that is used to split up the Body is also stored in the Body object for use on encoding itself back out to a string. You can overwrite this if it needs to be changed.

On encoding, the body will return the preamble, then each part joined by the boundary, followed by a closing boundary string and then the epilogue.

Instance Method Summary collapse

Constructor Details

#initialize(string = '') ⇒ Body

Returns a new instance of Body.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/mail/body.rb', line 30

def initialize(string = '')
  @boundary = nil
  @preamble = nil
  @epilogue = nil
  @charset  = nil
  @part_sort_order = [ "text/plain", "text/enriched", "text/html", "multipart/alternative" ]
  @parts = Mail::PartsList.new
  if Utilities.blank?(string)
    @raw_source = ''
  else
    # Do join first incase we have been given an Array in Ruby 1.9
    if string.respond_to?(:join)
      @raw_source = string.join('')
    elsif string.respond_to?(:to_s)
      @raw_source = string.to_s
    else
      raise "You can only assign a string or an object that responds_to? :join or :to_s to a body."
    end
  end
  @encoding = default_encoding
  set_charset
end

Instance Method Details

#<<(val) ⇒ Object 



250
251
252
253
254
255
256
 
# File 'lib/mail/body.rb', line 250

def <<( val )
  if @parts
    @parts << val
  else
    @parts = Mail::PartsList.new[val]
  end
end

#==(other) ⇒ Object

Matches this body with another body. Also matches the decoded value of this body with a string.

Examples:

body = Mail::Body.new('The body')
body == body #=> true

body = Mail::Body.new('The body')
body == 'The body' #=> true

body = Mail::Body.new("VGhlIGJvZHk=\n")
body.encoding = 'base64'
body == "The body" #=> true



67
68
69
70
71
72
73
 
# File 'lib/mail/body.rb', line 67

def ==(other)
  if other.class == String
    self.decoded == other
  else
    super
  end
end

#=~(regexp) ⇒ Object

Accepts a string and performs a regular expression against the decoded text

Examples:

body = Mail::Body.new('The body')
body =~ /The/ #=> 0

body = Mail::Body.new("VGhlIGJvZHk=\n")
body.encoding = 'base64'
body =~ /The/ #=> 0



85
86
87
 
# File 'lib/mail/body.rb', line 85

def =~(regexp)
  self.decoded =~ regexp
end

#ascii_only? ⇒ Boolean

Returns:

  • (Boolean) 


270
271
272
273
274
275
 
# File 'lib/mail/body.rb', line 270

def ascii_only?
  unless defined? @ascii_only
    @ascii_only = raw_source.ascii_only?
  end
  @ascii_only
end

#boundary ⇒ Object

Returns the boundary used by the body



237
238
239
 
# File 'lib/mail/body.rb', line 237

def boundary
  @boundary
end

#boundary=(val) ⇒ Object

Allows you to change the boundary of this Body object



242
243
244
 
# File 'lib/mail/body.rb', line 242

def boundary=( val )
  @boundary = val
end

#charset ⇒ Object 



186
187
188
 
# File 'lib/mail/body.rb', line 186

def charset
  @charset
end

#charset=(val) ⇒ Object 



190
191
192
 
# File 'lib/mail/body.rb', line 190

def charset=( val )
  @charset = val
end

#decoded ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/mail/body.rb', line 174

def decoded
  if !Encodings.defined?(encoding)
    raise UnknownEncodingType, "Don't know how to decode #{encoding}, please call #encoded and decode it yourself."
  else
    Encodings.get_encoding(encoding).decode(raw_source)
  end
end

#default_encoding ⇒ Object 



281
282
283
 
# File 'lib/mail/body.rb', line 281

def default_encoding
  ascii_only? ? '7bit' : '8bit'
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


277
278
279
 
# File 'lib/mail/body.rb', line 277

def empty?
  !!raw_source.to_s.empty?
end

#encoded(transfer_encoding = nil) ⇒ Object

Returns a body encoded using transfer_encoding. Multipart always uses an identiy encoding (i.e. no encoding). Calling this directly is not a good idea, but supported for compatibility TODO: Validate that preamble and epilogue are valid for requested encoding



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/mail/body.rb', line 150

def encoded(transfer_encoding = nil)
  if multipart?
    self.sort_parts!
    encoded_parts = parts.map { |p| p.encoded }
    ([preamble] + encoded_parts).join(crlf_boundary) + end_boundary + epilogue.to_s
  else
    dec = Mail::Encodings.get_encoding(encoding)
    enc = negotiate_best_encoding(transfer_encoding)
    if dec.nil?
      # Cannot decode, so skip normalization
      raw_source
    else
      # Decode then encode to normalize and allow transforming 
      # from base64 to Q-P and vice versa
      decoded = dec.decode(raw_source)
      if defined?(Encoding) && charset && charset != "US-ASCII"
        decoded = decoded.encode(charset)
        decoded.force_encoding('BINARY') unless Encoding.find(charset).ascii_compatible?
      end
      enc.encode(decoded)
    end
  end
end

#encoding(val = nil) ⇒ Object 



194
195
196
197
198
199
200
 
# File 'lib/mail/body.rb', line 194

def encoding(val = nil)
  if val
    self.encoding = val
  else
    @encoding
  end
end

#encoding=(val) ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'lib/mail/body.rb', line 202

def encoding=( val )
  @encoding =
    if val == "text" || Utilities.blank?(val)
      default_encoding
    else
      val
    end
end

#epilogue ⇒ Object

Returns the epilogue (any text that is after the last MIME boundary)



222
223
224
 
# File 'lib/mail/body.rb', line 222

def epilogue
  @epilogue
end

#epilogue=(val) ⇒ Object

Sets the epilogue to a string (adds text after the last MIME boundary)



227
228
229
 
# File 'lib/mail/body.rb', line 227

def epilogue=( val )
  @epilogue = val
end

#include?(other) ⇒ Boolean

Accepts anything that responds to #to_s and checks if it’s a substring of the decoded text

Examples:

body = Mail::Body.new('The body')
body.include?('The') #=> true

body = Mail::Body.new("VGhlIGJvZHk=\n")
body.encoding = 'base64'
body.include?('The') #=> true

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/mail/body.rb', line 113

def include?(other)
  self.decoded.include?(other.to_s)
end

#match(regexp) ⇒ Object

Accepts a string and performs a regular expression against the decoded text

Examples:

body = Mail::Body.new('The body')
body.match(/The/) #=> #<MatchData "The">

body = Mail::Body.new("VGhlIGJvZHk=\n")
body.encoding = 'base64'
body.match(/The/) #=> #<MatchData "The">



99
100
101
 
# File 'lib/mail/body.rb', line 99

def match(regexp)
  self.decoded.match(regexp)
end

#multipart? ⇒ Boolean

Returns true if there are parts defined in the body

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/mail/body.rb', line 232

def multipart?
  true unless parts.empty?
end

#negotiate_best_encoding(message_encoding, allowed_encodings = nil) ⇒ Object 



142
143
144
 
# File 'lib/mail/body.rb', line 142

def negotiate_best_encoding(message_encoding, allowed_encodings = nil)
  Mail::Encodings::TransferEncoding.negotiate(message_encoding, encoding, raw_source, allowed_encodings)
end

#parts ⇒ Object 



246
247
248
 
# File 'lib/mail/body.rb', line 246

def parts
  @parts
end

#preamble ⇒ Object

Returns the preamble (any text that is before the first MIME boundary)



212
213
214
 
# File 'lib/mail/body.rb', line 212

def preamble
  @preamble
end

#preamble=(val) ⇒ Object

Sets the preamble to a string (adds text before the first MIME boundary)



217
218
219
 
# File 'lib/mail/body.rb', line 217

def preamble=( val )
  @preamble = val
end

#raw_source ⇒ Object

Returns the raw source that the body was initialized with, without any tampering



138
139
140
 
# File 'lib/mail/body.rb', line 138

def raw_source
  @raw_source
end

#set_sort_order(order) ⇒ Object

Allows you to set the sort order of the parts, overriding the default sort order. Defaults to ‘text/plain’, then ‘text/enriched’, then ‘text/html’, then ‘multipart/alternative’ with any other content type coming after.



120
121
122
 
# File 'lib/mail/body.rb', line 120

def set_sort_order(order)
  @part_sort_order = order
end

#sort_parts! ⇒ Object

Allows you to sort the parts according to the default sort order, or the sort order you set with :set_sort_order.

sort_parts! is also called from :encode, so there is no need for you to call this explicitly



128
129
130
131
132
133
134
 
# File 'lib/mail/body.rb', line 128

def sort_parts!
  @parts.each do |p|
    p.body.set_sort_order(@part_sort_order)
    p.body.sort_parts!
  end
  @parts.sort!(@part_sort_order)
end

#split!(boundary) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/mail/body.rb', line 258

def split!(boundary)
  self.boundary = boundary
  parts = extract_parts

  # Make the preamble equal to the preamble (if any)
  self.preamble = parts[0].to_s.strip
  # Make the epilogue equal to the epilogue (if any)
  self.epilogue = parts[-1].to_s.strip
  parts[1...-1].to_a.each { |part| @parts << Mail::Part.new(part) }
  self
end

#to_s ⇒ Object 



182
183
184
 
# File 'lib/mail/body.rb', line 182

def to_s
  decoded
end