Module TMail::TextUtils
In: lib/tmail/utils.rb

Methods

Constants

ATOM_UNSAFE = /[#{Regexp.quote aspecial}#{control}#{lwsp}]/n
PHRASE_UNSAFE = /[#{Regexp.quote aspecial}#{control}]/n
TOKEN_UNSAFE = /[#{Regexp.quote tspecial}#{control}#{lwsp}]/n
CONTROL_CHAR = /[#{control}]/n
ZONESTR_TABLE = { 'jst' => 9 * 60, 'eet' => 2 * 60, 'bst' => 1 * 60, 'met' => 1 * 60, 'gmt' => 0, 'utc' => 0, 'ut' => 0, 'nst' => -(3 * 60 + 30), 'ast' => -4 * 60, 'edt' => -4 * 60, 'est' => -5 * 60, 'cdt' => -5 * 60, 'cst' => -6 * 60, 'mdt' => -6 * 60, 'mst' => -7 * 60, 'pdt' => -7 * 60, 'pst' => -8 * 60, 'a' => -1 * 60, 'b' => -2 * 60, 'c' => -3 * 60, 'd' => -4 * 60, 'e' => -5 * 60, 'f' => -6 * 60, 'g' => -7 * 60, 'h' => -8 * 60, 'i' => -9 * 60, # j not use 'k' => -10 * 60, 'l' => -11 * 60, 'm' => -12 * 60, 'n' => 1 * 60, 'o' => 2 * 60, 'p' => 3 * 60, 'q' => 4 * 60, 'r' => 5 * 60, 's' => 6 * 60, 't' => 7 * 60, 'u' => 8 * 60, 'v' => 9 * 60, 'w' => 10 * 60, 'x' => 11 * 60, 'y' => 12 * 60, 'z' => 0 * 60
WDAY = %w( Sun Mon Tue Wed Thu Fri Sat TMailBUG )
MONTH = %w( TMailBUG Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec TMailBUG )
MESSAGE_ID = /<[^\@>]+\@[^>\@]+>/
MIME_ENCODED = /=\?[^\s?=]+\?[QB]\?[^\s?=]+\?=/i
NKF_FLAGS = { 'EUC' => '-e -m', 'SJIS' => '-s -m'
RFC2231_ENCODED = /\A(?:iso-2022-jp|euc-jp|shift_jis|us-ascii)?'[a-z]*'/in

Public Instance methods

[Source]

# File lib/tmail/utils.rb, line 91
    def atom_safe?( str )
      # Returns true if the string supplied is free from characters not allowed as an ATOM
      not ATOM_UNSAFE === str
    end

[Source]

# File lib/tmail/utils.rb, line 269
    def decode_RFC2231( str )
      m = RFC2231_ENCODED.match(str) or return str
      begin
        to_kcode(m.post_match.gsub(/%[\da-f]{2}/in) {|s| s[1,2].hex.chr })
      rescue
        m.post_match.gsub(/%[\da-f]{2}/in, "")
      end
    end

[Source]

# File lib/tmail/utils.rb, line 238
    def decode_params( hash )
      new = Hash.new
      encoded = nil
      hash.each do |key, value|
        if m = /\*(?:(\d+)\*)?\z/.match(key)
          ((encoded ||= {})[m.pre_match] ||= [])[(m[1] || 0).to_i] = value
        else
          new[key] = to_kcode(value)
        end
      end
      if encoded
        encoded.each do |key, strings|
          new[key] = decode_RFC2231(strings.join(''))
        end
      end

      new
    end

[Source]

# File lib/tmail/utils.rb, line 136
    def join_domain( arr )
      arr.map {|i|
          if /\A\[.*\]\z/ === i
            i
          else
            quote_atom(i)
          end
      }.join('.')
    end

[Source]

# File lib/tmail/utils.rb, line 226
    def message_id?( str )
      MESSAGE_ID === str
    end

[Source]

# File lib/tmail/utils.rb, line 233
    def mime_encoded?( str )
      MIME_ENCODED === str
    end

[Source]

# File lib/tmail/utils.rb, line 96
    def 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
      (ATOM_UNSAFE === str) ? dquote(str) : str
    end

[Source]

# File lib/tmail/utils.rb, line 278
    def quote_boundary
      # Make sure the Content-Type boundary= parameter is quoted if it contains illegal characters
      # (to ensure any special characters in the boundary text are escaped from the parser
      # (such as = in MS Outlook's boundary text))
      if @body =~ /^(.*)boundary=(.*)$/m
        preamble = $1
        remainder = $2
        if remainder =~ /;/
          remainder =~ /^(.*?)(;.*)$/m
          boundary_text = $1
          post = $2.chomp
        else
          boundary_text = remainder.chomp
        end
        if boundary_text =~ /[\/\?\=]/
          boundary_text = "\"#{boundary_text}\"" unless boundary_text =~ /^".*?"$/
          @body = "#{preamble}boundary=#{boundary_text}#{post}"
        end
      end
    end

[Source]

# File lib/tmail/utils.rb, line 102
    def 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
      (PHRASE_UNSAFE === str) ? dquote(str) : str
    end

[Source]

# File lib/tmail/utils.rb, line 113
    def 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
      (TOKEN_UNSAFE === str) ? dquote(str) : str
    end

[Source]

# File lib/tmail/utils.rb, line 210
    def time2str( tm )
      # [ruby-list:7928]
      gmt = Time.at(tm.to_i)
      gmt.gmtime
      offset = tm.to_i - Time.local(*gmt.to_a[0,6].reverse).to_i

      # DO NOT USE strftime: setlocale() breaks it
      sprintf '%s, %s %s %d %02d:%02d:%02d %+.2d%.2d',
              WDAY[tm.wday], tm.mday, MONTH[tm.month],
              tm.year, tm.hour, tm.min, tm.sec,
              *(offset / 60).divmod(60)
    end

[Source]

# File lib/tmail/utils.rb, line 193
    def timezone_string_to_unixtime( str )
      # Takes a time zone string from an EMail and converts it to Unix Time (seconds)
      if m = /([\+\-])(\d\d?)(\d\d)/.match(str)
        sec = (m[2].to_i * 60 + m[3].to_i) * 60
        m[1] == '-' ? -sec : sec
      else
        min = ZONESTR_TABLE[str.downcase] or
                raise SyntaxError, "wrong timezone format '#{str}'"
        min * 60
      end
    end

[Source]

# File lib/tmail/utils.rb, line 262
    def to_kcode( str )
      flag = NKF_FLAGS[TMail.KCODE] or return str
      NKF.nkf(flag, str)
    end

[Source]

# File lib/tmail/utils.rb, line 108
    def token_safe?( str )
      # Returns true if the string supplied is free from characters not allowed as a TOKEN
      not TOKEN_UNSAFE === str
    end

[Source]

# File lib/tmail/utils.rb, line 130
    def unquote( str )
      # Unwraps supplied string from inside double quotes
      # Returns unquoted string
      str =~ /^"(.*?)"$/ ? $1 : str
    end

[Validate]