Class: Mail::ContentDispositionField

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

Constant Summary

FIELD_NAME =
'content-disposition'
CAPITALIZED_FIELD =
'Content-Disposition'

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

Instance Method Summary (collapse)

Methods inherited from StructuredField

#charset, #charset=, #default, #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

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

Constructor Details

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

Returns a new instance of ContentDispositionField



10
11
12
13
14
15
16
# File 'lib/mail/fields/content_disposition_field.rb', line 10

def initialize(value = nil, charset = 'utf-8')
  self.charset = charset
  ensure_filename_quoted(value)
  super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
  self.parse
  self
end

Instance Method Details

- (Object) decoded



60
61
62
63
64
65
66
67
# File 'lib/mail/fields/content_disposition_field.rb', line 60

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

- (Object) disposition_type



28
29
30
# File 'lib/mail/fields/content_disposition_field.rb', line 28

def disposition_type
  element.disposition_type
end

- (Object) element



24
25
26
# File 'lib/mail/fields/content_disposition_field.rb', line 24

def element
  @element ||= Mail::ContentDispositionElement.new(value)
end

- (Object) encoded

TODO: Fix this up



51
52
53
54
55
56
57
58
# File 'lib/mail/fields/content_disposition_field.rb', line 51

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

- (Object) filename



38
39
40
41
42
43
44
45
46
47
48
# File 'lib/mail/fields/content_disposition_field.rb', line 38

def filename
  case
  when !parameters['filename'].blank?
    @filename = parameters['filename']
  when !parameters['name'].blank?
    @filename = parameters['name']
  else 
    @filename = nil
  end
  @filename
end

- (Object) parameters



32
33
34
35
36
# File 'lib/mail/fields/content_disposition_field.rb', line 32

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

- (Object) parse(val = value)



18
19
20
21
22
# File 'lib/mail/fields/content_disposition_field.rb', line 18

def parse(val = value)
  unless val.blank?
    @element = Mail::ContentDispositionElement.new(val)
  end
end