類別 URI::MailTo

RFC6068,mailto URL 架構。

常數

COMPONENT

一個 Array,包含 URI::MailTo 可用的組成部分。

DEFAULT_PORT

預設埠為 URI::MailTo 的 nil。

屬性

headers[R]

由 URL 設定的電子郵件標頭,為 ArrayArray

to[R]

URL 的主要電子郵件地址,為 String

公開類別方法

build(args) 按一下以切換來源

說明

從組成部分建立新的 URI::MailTo 物件,並進行語法檢查。

組成部分可以 ArrayHash 提供。如果使用 Array,則必須提供組成部分,例如 [to, headers]

如果使用 Hash,則金鑰是組成部分名稱,前面加上冒號。

標頭可以提供為預先編碼字串,例如 "subject=subscribe&cc=address",或提供為 ArrayArray,例如 [['subject', 'subscribe'], ['cc', 'address']]

範例

require 'uri'

m1 = URI::MailTo.build(['[email protected]', 'subject=Ruby'])
m1.to_s  # => "mailto:[email protected]?subject=Ruby"

m2 = URI::MailTo.build(['[email protected]', [['Subject', 'Ruby'], ['Cc', '[email protected]']]])
m2.to_s  # => "mailto:[email protected]?Subject=Ruby&[email protected]"

m3 = URI::MailTo.build({:to => '[email protected]', :headers => [['subject', 'subscribe']]})
m3.to_s  # => "mailto:[email protected]?subject=subscribe"
呼叫超類別方法 URI::Generic::build
# File lib/uri/mailto.rb, line 85
def self.build(args)
  tmp = Util.make_components_hash(self, args)

  case tmp[:to]
  when Array
    tmp[:opaque] = tmp[:to].join(',')
  when String
    tmp[:opaque] = tmp[:to].dup
  else
    tmp[:opaque] = ''
  end

  if tmp[:headers]
    query =
      case tmp[:headers]
      when Array
        tmp[:headers].collect { |x|
          if x.kind_of?(Array)
            x[0] + '=' + x[1..-1].join
          else
            x.to_s
          end
        }.join('&')
      when Hash
        tmp[:headers].collect { |h,v|
          h + '=' + v
        }.join('&')
      else
        tmp[:headers].to_s
      end
    unless query.empty?
      tmp[:opaque] << '?' << query
    end
  end

  super(tmp)
end
new(*arg) 按一下以切換來源

說明

從一般 URL 組成部分建立新的 URI::MailTo 物件,不進行語法檢查。

此方法通常從 URI::parse 呼叫,它會檢查每個組成部分的有效性。

呼叫超類別方法 URI::Generic::new
# File lib/uri/mailto.rb, line 132
def initialize(*arg)
  super(*arg)

  @to = nil
  @headers = []

  # The RFC3986 parser does not normally populate opaque
  @opaque = "?#{@query}" if @query && !@opaque

  unless @opaque
    raise InvalidComponentError,
      "missing opaque part for mailto URL"
  end
  to, header = @opaque.split('?', 2)
  # allow semicolon as a addr-spec separator
  # http://support.microsoft.com/kb/820868
  unless /\A(?:[^@,;]+@[^@,;]+(?:\z|[,;]))*\z/ =~ to
    raise InvalidComponentError,
      "unrecognised opaque part for mailtoURL: #{@opaque}"
  end

  if arg[10] # arg_check
    self.to = to
    self.headers = header
  else
    set_to(to)
    set_headers(header)
  end
end

公開實例方法

headers=(v) 按一下以切換來源

v 標頭的設定器。

# File lib/uri/mailto.rb, line 232
def headers=(v)
  check_headers(v)
  set_headers(v)
  v
end
to=(v) 按一下以切換來源

v 的設定器。

# File lib/uri/mailto.rb, line 200
def to=(v)
  check_to(v)
  set_to(v)
  v
end
to_mailtext() 按一下以切換來源

傳回等於 URL 的 RFC822 電子郵件文字,為 String

範例

require 'uri'

uri = URI.parse("mailto:[email protected]?Subject=subscribe&cc=myaddr")
uri.to_mailtext
# => "To: [email protected]\nSubject: subscribe\nCc: myaddr\n\n\n"
# File lib/uri/mailto.rb, line 268
    def to_mailtext
      to = URI.decode_www_form_component(@to)
      head = ''
      body = ''
      @headers.each do |x|
        case x[0]
        when 'body'
          body = URI.decode_www_form_component(x[1])
        when 'to'
          to << ', ' + URI.decode_www_form_component(x[1])
        else
          head << URI.decode_www_form_component(x[0]).capitalize + ': ' +
            URI.decode_www_form_component(x[1])  + "\n"
        end
      end

      "To: #{to}
#{head}
#{body}
"
    end
別名為:to_rfc822text
to_rfc822text()
別名為:to_mailtext
to_s() 按一下以切換來源

URI 建構 String

# File lib/uri/mailto.rb, line 239
def to_s
  @scheme + ':' +
    if @to
      @to
    else
      ''
    end +
    if @headers.size > 0
      '?' + @headers.collect{|x| x.join('=')}.join('&')
    else
      ''
    end +
    if @fragment
      '#' + @fragment
    else
      ''
    end
end

受保護的執行個體方法

set_headers(v) 按一下以切換來源

v 標頭的私人設定器。

# File lib/uri/mailto.rb, line 221
def set_headers(v)
  @headers = []
  if v
    v.split('&').each do |x|
      @headers << x.split(/=/, 2)
    end
  end
end
set_to(v) 按一下以切換來源

v 的私人設定器。

# File lib/uri/mailto.rb, line 194
def set_to(v)
  @to = v
end

私人執行個體方法

check_headers(v) 按一下以切換來源

檢查標頭 v 元件是否符合

  • HEADER_REGEXP

# File lib/uri/mailto.rb, line 208
def check_headers(v)
  return true unless v
  return true if v.size == 0
  if HEADER_REGEXP !~ v
    raise InvalidComponentError,
      "bad component(expected opaque component): #{v}"
  end

  true
end
check_to(v) 按一下以切換來源

檢查 v 元件。

# File lib/uri/mailto.rb, line 169
def check_to(v)
  return true unless v
  return true if v.size == 0

  v.split(/[,;]/).each do |addr|
    # check url safety as path-rootless
    if /\A(?:%\h\h|[!$&-.0-;=@-Z_a-z~])*\z/ !~ addr
      raise InvalidComponentError,
        "an address in 'to' is invalid as URI #{addr.dump}"
    end

    # check addr-spec
    # don't s/\+/ /g
    addr.gsub!(/%\h\h/, URI::TBLDECWWWCOMP_)
    if EMAIL_REGEXP !~ addr
      raise InvalidComponentError,
        "an address in 'to' is invalid as uri-escaped addr-spec #{addr.dump}"
    end
  end

  true
end