Class: URI::MailTo

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Generic`
Instance Chain: self, `Generic`, `::URI`, `RFC2396_REGEXP`
Inherits:	URI::Generic Object URI::Generic URI::MailTo
Defined in:	lib/uri/mailto.rb

Overview

RFC6068, the mailto URL scheme.

Constant Summary

COMPONENT =

An Array of the available components for MailTo.

# File 'lib/uri/mailto.rb', line 24
```
[ :scheme, :to, :headers ].freeze
```
DEFAULT_PORT =

A Default port of nil for MailTo.

# File 'lib/uri/mailto.rb', line 21
```
nil
```
EMAIL_REGEXP = Internal use only

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

# File 'lib/uri/mailto.rb', line 55
```
/\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/
```
HEADER_REGEXP = Internal use only
; 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
# File 'lib/uri/mailto.rb', line 52
```
/\A(?<hfield>(?:%\h\h|[!$'-.0-;@-Z_a-z~])*=(?:%\h\h|[!$'-.0-;@-Z_a-z~])*)(?:&\g<hfield>)*\z/
```

`::URI` - Included

DEFAULT_PARSER, INITIAL_SCHEMES, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCURICOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE, WEB_ENCODINGS_

`Generic` - Inherited

COMPONENT, DEFAULT_PORT, USE_REGISTRY

Class Method Summary

.build(args)

Description.
.new(*arg) ⇒ MailTo constructor

Description.

`Generic` - Inherited

.build	Synopsis.
.build2	Synopsis.
.component	Components of the `::URI` in the order.
.default_port	Returns default port.
.new	Args.
.use_proxy?, .use_registry

Instance Attribute Summary

#headers rw

E-mail headers set by the URL, as an Array of Arrays.
#headers=(v) rw

Setter for headers v.
#to rw

The primary e-mail address of the URL, as a String.
#to=(v) rw

Setter for to v.

`Generic` - Inherited

#absolute	Alias for Generic#absolute?.
#fragment	Returns the fragment component of the `::URI`.
#fragment=	Checks the fragment `v` component against the Parser Regexp for `:FRAGMENT`.
#hierarchical?	Returns true if `::URI` is hierarchical.
#host	Returns the host component of the `::URI`.
#host=	Args.
#hostname	Extract the host part of the `::URI` and unwrap brackets for IPv6 addresses.
#hostname=	Sets the host part of the `::URI` as the argument with brackets for IPv6 addresses.
#opaque	Returns the opaque part of the `::URI`.
#opaque=	Args.
#password	Returns the password component (without `::URI` decoding).
#password=	Args.
#path	Returns the path component of the `::URI`.
#path=	Args.
#port	Returns the port component of the `::URI`.
#port=	Args.
#query	Returns the query component of the `::URI`.
#query=	Args.
#registry=,
#relative?	Returns true if `::URI` does not have a scheme (e.g.
#scheme	Returns the scheme component of the `::URI`.
#scheme=	Args.
#user	Returns the user component (without `::URI` decoding).
#user=	Args.
#userinfo	Returns the userinfo, either as ‘user’ or ‘user:password’.
#userinfo=	Sets userinfo, argument is string like ‘name:pass’.
#registry

Instance Method Summary

#to_mailtext (also: #to_rfc822text)

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

Alias for #to_mailtext.
#to_s

Constructs String from ::URI.
#set_headers(v) protected

Private setter for headers v.
#set_to(v) protected

Private setter for to v.
#check_headers(v) private

Checks the headers v component against either * HEADER_REGEXP.
#check_to(v) private

Checks the to v component.

`Generic` - Inherited

#+	Alias for Generic#merge.
#-	Alias for Generic#route_from.
#==	Compares two URIs.
#absolute?	Returns true if `::URI` has a scheme (e.g.
#coerce	Args.
#component	Components of the `::URI` in the order.
#decoded_password	Returns the password component after `::URI` decoding.
#decoded_user	Returns the user component after `::URI` decoding.
#default_port	Returns default port.
#eql?,
#find_proxy	Returns a proxy `::URI`.
#hash, #inspect,
#merge	Args.
#merge!	Args.
#normalize	Returns normalized `::URI`.
#normalize!	Destructive version of `#normalize`.
#parser	Returns the parser to be used.
#route_from	Args.
#route_to	Args.
#select	Args.
#to_s	Constructs String from `::URI`.
#component_ary	Returns an Array of the components defined from the COMPONENT Array.
#set_host	Protected setter for the host component `v`.
#set_opaque	Protected setter for the opaque component `v`.
#set_password	Protected setter for the password component `v`.
#set_path	Protected setter for the path component `v`.
#set_port	Protected setter for the port component `v`.
#set_scheme	Protected setter for the scheme component `v`.
#set_user	Protected setter for the user component `v`.
#set_userinfo	Protected setter for the `user` component, and `password` if available (with validation).
#check_host	Checks the host `v` component for RFC2396 compliance and against the Parser Regexp for `:HOST`.
#check_opaque	Checks the opaque `v` component for RFC2396 compliance and against the Parser Regexp for `:OPAQUE`.
#check_password	Checks the password `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_path	Checks the path `v` component for RFC2396 compliance and against the Parser Regexp for `:ABS_PATH` and `:REL_PATH`.
#check_port	Checks the port `v` component for RFC2396 compliance and against the Parser Regexp for `:PORT`.
#check_scheme	Checks the scheme `v` component against the Parser Regexp for `:SCHEME`.
#check_user	Checks the user `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_userinfo	Checks the `user` and `password`.
#escape_userpass	Escapes ‘user:password’ `v` based on RFC 1738 section 3.1.
#merge_path	Merges a base path `base`, with relative path `rel`, returns a modified base path.
#replace!	Replaces self by other `::URI` object.
#route_from0,
#split_path	Returns an Array of the path split on ‘/’.
#split_userinfo	Returns the userinfo `ui` as `[user, password]` if properly formatted as ‘user:password’.
#set_registry, #check_registry, #route_from_path

Constructor Details

.new(*arg) ⇒ `MailTo`

Description

Creates a new 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.

[ GitHub ]

# 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

Class Method Details

.build(args)

Description

Creates a new 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(['joe@example.com', 'subject=Ruby'])
m1.to_s  # => "mailto:joe@example.com?subject=Ruby"

m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
m2.to_s  # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"

m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
m3.to_s  # => "mailto:listman@example.com?subject=subscribe"

[ GitHub ]

# 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

Instance Attribute Details

#headers (rw)

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

[ GitHub ]

# File 'lib/uri/mailto.rb', line 166


attr_reader :headers

#headers=(v) (rw)

Setter for headers v.

[ GitHub ]

# File 'lib/uri/mailto.rb', line 232


def headers=(v)
  check_headers(v)
  set_headers(v)
  v
end

#to (rw)

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

[ GitHub ]

# File 'lib/uri/mailto.rb', line 163


attr_reader :to

#to=(v) (rw)

Setter for to v.

[ GitHub ]

# File 'lib/uri/mailto.rb', line 200


def to=(v)
  check_to(v)
  set_to(v)
  v
end

Instance Method Details

#check_headers(v) (private)

Checks the headers v component against either

HEADER_REGEXP

[ GitHub ]

# 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) (private)

Checks the to v component.

[ GitHub ]

# 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

#set_headers(v) (protected)

Private setter for headers v.

[ GitHub ]

# 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) (protected)

Private setter for to v.

[ GitHub ]

# File 'lib/uri/mailto.rb', line 194


def set_to(v)
  @to = v
end

#to_mailtext 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:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
uri.to_mailtext
# => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"

[ GitHub ]

# 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

Alias for #to_mailtext.

[ GitHub ]

# File 'lib/uri/mailto.rb', line 289


alias to_rfc822text to_mailtext

#to_s

Constructs String from ::URI.

[ GitHub ]

# 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

Class: URI::MailTo

Overview

Constant Summary

::URI - Included

Generic - Inherited

Class Method Summary

Generic - Inherited

Instance Attribute Summary

Generic - Inherited

Instance Method Summary

Generic - Inherited

Constructor Details

.new(*arg) ⇒ MailTo

Description

Class Method Details

.build(args)

Description

Instance Attribute Details

#headers (rw)

#headers=(v) (rw)

#to (rw)

#to=(v) (rw)

Instance Method Details

#check_headers(v) (private)

#check_to(v) (private)

#set_headers(v) (protected)

#set_to(v) (protected)

#to_mailtext Also known as: #to_rfc822text

#to_rfc822text

#to_s

`::URI` - Included

`Generic` - Inherited

`Generic` - Inherited

`Generic` - Inherited

`Generic` - Inherited

.new(*arg) ⇒ `MailTo`