Class: Gem::URI::MailTo

Inherits:
Generic show all
Includes:
RFC2396_REGEXP
Defined in:
lib/rubygems/vendor/uri/lib/uri/mailto.rb

Overview

RFC6068, the mailto URL scheme.

Constant Summary collapse

DEFAULT_PORT =

A Default port of nil for Gem::URI::MailTo.

nil
COMPONENT =

An Array of the available components for Gem::URI::MailTo.

[ :scheme, :to, :headers ].freeze
HEADER_REGEXP =

; RFC 6068 hfields = “?” hfield *( “&” hfield ) hfield = hfname “=” hfvalue hfname = *qchar hfvalue = *qchar qchar = unreserved / pct-encoded / some-delims some-delims = “!” / “$” / “‘” / “(” / “)” / “*”

/ "+" / "," / ";" / ":" / "@"

; RFC3986 unreserved = ALPHA / DIGIT / “-” / “.” / “_” / “~” pct-encoded = “%” HEXDIG HEXDIG

/\A(?<hfield>(?:%\h\h|[!$'-.0-;@-Z_a-z~])*=(?:%\h\h|[!$'-.0-;@-Z_a-z~])*)(?:&\g<hfield>)*\z/
EMAIL_REGEXP =

practical regexp for email address html.spec.whatwg.org/multipage/input.html#valid-e-mail-address

/\A[a-zA-Z0-9.!\#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/

Constants inherited from Generic

Generic::USE_REGISTRY

Constants included from Gem::URI

DEFAULT_PARSER, Parser, REGEXP, RFC2396_PARSER, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCURICOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE

Instance Attribute Summary collapse

Attributes inherited from Generic

#fragment, #host, #opaque, #path, #port, #query, #scheme

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Generic

#==, #absolute?, build2, #coerce, component, #component, #decoded_password, #decoded_user, #default_port, default_port, #eql?, #find_proxy, #hash, #hierarchical?, #hostname, #hostname=, #inspect, #merge, #merge!, #normalize, #normalize!, #parser, #password, #password=, #registry, #registry=, #relative?, #route_from, #route_to, #select, use_proxy?, use_registry, #user, #user=, #userinfo, #userinfo=

Methods included from Gem::URI

decode_uri_component, decode_www_form, decode_www_form_component, encode_uri_component, encode_www_form, encode_www_form_component, extract, for, join, parse, regexp, register_scheme, scheme_list, split

Constructor Details

#initialize(*arg) ⇒ MailTo

Description

Creates a new Gem::URI::MailTo object from generic URL components with no syntax checking.

This method is usually called from Gem::URI::parse, which checks the validity of each component.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/rubygems/vendor/uri/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

Instance Attribute Details

#headers ⇒ Object

E-mail headers set by the URL, as an Array of Arrays.



166
167
168
 
# File 'lib/rubygems/vendor/uri/lib/uri/mailto.rb', line 166

def headers
  @headers
end

#to ⇒ Object

The primary e-mail address of the URL, as a String.



163
164
165
 
# File 'lib/rubygems/vendor/uri/lib/uri/mailto.rb', line 163

def to
  @to
end

Class Method Details

.build(args) ⇒ Object

Description

Creates a new Gem::URI::MailTo object from components, with syntax checking.

Components can be provided as an Array or Hash. If an Array is used, the components must be supplied as [to, headers].

If a Hash is used, the keys are the component names preceded by colons.

The headers can be supplied as a pre-encoded string, such as "subject=subscribe&cc=address", or as an Array of Arrays like [['subject', 'subscribe'], ['cc', 'address']].

Examples:

require 'rubygems/vendor/uri/lib/uri'

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

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

m3 = Gem::URI::MailTo.build({:to => '[email protected]', :headers => [['subject', 'subscribe']]})
m3.to_s  # => "mailto:[email protected]?subject=subscribe"



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/rubygems/vendor/uri/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

Instance Method Details

#to_mailtext ⇒ Object Also known as: to_rfc822text

Returns the RFC822 e-mail text equivalent of the URL, as a String.

Example:

require 'rubygems/vendor/uri/lib/uri'

uri = Gem::URI.parse("mailto:[email protected]?Subject=subscribe&cc=myaddr")
uri.to_mailtext
# => "To: [email protected]\nSubject: subscribe\nCc: myaddr\n\n\n"



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/rubygems/vendor/uri/lib/uri/mailto.rb', line 268

def to_mailtext
  to = Gem::URI.decode_www_form_component(@to)
  head = ''
  body = ''
  @headers.each do |x|
    case x[0]
    when 'body'
      body = Gem::URI.decode_www_form_component(x[1])
    when 'to'
      to << ', ' + Gem::URI.decode_www_form_component(x[1])
    else
      head << Gem::URI.decode_www_form_component(x[0]).capitalize + ': ' +
        Gem::URI.decode_www_form_component(x[1])  + "\n"
    end
  end

  "To: #{to}
#{head}
#{body}
"
end

#to_s ⇒ Object

Constructs String from Gem::URI.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/rubygems/vendor/uri/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