Class: Mail::ContentTypeField

Inherits:
StructuredField show all
Defined in:
lib/mail/fields/content_type_field.rb

Constant Summary

FIELD_NAME =
'content-type'
CAPITALIZED_FIELD =
'Content-Type'

Constants included from Patterns

Patterns::ATOM_UNSAFE, Patterns::CONTROL_CHAR, Patterns::CRLF, Patterns::FIELD_BODY, Patterns::FIELD_LINE, Patterns::FIELD_PREFIX, Patterns::FIELD_SPLIT, Patterns::FWS, Patterns::HEADER_LINE, Patterns::HEADER_SPLIT, Patterns::PHRASE_UNSAFE, Patterns::QP_SAFE, Patterns::QP_UNSAFE, Patterns::TEXT, Patterns::TOKEN_UNSAFE, Patterns::WSP

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from StructuredField

#charset, #charset=, #errors

Methods included from Utilities

#atom_safe?, #bracket, #capitalize_field, #constantize, #dasherize, #dquote, #escape_paren, #map_lines, #map_with_index, #match_to_s, #paren, #quote_atom, #quote_phrase, #quote_token, #token_safe?, #unbracket, #underscoreize, #unparen, #unquote, #uri_escape, #uri_parser, #uri_unescape

Methods included from CommonField

#field_length, #name, #name=, #responsible_for?, #to_s, #value=

Constructor Details

- (ContentTypeField) initialize(value = nil, charset = 'utf-8')

Returns a new instance of ContentTypeField



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'lib/mail/fields/content_type_field.rb', line 10

def initialize(value = nil, charset = 'utf-8')
  self.charset = charset
  if value.class == Array
    @main_type = value[0]
    @sub_type = value[1]
    @parameters = ParameterHash.new.merge!(value.last)
  else
    @main_type = nil
    @sub_type = nil
    @parameters = nil
    value = strip_field(FIELD_NAME, value)
  end
  ensure_filename_quoted(value)
  super(CAPITALIZED_FIELD, value, charset)
  self.parse
  self
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(name, *args, &block) (private)



131
132
133
134
135
136
137
138
# File 'lib/mail/fields/content_type_field.rb', line 131

def method_missing(name, *args, &block)
  if name.to_s =~ /(\w+)=/
    self.parameters[$1] = args.first
    @value = "#{content_type}; #{stringify(parameters)}"
  else
    super
  end
end

Class Method Details

+ (Object) generate_boundary



82
83
84
# File 'lib/mail/fields/content_type_field.rb', line 82

def ContentTypeField.generate_boundary
  "--==_mimepart_#{Mail.random_tag}"
end

+ (Object) with_boundary(type)



78
79
80
# File 'lib/mail/fields/content_type_field.rb', line 78

def ContentTypeField.with_boundary(type)
  new("#{type}; boundary=#{generate_boundary}")
end

Instance Method Details

- (Object) attempt_to_clean



44
45
46
47
48
49
50
# File 'lib/mail/fields/content_type_field.rb', line 44

def attempt_to_clean
  # Sanitize the value, handle special cases
  @element ||= Mail::ContentTypeElement.new(sanatize(value))
rescue
  # All else fails, just get the MIME media type
  @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
end

- (Object) decoded



120
121
122
123
124
125
126
127
# File 'lib/mail/fields/content_type_field.rb', line 120

def decoded
  if parameters.length > 0
    p = "; #{parameters.decoded}"
  else
    p = ""
  end
  "#{content_type}" + p
end

- (Object) default



64
65
66
# File 'lib/mail/fields/content_type_field.rb', line 64

def default
  decoded
end

- (Object) element



36
37
38
39
40
41
42
# File 'lib/mail/fields/content_type_field.rb', line 36

def element
  begin
    @element ||= Mail::ContentTypeElement.new(value)
  rescue
    attempt_to_clean
  end
end

- (Object) encoded

TODO: Fix this up



111
112
113
114
115
116
117
118
# File 'lib/mail/fields/content_type_field.rb', line 111

def encoded
  if parameters.length > 0
    p = ";\r\n\s#{parameters.encoded}"
  else
    p = ""
  end
  "#{CAPITALIZED_FIELD}: #{content_type}#{p}\r\n"
end

- (Object) filename



98
99
100
101
102
103
104
105
106
107
108
# File 'lib/mail/fields/content_type_field.rb', line 98

def filename
  case
  when parameters['filename']
    @filename = parameters['filename']
  when parameters['name']
    @filename = parameters['name']
  else
    @filename = nil
  end
  @filename
end

- (Object) main_type



52
53
54
# File 'lib/mail/fields/content_type_field.rb', line 52

def main_type
  @main_type ||= element.main_type
end

- (Object) parameters



70
71
72
73
74
75
76
# File 'lib/mail/fields/content_type_field.rb', line 70

def parameters
  unless @parameters
    @parameters = ParameterHash.new
    element.parameters.each { |p| @parameters.merge!(p) }
  end
  @parameters
end

- (Object) parse(val = value)



28
29
30
31
32
33
34
# File 'lib/mail/fields/content_type_field.rb', line 28

def parse(val = value)
  unless val.blank?
    self.value = val
    @element = nil
    element
  end
end

- (Object) string Also known as: content_type



60
61
62
# File 'lib/mail/fields/content_type_field.rb', line 60

def string
  "#{main_type}/#{sub_type}"
end

- (Object) stringify(params)



94
95
96
# File 'lib/mail/fields/content_type_field.rb', line 94

def stringify(params)
  params.map { |k,v| "#{k}=#{Encodings.param_encode(v)}" }.join("; ")
end

- (Object) sub_type



56
57
58
# File 'lib/mail/fields/content_type_field.rb', line 56

def sub_type
  @sub_type ||= element.sub_type
end

- (Object) value



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

def value
  if @value.class == Array
    "#{@main_type}/#{@sub_type}; #{stringify(parameters)}"
  else
    @value
  end
end