File: C:/Ruby27-x64/share/doc/ruby/html/URI/MailTo.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class URI::MailTo - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Generic.html">URI::Generic</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="REGEXP.html">URI::REGEXP</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-build">::build</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-check_headers">#check_headers</a>
<li ><a href="#method-i-check_to">#check_to</a>
<li ><a href="#method-i-headers-3D">#headers=</a>
<li ><a href="#method-i-set_headers">#set_headers</a>
<li ><a href="#method-i-set_to">#set_to</a>
<li ><a href="#method-i-to-3D">#to=</a>
<li ><a href="#method-i-to_mailtext">#to_mailtext</a>
<li ><a href="#method-i-to_rfc822text">#to_rfc822text</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-URI::MailTo">
<h1 id="class-URI::MailTo" class="class">
class URI::MailTo
</h1>
<section class="description">
<p>RFC6068, the mailto URL scheme.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="COMPONENT">COMPONENT
<dd><p>An <a href="../Array.html"><code>Array</code></a> of the available components for <a href="MailTo.html"><code>URI::MailTo</code></a>.</p>
<dt id="DEFAULT_PORT">DEFAULT_PORT
<dd><p>A Default port of nil for <a href="MailTo.html"><code>URI::MailTo</code></a>.</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-headers" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">headers</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>E-mail headers set by the URL, as an <a href="../Array.html"><code>Array</code></a> of Arrays.</p>
</div>
</div>
<div id="attribute-i-to" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">to</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The primary e-mail address of the URL, as a <a href="../String.html"><code>String</code></a>.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-build" class="method-detail ">
<div class="method-heading">
<span class="method-name">build</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-c-build-label-Description">Description<span><a href="#method-c-build-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Creates a new <a href="MailTo.html"><code>URI::MailTo</code></a> object from components, with syntax checking.</p>
<p>Components can be provided as an <a href="../Array.html"><code>Array</code></a> or <a href="../Hash.html"><code>Hash</code></a>. If an <a href="../Array.html"><code>Array</code></a> is used, the components must be supplied as <code>[to, headers]</code>.</p>
<p>If a <a href="../Hash.html"><code>Hash</code></a> is used, the keys are the component names preceded by colons.</p>
<p>The headers can be supplied as a pre-encoded string, such as <code>"subject=subscribe&cc=address"</code>, or as an <a href="../Array.html"><code>Array</code></a> of Arrays like <code>[['subject', 'subscribe'], ['cc', 'address']]</code>.</p>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-identifier">m1</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">MailTo</span>.<span class="ruby-identifier">build</span>([<span class="ruby-string">'joe@example.com'</span>, <span class="ruby-string">'subject=Ruby'</span>])
<span class="ruby-identifier">m1</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># => "mailto:joe@example.com?subject=Ruby"</span>
<span class="ruby-identifier">m2</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">MailTo</span>.<span class="ruby-identifier">build</span>([<span class="ruby-string">'john@example.com'</span>, [[<span class="ruby-string">'Subject'</span>, <span class="ruby-string">'Ruby'</span>], [<span class="ruby-string">'Cc'</span>, <span class="ruby-string">'jack@example.com'</span>]]])
<span class="ruby-identifier">m2</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"</span>
<span class="ruby-identifier">m3</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">MailTo</span>.<span class="ruby-identifier">build</span>({<span class="ruby-value">:to</span> <span class="ruby-operator">=></span> <span class="ruby-string">'listman@example.com'</span>, <span class="ruby-value">:headers</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">'subject'</span>, <span class="ruby-string">'subscribe'</span>]]})
<span class="ruby-identifier">m3</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># => "mailto:listman@example.com?subject=subscribe"</span>
</pre>
<div class="method-calls-super">
Calls superclass method
<a href="Generic.html#method-c-build"><code>URI::Generic::build</code></a>
</div>
<div class="method-source-code" id="build-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_components_hash</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">args</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:to</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:opaque</span>] = <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:to</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">','</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:opaque</span>] = <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:to</span>].<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:opaque</span>] = <span class="ruby-string">''</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:headers</span>]
<span class="ruby-identifier">query</span> =
<span class="ruby-keyword">case</span> <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:headers</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Array</span>)
<span class="ruby-identifier">x</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">+</span> <span class="ruby-string">'='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">x</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">join</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">x</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
}.<span class="ruby-identifier">join</span>(<span class="ruby-string">'&'</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">h</span> <span class="ruby-operator">+</span> <span class="ruby-string">'='</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">v</span>
}.<span class="ruby-identifier">join</span>(<span class="ruby-string">'&'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">query</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:opaque</span>] <span class="ruby-operator"><<</span> <span class="ruby-string">'?'</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">query</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">tmp</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-c-new-label-Description">Description<span><a href="#method-c-new-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Creates a new <a href="MailTo.html"><code>URI::MailTo</code></a> object from generic URL components with no syntax checking.</p>
<p>This method is usually called from <a href="../URI.html#method-c-parse"><code>URI::parse</code></a>, which checks the validity of each component.</p>
<div class="method-calls-super">
Calls superclass method
<a href="Generic.html#method-c-new"><code>URI::Generic::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 133</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-ivar">@to</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@headers</span> = []
<span class="ruby-comment"># The RFC3986 parser does not normally populate opaque</span>
<span class="ruby-ivar">@opaque</span> = <span class="ruby-node">"?#{@query}"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@query</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@opaque</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@opaque</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidComponentError</span>,
<span class="ruby-string">"missing opaque part for mailto URL"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">to</span>, <span class="ruby-identifier">header</span> = <span class="ruby-ivar">@opaque</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'?'</span>, <span class="ruby-value">2</span>)
<span class="ruby-comment"># allow semicolon as a addr-spec separator</span>
<span class="ruby-comment"># http://support.microsoft.com/kb/820868</span>
<span class="ruby-keyword">unless</span> <span class="ruby-regexp">/\A(?:[^@,;]+@[^@,;]+(?:\z|[,;]))*\z/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">to</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidComponentError</span>,
<span class="ruby-node">"unrecognised opaque part for mailtoURL: #{@opaque}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>[<span class="ruby-value">10</span>] <span class="ruby-comment"># arg_check</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">headers</span> = <span class="ruby-identifier">header</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">set_to</span>(<span class="ruby-identifier">to</span>)
<span class="ruby-identifier">set_headers</span>(<span class="ruby-identifier">header</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-headers-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">headers=</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for headers <code>v</code>.</p>
<div class="method-source-code" id="headers-3D-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 233</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">headers=</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">check_headers</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">set_headers</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">to=</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for to <code>v</code>.</p>
<div class="method-source-code" id="to-3D-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 201</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to=</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">check_to</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">set_to</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_mailtext" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_mailtext</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the RFC822 e-mail text equivalent of the URL, as a <a href="../String.html"><code>String</code></a>.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">"mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr"</span>)
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_mailtext</span>
<span class="ruby-comment"># => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"</span>
</pre>
<div class="method-source-code" id="to_mailtext-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 269</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_mailtext</span>
<span class="ruby-identifier">to</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">decode_www_form_component</span>(<span class="ruby-ivar">@to</span>)
<span class="ruby-identifier">head</span> = <span class="ruby-string">''</span>
<span class="ruby-identifier">body</span> = <span class="ruby-string">''</span>
<span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">x</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">'body'</span>
<span class="ruby-identifier">body</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">decode_www_form_component</span>(<span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>])
<span class="ruby-keyword">when</span> <span class="ruby-string">'to'</span>
<span class="ruby-identifier">to</span> <span class="ruby-operator"><<</span> <span class="ruby-string">', '</span> <span class="ruby-operator">+</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">decode_www_form_component</span>(<span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">head</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">decode_www_form_component</span>(<span class="ruby-identifier">x</span>[<span class="ruby-value">0</span>]).<span class="ruby-identifier">capitalize</span> <span class="ruby-operator">+</span> <span class="ruby-string">': '</span> <span class="ruby-operator">+</span>
<span class="ruby-constant">URI</span>.<span class="ruby-identifier">decode_www_form_component</span>(<span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>]) <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-node">"To: #{to}
#{head}
#{body}
"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MailTo.html#method-i-to_rfc822text">to_rfc822text</a>
</div>
</div>
<div id="method-i-to_rfc822text" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_rfc822text</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="MailTo.html#method-i-to_mailtext">to_mailtext</a>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Constructs <a href="../String.html"><code>String</code></a> from <a href="../URI.html"><code>URI</code></a>.</p>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 240</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-ivar">@scheme</span> <span class="ruby-operator">+</span> <span class="ruby-string">':'</span> <span class="ruby-operator">+</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@to</span>
<span class="ruby-ivar">@to</span>
<span class="ruby-keyword">else</span>
<span class="ruby-string">''</span>
<span class="ruby-keyword">end</span> <span class="ruby-operator">+</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-string">'?'</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'='</span>)}.<span class="ruby-identifier">join</span>(<span class="ruby-string">'&'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-string">''</span>
<span class="ruby-keyword">end</span> <span class="ruby-operator">+</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@fragment</span>
<span class="ruby-string">'#'</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@fragment</span>
<span class="ruby-keyword">else</span>
<span class="ruby-string">''</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-set_headers" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_headers</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for headers <code>v</code>.</p>
<div class="method-source-code" id="set_headers-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 222</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_headers</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-ivar">@headers</span> = []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'&'</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@headers</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/=/</span>, <span class="ruby-value">2</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_to" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_to</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for to <code>v</code>.</p>
<div class="method-source-code" id="set_to-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 195</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_to</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-ivar">@to</span> = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-check_headers" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_headers</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Checks the headers <code>v</code> component against either</p>
<ul><li>
<p>HEADER_REGEXP</p>
</li></ul>
<div class="method-source-code" id="check_headers-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 209</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_headers</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">HEADER_REGEXP</span> <span class="ruby-operator">!~</span> <span class="ruby-identifier">v</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidComponentError</span>,
<span class="ruby-node">"bad component(expected opaque component): #{v}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_to" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_to</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Checks the to <code>v</code> component.</p>
<div class="method-source-code" id="check_to-source">
<pre><span class="ruby-comment"># File lib/uri/mailto.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_to</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/[,;]/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">addr</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># check url safety as path-rootless</span>
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\A(?:%\h\h|[!$&-.0-;=@-Z_a-z~])*\z/</span> <span class="ruby-operator">!~</span> <span class="ruby-identifier">addr</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidComponentError</span>,
<span class="ruby-node">"an address in 'to' is invalid as URI #{addr.dump}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># check addr-spec</span>
<span class="ruby-comment"># don't s/\+/ /g</span>
<span class="ruby-identifier">addr</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/%\h\h/</span>, <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">TBLDECWWWCOMP_</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">EMAIL_REGEXP</span> <span class="ruby-operator">!~</span> <span class="ruby-identifier">addr</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidComponentError</span>,
<span class="ruby-node">"an address in 'to' is invalid as uri-escaped addr-spec #{addr.dump}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>