Module: Mail::Utilities

Includes:

Patterns

Included in:

Address, ContentDispositionElement, ContentLocationElement, ContentTransferEncodingElement, ContentTypeElement, DateTimeElement, Encodings, EnvelopeFromElement, Header, Message, MessageIdsElement, MimeVersionElement, ParameterHash, PhraseList, ReceivedElement, StructuredField, UnstructuredField

Defined in:

lib/mail/utilities.rb

Constant Summary

Constant Summary

Constants included from Patterns

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

Instance Method Summary (collapse)

• - (Boolean) atom_safe?(str)

  Returns true if the string supplied is free from characters not allowed as an ATOM.

• - (Object) bracket(str)

  Wraps a string in angle brackets and escapes any that are in the string itself.

• - (Object) capitalize_field(str)

  Capitalizes a string that is joined by hyphens correctly.

• - (Object) constantize(str)

  Takes an underscored word and turns it into a class name.

• - (Object) dasherize(str)

  Swaps out all underscores (_) for hyphens (-) good for stringing from symbols a field name.

• - (Object) dquote(str)

  Wraps supplied string in double quotes and applies -escaping as necessary, unless it is already wrapped.

• - (Object) escape_paren(str)

  Escape parenthesies in a string.

• - (Object) map_lines(str, &block)
• - (Object) map_with_index(enum, &block)
• - (Object) match_to_s(obj1, obj2)

  Matches two objects with their to_s values case insensitively.

• - (Object) paren(str)

  Wraps a string in parenthesis and escapes any that are in the string itself.

• - (Object) quote_atom(str)

  If the string supplied has ATOM unsafe characters in it, will return the string quoted in double quotes, otherwise returns the string unmodified.

• - (Object) quote_phrase(str)

  If the string supplied has PHRASE unsafe characters in it, will return the string quoted in double quotes, otherwise returns the string unmodified.

• - (Object) quote_token(str)

  If the string supplied has TOKEN unsafe characters in it, will return the string quoted in double quotes, otherwise returns the string unmodified.

• - (Boolean) token_safe?(str)

  Returns true if the string supplied is free from characters not allowed as a TOKEN.

• - (Object) unbracket(str)

  Unwraps a string from being wrapped in parenthesis.

• - (Object) underscoreize(str)

  Swaps out all hyphens (-) for underscores (_) good for stringing to symbols a field name.

• - (Object) unparen(str)

  Unwraps a string from being wrapped in parenthesis.

• - (Object) unquote(str)

  Unwraps supplied string from inside double quotes and removes any -escaping.

• - (Object) uri_escape(str)
• - (Object) uri_parser
• - (Object) uri_unescape(str)

7
8
9

# File 'lib/mail/utilities.rb', line 7

def atom_safe?( str )
  not ATOM_UNSAFE === str
end

bracket( 'This is a string' ) #=> '<This is a string>'

101
102
103

# File 'lib/mail/utilities.rb', line 101

def bracket( str )
  RubyVer.bracket( str )
end

string = 'resent-from-field'
capitalize_field( string ) #=> 'Resent-From-Field'

155
156
157

# File 'lib/mail/utilities.rb', line 155

def capitalize_field( str )
  str.to_s.split("-").map { |v| v.capitalize }.join("-")
end

constantize("hello") #=> "Hello"
constantize("hello-there") #=> "HelloThere"
constantize("hello-there-mate") #=> "HelloThereMate"

166
167
168

# File 'lib/mail/utilities.rb', line 166

def constantize( str )
  str.to_s.split(/[-_]/).map { |v| v.capitalize }.to_s
end

string = :resent_from_field
dasherize ( string ) #=> 'resent_from_field'

177
178
179

# File 'lib/mail/utilities.rb', line 177

def dasherize( str )
  str.to_s.gsub('_', '-')
end

string = 'This is a string'
dquote(string) #=> '"This is a string"'

string = 'This is "a string"'
dquote(string #=> '"This is \"a string\"'

54
55
56

# File 'lib/mail/utilities.rb', line 54

def dquote( str )
  '"' + unquote(str).gsub(/[\\"]/n) {|s| '\\' + s } + '"'
end

str = 'This is (a) string'
escape_paren( str ) #=> 'This is \(a\) string'

122
123
124

# File 'lib/mail/utilities.rb', line 122

def escape_paren( str )
  RubyVer.escape_paren( str )
end

194
195
196
197
198
199
200

# File 'lib/mail/utilities.rb', line 194

def map_lines( str, &block )
  results = []
  str.each_line do |line|
    results << yield(line)
  end
  results
end

202
203
204
205
206
207
208

# File 'lib/mail/utilities.rb', line 202

def map_with_index( enum, &block )
  results = []
  enum.each_with_index do |token, i|
    results[i] = yield(token, i)
  end
  results
end

obj2 = "This_is_An_object"
obj1 = :this_IS_an_object
match_to_s( obj1, obj2 ) #=> true

145
146
147

# File 'lib/mail/utilities.rb', line 145

def match_to_s( obj1, obj2 )
  obj1.to_s.casecmp(obj2.to_s) == 0
end

paren( 'This is a string' ) #=> '(This is a string)'

81
82
83

# File 'lib/mail/utilities.rb', line 81

def paren( str )
  RubyVer.paren( str )
end

13
14
15

# File 'lib/mail/utilities.rb', line 13

def quote_atom( str )
  atom_safe?( str ) ? str : dquote(str)
end

19
20
21
22
23
24
25
26
27
28
29
30
31

# File 'lib/mail/utilities.rb', line 19

def quote_phrase( str )
  if RUBY_VERSION >= '1.9'
    original_encoding = str.encoding
    str.force_encoding('ASCII-8BIT')
    if (PHRASE_UNSAFE === str)
      dquote(str).force_encoding(original_encoding)
    else
      str.force_encoding(original_encoding)
    end
  else
    (PHRASE_UNSAFE === str) ? dquote(str) : str
  end
end

40
41
42

# File 'lib/mail/utilities.rb', line 40

def quote_token( str )
  token_safe?( str ) ? str : dquote(str)
end

34
35
36

# File 'lib/mail/utilities.rb', line 34

def token_safe?( str )
  not TOKEN_UNSAFE === str
end

str = '<This is a string>'
unbracket( str ) #=> 'This is a string'

111
112
113
114

# File 'lib/mail/utilities.rb', line 111

def unbracket( str )
  match = str.match(/^\<(.*?)\>$/)
  match ? match[1] : str
end

string = :resent_from_field
underscoreize ( string ) #=> 'resent_from_field'

188
189
190

# File 'lib/mail/utilities.rb', line 188

def underscoreize( str )
  str.to_s.downcase.gsub('-', '_')
end

str = '(This is a string)'
unparen( str ) #=> 'This is a string'

91
92
93
94

# File 'lib/mail/utilities.rb', line 91

def unparen( str )
  match = str.match(/^\((.*?)\)$/)
  match ? match[1] : str
end

string = '"This is a string"'
unquote(string) #=> 'This is a string'

string = '"This is \"a string\""'
unqoute(string) #=> 'This is "a string"'

68
69
70
71
72
73
74

# File 'lib/mail/utilities.rb', line 68

def unquote( str )
  if str =~ /^"(.*?)"$/
    $1.gsub(/\\(.)/, '\1')
  else
    str
  end
end

126
127
128

# File 'lib/mail/utilities.rb', line 126

def uri_escape( str )
  uri_parser.escape(str)
end

134
135
136

# File 'lib/mail/utilities.rb', line 134

def uri_parser
  @uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
end

130
131
132

# File 'lib/mail/utilities.rb', line 130

def uri_unescape( str )
  uri_parser.unescape(str)
end