Class: URI::MailTo
- Includes:
- REGEXP
- Defined in:
- lib/uri/mailto.rb
Overview
RFC2368, 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_PATTERN =
hname = *urlc hvalue = *urlc header = hname “=” hvalue
"(?:[^?=&]*=[^?=&]*)".freeze
- HEADER_REGEXP =
Regexp.new(HEADER_PATTERN).freeze
- MAILBOX_PATTERN =
headers = “?” header *( “&” header ) to = #mailbox mailtoURL = “mailto:” [ to ] [ headers ]
"(?:#{PATTERN::ESCAPED}|[^(),%?=&])".freeze
- MAILTO_REGEXP =
Regexp.new(" # :nodoc: \\A (#{MAILBOX_PATTERN}*?) (?# 1: to) (?: \\? (#{HEADER_PATTERN}(?:\\&#{HEADER_PATTERN})*) (?# 2: headers) )? (?: \\# (#{PATTERN::FRAGMENT}) (?# 3: fragment) )? \\z ", Regexp::EXTENDED).freeze
Constants inherited from Generic
Constants included from URI
DEFAULT_PARSER, HTML5ASCIIINCOMPAT, TBLDECWWWCOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE
Instance Attribute Summary collapse
-
#headers ⇒ Object
E-mail headers set by the URL, as an Array of Arrays.
-
#to ⇒ Object
The primary e-mail address of the URL, as a String.
Attributes inherited from Generic
#fragment, #host, #opaque, #path, #port, #query, #registry, #scheme
Class Method Summary collapse
-
.build(args) ⇒ Object
Description.
Instance Method Summary collapse
-
#initialize(*arg) ⇒ MailTo
constructor
Description.
-
#to_mailtext ⇒ Object
(also: #to_rfc822text)
Returns the RFC822 e-mail text equivalent of the URL, as a String.
-
#to_s ⇒ Object
Constructs String from URI.
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=, #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
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.
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 134 def initialize(*arg) super(*arg) @to = nil @headers = [] if MAILTO_REGEXP =~ @opaque if arg[-1] self.to = $1 self.headers = $2 else set_to($1) set_headers($2) end else raise InvalidComponentError, "unrecognised opaque part for mailtoURL: #{@opaque}" 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
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 122 123 |
# File 'lib/uri/mailto.rb', line 91 def self.build(args) tmp = Util::make_components_hash(self, args) if tmp[:to] tmp[:opaque] = tmp[:to] else tmp[:opaque] = '' end if tmp[:headers] tmp[:opaque] << '?' if tmp[:headers].kind_of?(Array) tmp[:opaque] << tmp[:headers].collect { |x| if x.kind_of?(Array) x[0] + '=' + x[1..-1].join else x.to_s end }.join('&') elsif tmp[:headers].kind_of?(Hash) tmp[:opaque] << tmp[:headers].collect { |h,v| h + '=' + v }.join('&') else tmp[:opaque] << tmp[:headers].to_s 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"
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/uri/mailto.rb', line 255 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
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/uri/mailto.rb', line 226 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 |