Class: URI::MailTo

Inherits:
Generic show all
Includes:
REGEXP
Defined in:
lib/uri/mailto.rb

Overview

RFC6068, The mailto URL scheme

Constant Summary collapse

DEFAULT_PORT =

A Default port of nil for URI::MailTo

nil
COMPONENT =

An Array of the available components for 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 www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.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 URI

DEFAULT_PARSER, HTML5ASCIIINCOMPAT, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, 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, #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_registry, #user, #user=, #userinfo, #userinfo=

Methods included from URI

decode_www_form, decode_www_form_component, encode_www_form, encode_www_form_component, extract, join, parse, regexp, scheme_list, split

Methods included from Escape

#escape, #unescape

Constructor Details

#initialize(*arg) ⇒ MailTo

Description

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

This method is usually called from 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
 
# File 'lib/uri/mailto.rb', line 132

def initialize(*arg)
  super(*arg)

  @to = nil
  @headers = []

  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



159
160
161
 
# File 'lib/uri/mailto.rb', line 159

def headers
  @headers
end

#to ⇒ Object

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



156
157
158
 
# File 'lib/uri/mailto.rb', line 156

def to
  @to
end

Class Method Details

.build(args) ⇒ Object

Description

Creates a new 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 'uri'

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

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

m3 = URI::MailTo.build({:to => '[email protected]', :headers => [['subject', 'subscribe']]})
puts 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/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

  return 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 'uri'

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/uri/mailto.rb', line 261

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

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

#to_s ⇒ Object

Constructs String from URI



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/uri/mailto.rb', line 232

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