Class: Mail::AttachmentsList

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

Instance Method Summary collapse

Constructor Details

#initialize(parts_list) ⇒ AttachmentsList



4
5
6
7
8
9
10
11
12
13
14
15
16
17
# File 'lib/mail/attachments_list.rb', line 4

def initialize(parts_list)
  @parts_list = parts_list
  @content_disposition_type = 'attachment'
  parts_list.map { |p|
    if p.content_type == "message/rfc822"
      Mail.new(p.body).attachments
    elsif p.parts.empty?
      p if p.attachment?
    else
      p.attachments
    end
  }.flatten.compact.each { |a| self << a }
  self
end

Instance Method Details

#[](index_value) ⇒ Object

Returns the attachment by filename or at index.

mail.attachments = File.read('test.png') mail.attachments = File.read('test.jpg')

mail.attachments.filename #=> 'test.png' mail.attachments.filename #=> 'test.jpg'



31
32
33
34
35
36
37
# File 'lib/mail/attachments_list.rb', line 31

def [](index_value)
  if index_value.is_a?(Fixnum)
    self.fetch(index_value)
  else
    self.select { |a| a.filename == index_value }.first
  end
end

#[]=(name, value) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/mail/attachments_list.rb', line 39

def []=(name, value)
  encoded_name = Mail::Encodings.decode_encode name, :encode
  default_values = { :content_type => "#{set_mime_type(name)}; filename=\"#{encoded_name}\"",
                     :content_transfer_encoding => "#{guess_encoding}",
                     :content_disposition => "#{@content_disposition_type}; filename=\"#{encoded_name}\"" }

  if value.is_a?(Hash)

    default_values[:body] = value.delete(:content) if value[:content]

    default_values[:body] = value.delete(:data) if value[:data]

    encoding = value.delete(:transfer_encoding) || value.delete(:encoding)
    if encoding
      if Mail::Encodings.defined? encoding
        default_values[:content_transfer_encoding] = encoding
      else
        raise "Do not know how to handle Content Transfer Encoding #{encoding}, please choose either quoted-printable or base64"
      end
    end

    if value[:mime_type]
      default_values[:content_type] = value.delete(:mime_type)
      @mime_type = MIME::Types[default_values[:content_type]].first
      default_values[:content_transfer_encoding] ||= guess_encoding
    end

    hash = default_values.merge(value)
  else
    default_values[:body] = value
    hash = default_values
  end

  if hash[:body].respond_to? :force_encoding and hash[:body].respond_to? :valid_encoding?
    if not hash[:body].valid_encoding? and default_values[:content_transfer_encoding].downcase == "binary"
      hash[:body].force_encoding("BINARY")
    end
  end

  attachment = Part.new(hash)
  attachment.add_content_id(hash[:content_id])

  @parts_list << attachment
end

#guess_encodingObject

Uses the mime type to try and guess the encoding, if it is a binary type, or unknown, then we set it to binary, otherwise as set to plain text



86
87
88
89
90
91
92
# File 'lib/mail/attachments_list.rb', line 86

def guess_encoding
  if @mime_type && !@mime_type.binary?
    "7bit"
  else
    "binary"
  end
end

#inlineObject



19
20
21
22
# File 'lib/mail/attachments_list.rb', line 19

def inline
  @content_disposition_type = 'inline'
  self
end

#set_mime_type(filename) ⇒ Object



94
95
96
97
98
99
100
101
# File 'lib/mail/attachments_list.rb', line 94

def set_mime_type(filename)
  # Have to do this because MIME::Types is not Ruby 1.9 safe yet
  if RUBY_VERSION >= '1.9'
    filename = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
  end

  @mime_type = MIME::Types.type_for(filename).first
end