Class: URI::MailTo
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Generic
|
|
Instance Chain:
|
|
Inherits: |
URI::Generic
|
Defined in: | lib/uri/mailto.rb |
Overview
RFC6068, The mailto URL scheme
Constant Summary
-
COMPONENT =
An Array of the available components for
MailTo
[ :scheme, :to, :headers ].freeze
-
DEFAULT_PORT =
A Default port of nil for
MailTo
nil
::URI - Included
DEFAULT_PARSER, Parser, REGEXP, RFC3986_PARSER
Generic - Inherited
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. |
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
#fragment | returns the fragment component of the ::URI. |
#fragment= | check the fragment |
#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= | set 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. |
#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=, | |
#scheme | returns the scheme component of the ::URI. |
#scheme= | Args. |
#user | returns the user component. |
#user= | Args. |
#userinfo | returns the userinfo, either as 'user' or 'user:password'. |
#userinfo= | Sets userinfo, argument is string like 'name:pass'. |
#absolute | Alias for Generic#absolute?. |
#hierarchical? | Checks if ::URI has a path. |
#relative? | Checks if ::URI is relative. |
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
check the headers
v
component against either * HEADER_REGEXP. -
#check_to(v)
private
check the to
v
component.
Generic - Inherited
#+ | Alias for Generic#merge. |
#- | Alias for Generic#route_from. |
#== | Compares to URI's. |
#absolute? | Checks if ::URI is an absolute one. |
#coerce | Args. |
#component | Components of the ::URI in the order. |
#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 |
#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 |
#set_opaque | protected setter for the opaque component |
#set_password | protected setter for the password component |
#set_path | protected setter for the path component |
#set_port | protected setter for the port component |
#set_scheme | protected setter for the scheme component |
#set_user | protected setter for the user component |
#set_userinfo | protect setter for the |
#check_host | check the host |
#check_opaque | check the opaque |
#check_password | check the password |
#check_path | check the path |
#check_port | check the port |
#check_scheme | check the scheme |
#check_user | check the user |
#check_userinfo | check the |
#escape_userpass | escapes 'user:password' |
#merge0 | return base and rel. |
#merge_path | Merges a base path |
#replace! | replace self by other ::URI object. |
#route_from0, | |
#split_path | returns an Array of the path split on '/'. |
#split_userinfo | returns the userinfo |
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.
# File 'lib/uri/mailto.rb', line 133
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']) puts m1.to_s -> mailto:joe@example.com?subject=Ruby m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]]) puts m2.to_s -> mailto:john@example.com?Subject=Ruby&Cc=jack@example.com m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]}) puts m3.to_s -> mailto:listman@example.com?subject=subscribe
# File 'lib/uri/mailto.rb', line 86
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
# File 'lib/uri/mailto.rb', line 167
attr_reader :headers
#headers=(v) (rw)
setter for headers v
# File 'lib/uri/mailto.rb', line 233
def headers=(v) check_headers(v) set_headers(v) v end
#to (rw)
The primary e-mail address of the URL, as a String
# File 'lib/uri/mailto.rb', line 164
attr_reader :to
#to=(v) (rw)
setter for to v
Instance Method Details
#check_headers(v) (private)
check the headers v
component against either
# File 'lib/uri/mailto.rb', line 209
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)
check the to v
component
# File 'lib/uri/mailto.rb', line 170
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
#set_to(v) (protected)
private setter for to v
# File 'lib/uri/mailto.rb', line 195
def set_to(v) @to = v end
#to_mailtext Also known as: #to_rfc822text
# File 'lib/uri/mailto.rb', line 269
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.
# File 'lib/uri/mailto.rb', line 290
alias to_rfc822text to_mailtext
#to_s
Constructs String from ::URI