Module: Mail::Utilities

Extended by:
Utilities
Included in:
Encodings, Utilities
Defined in:
lib/mail/utilities.rb

Defined Under Namespace

Classes: BestEffortCharsetEncoder, StrictCharsetEncoder

Constant Summary collapse

TO_CRLF_REGEX = 
Regexp.new("(?<!\r)\n|\r(?!\n)")

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.charset_encoder ⇒ Object

Returns the value of attribute charset_encoder.



338
339
340
 
# File 'lib/mail/utilities.rb', line 338

def charset_encoder
  @charset_encoder
end

Class Method Details

.binary_unsafe_to_crlf(string) ⇒ Object

:nodoc:



247
248
249
 
# File 'lib/mail/utilities.rb', line 247

def self.binary_unsafe_to_crlf(string) #:nodoc:
  string.gsub(TO_CRLF_REGEX, Constants::CRLF)
end

.binary_unsafe_to_lf(string) ⇒ Object

:nodoc:



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

def self.binary_unsafe_to_lf(string) #:nodoc:
  string.gsub(/\r\n|\r/, Constants::LF)
end

.safe_for_line_ending_conversion?(string) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

def self.safe_for_line_ending_conversion?(string) #:nodoc:
  if string.encoding == Encoding::BINARY
    string.ascii_only?
  else
    string.valid_encoding?
  end
end

.to_crlf(string) ⇒ Object

Convert line endings to \r\n unless the string is binary. Used for encoding 8bit and base64 Content-Transfer-Encoding and for convenience when parsing emails with \n line endings instead of the required \r\n.



273
274
275
276
277
278
279
280
 
# File 'lib/mail/utilities.rb', line 273

def self.to_crlf(string)
  string = string.to_s
  if safe_for_line_ending_conversion? string
    binary_unsafe_to_crlf string
  else
    string
  end
end

.to_lf(string) ⇒ Object

Convert line endings to \n unless the string is binary. Used for sendmail delivery and for decoding 8bit Content-Transfer-Encoding.



261
262
263
264
265
266
267
268
 
# File 'lib/mail/utilities.rb', line 261

def self.to_lf(string)
  string = string.to_s
  if safe_for_line_ending_conversion? string
    binary_unsafe_to_lf string
  else
    string
  end
end

Instance Method Details

#atom_safe?(str) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#blank?(value) ⇒ Boolean

Returns true if the object is considered blank. A blank includes things like '', ' ', nil, and arrays and hashes that have nothing in them.

This logic is mostly shared with ActiveSupport's blank?

Returns:

  • (Boolean) 


287
288
289
290
291
292
293
294
295
 
# File 'lib/mail/utilities.rb', line 287

def blank?(value)
  if value.kind_of?(NilClass)
    true
  elsif value.kind_of?(String)
    value !~ /\S/
  else
    value.respond_to?(:empty?) ? value.empty? : !value
  end
end

#bracket(str) ⇒ Object

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

Example:

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



131
132
133
 
# File 'lib/mail/utilities.rb', line 131

def bracket( str )
  Utilities.bracket( str )
end

#capitalize_field(str) ⇒ Object

Capitalizes a string that is joined by hyphens correctly.

Example:

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



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

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

#constantize(str) ⇒ Object

Takes an underscored word and turns it into a class name

Example:

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



203
204
205
 
# File 'lib/mail/utilities.rb', line 203

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

#dasherize(str) ⇒ Object

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

Example:

string = :resent_from_field dasherize( string ) #=> 'resent-from-field'



214
215
216
 
# File 'lib/mail/utilities.rb', line 214

def dasherize( str )
  str.to_s.tr(Constants::UNDERSCORE, Constants::HYPHEN)
end

#dquote(str) ⇒ Object

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

Example:

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

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



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

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

#escape_paren(str) ⇒ Object

Escape parenthesies in a string

Example:

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



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

def escape_paren( str )
  Utilities.escape_paren( str )
end

#generate_message_id ⇒ Object 



297
298
299
 
# File 'lib/mail/utilities.rb', line 297

def generate_message_id
  "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
end

#map_lines(str, &block) ⇒ Object 



229
230
231
 
# File 'lib/mail/utilities.rb', line 229

def map_lines( str, &block )
  str.each_line.map(&block)
end

#map_with_index(enum, &block) ⇒ Object 



233
234
235
 
# File 'lib/mail/utilities.rb', line 233

def map_with_index( enum, &block )
  enum.each_with_index.map(&block)
end

#match_to_s(obj1, obj2) ⇒ Object

Matches two objects with their to_s values case insensitively

Example:

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



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

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

#paren(str) ⇒ Object

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

Example:

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



108
109
110
 
# File 'lib/mail/utilities.rb', line 108

def paren( str )
  Utilities.paren( str )
end

#quote_atom(str) ⇒ Object

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



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

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

#quote_phrase(str) ⇒ Object

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



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/mail/utilities.rb', line 23

def quote_phrase( str )
  if str.respond_to?(:force_encoding)
    original_encoding = str.encoding
    ascii_str = str.to_s.dup.force_encoding('ASCII-8BIT')
    if Constants::PHRASE_UNSAFE === ascii_str
      dquote(ascii_str).force_encoding(original_encoding)
    else
      str
    end
  else
    Constants::PHRASE_UNSAFE === str ? dquote(str) : str
  end
end

#quote_token(str) ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/mail/utilities.rb', line 44

def quote_token( str )
  if str.respond_to?(:force_encoding)
    original_encoding = str.encoding
    ascii_str = str.to_s.dup.force_encoding('ASCII-8BIT')
    if token_safe?( ascii_str )
      str
    else
      dquote(ascii_str).force_encoding(original_encoding)
    end
  else
    token_safe?( str ) ? str : dquote(str)
  end
end

#token_safe?(str) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#unbracket(str) ⇒ Object

Unwraps a string from being wrapped in parenthesis

Example:

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



141
142
143
144
145
146
147
 
# File 'lib/mail/utilities.rb', line 141

def unbracket( str )
  if str.start_with?('<') && str.end_with?('>')
    str.slice(1..-2)
  else
    str
  end
end

#underscoreize(str) ⇒ Object

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

Example:

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



225
226
227
 
# File 'lib/mail/utilities.rb', line 225

def underscoreize( str )
  str.to_s.downcase.tr(Constants::HYPHEN, Constants::UNDERSCORE)
end

#unescape(str) ⇒ Object

Removes any -escaping.

Example:

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

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



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

def unescape( str )
  str.gsub(/\\(.)/, '\1')
end

#unparen(str) ⇒ Object

Unwraps a string from being wrapped in parenthesis

Example:

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



118
119
120
121
122
123
124
 
# File 'lib/mail/utilities.rb', line 118

def unparen( str )
  if str.start_with?('(') && str.end_with?(')')
    str.slice(1..-2)
  else
    str
  end
end

#unquote(str) ⇒ Object

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

Example:

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

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



82
83
84
85
86
87
88
 
# File 'lib/mail/utilities.rb', line 82

def unquote( str )
  if str =~ /^"(.*?)"$/
    unescape($1)
  else
    str
  end
end

#uri_escape(str) ⇒ Object 



159
160
161
 
# File 'lib/mail/utilities.rb', line 159

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

#uri_parser ⇒ Object 



167
168
169
170
171
172
173
 
# File 'lib/mail/utilities.rb', line 167

def uri_parser
  @uri_parser ||= if URI.const_defined?(:DEFAULT_PARSER)
                    defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
                  else
                    URI
                  end
end

#uri_unescape(str) ⇒ Object 



163
164
165
 
# File 'lib/mail/utilities.rb', line 163

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