mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 11:54:29 -07:00
625 lines
45 KiB
HTML
625 lines
45 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Networking::SmtpClient - 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="../../Object.html">Object</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-new">::new</a>
|
|
|
|
<li ><a href="#method-i-attachment_template">#attachment_template</a>
|
|
|
|
<li ><a href="#method-i-host">#host</a>
|
|
|
|
<li ><a href="#method-i-login">#login</a>
|
|
|
|
<li ><a href="#method-i-logout">#logout</a>
|
|
|
|
<li ><a href="#method-i-message_template">#message_template</a>
|
|
|
|
<li ><a href="#method-i-port">#port</a>
|
|
|
|
<li ><a href="#method-i-send_message">#send_message</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Networking::SmtpClient">
|
|
<h1 id="class-GxG::Networking::SmtpClient" class="class">
|
|
class GxG::Networking::SmtpClient
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
<p>SMTP Classes:</p>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(host=nil,port=nil,options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1375</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">host</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">port</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">options</span>={})
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">port</span>
|
|
<span class="ruby-identifier">port</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@user</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@password</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">host</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@host</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a HOST, like this: <host>,(<port>),(<options>)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">465</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>]
|
|
<span class="ruby-comment"># Valid: [:TLSv1, :TLSv1_server, :TLSv1_client, :TLSv1_1, :TLSv1_1_server, :TLSv1_1_client, :TLSv1_2, :TLSv1_2_server, :TLSv1_2_client, :SSLv23, :SSLv23_server, :SSLv23_client]</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span><span class="ruby-operator">::</span><span class="ruby-constant">METHODS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>])
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Encryption method #{options[:ssl_method].inspect} is not valid. Choose one of these: #{OpenSSL::SSL::SSLContext::METHODS.inspect}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>])
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTP</span>.<span class="ruby-identifier">default_ssl_context</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ignore_ssl_errors</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">openssl_context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_NONE</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">openssl_context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">25</span>)
|
|
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@port</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">openssl_context</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">enable_ssl</span>(<span class="ruby-identifier">openssl_context</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">self</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-attachment_template" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">attachment_template</span><span
|
|
class="method-args">(the_path="", content_parameters={"name" => ""})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="attachment_template-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1472</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attachment_template</span>(<span class="ruby-identifier">the_path</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">content_parameters</span>={<span class="ruby-string">"name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>})
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">valid_path?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid file system path to the file."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide content_parameters as a Hash."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>[<span class="ruby-string">"name"</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">content_parameters</span>[<span class="ruby-string">"name"</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">the_path</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-operator">::</span><span class="ruby-constant">MimeMagic</span>.<span class="ruby-identifier">by_magic</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">the_path</span>,<span class="ruby-string">"rb"</span>))
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">discovered_mime</span>
|
|
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-identifier">discovered_mime</span>.<span class="ruby-identifier">type</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-string">"application/octet-stream"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">discovered_mime</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}, <span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> (<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">the_path</span>)), <span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_path</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>}
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_path</span>, <span class="ruby-value">:content_parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-host" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">host</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="host-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1415</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">host</span>()
|
|
<span class="ruby-ivar">@host</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-login" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">login</span><span
|
|
class="method-args">(user_id=nil,password=nil,authentication_method=:plain)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="login-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1423</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">user_id</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">password</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">authentication_method</span>=<span class="ruby-value">:plain</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-ivar">@user</span> = <span class="ruby-identifier">user_id</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@user</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a USER id, like this: <user_id>,<password/oauth-token>,(<options>)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@password</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a PASSWORD/OAUTH-TOKEN, like this: <user_id>,<password/oauth-token>,(<options>)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">started?</span>
|
|
<span class="ruby-keyword">unless</span> [<span class="ruby-value">:plain</span>, <span class="ruby-value">:login</span>, <span class="ruby-value">:cram_md5</span>, <span class="ruby-value">:oauth2</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">authentication_method</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Authentication method #{authentication_method.inspect} is invalid. Choose one of these: [:plain, :login, :cram_md5, :oauth2]"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># Internal cosmetics for interface consistency.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">authentication_method</span> <span class="ruby-operator">==</span> <span class="ruby-value">:oauth2</span>
|
|
<span class="ruby-identifier">authentication_method</span> = <span class="ruby-value">:xoauth2</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">start</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@user</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-identifier">authentication_method</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-comment"># Internal cosmetics for interface consistency.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">authentication_method</span> <span class="ruby-operator">==</span> <span class="ruby-value">:xoauth2</span>
|
|
<span class="ruby-identifier">authentication_method</span> = <span class="ruby-value">:oauth2</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:user</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">user_id</span>, <span class="ruby-value">:authentication</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">authentication_method</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-logout" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">logout</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="logout-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1457</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">finish</span>
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-message_template" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">message_template</span><span
|
|
class="method-args">(mime_type="text/plain", content_parameters={"charset"=>"UTF-8"})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="message_template-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1497</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message_template</span>(<span class="ruby-identifier">mime_type</span>=<span class="ruby-string">"text/plain"</span>, <span class="ruby-identifier">content_parameters</span>={<span class="ruby-string">"charset"</span><span class="ruby-operator">=></span><span class="ruby-string">"UTF-8"</span>})
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> [<span class="ruby-string">'text/plain'</span>, <span class="ruby-string">'text/html'</span>, <span class="ruby-string">'text/xhtml'</span>, <span class="ruby-string">'text/xml'</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">mime_type</span>.<span class="ruby-identifier">to_s</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Content Type specified was invalid. Choose one of these: ['text/plain', 'text/html', 'text/xhtml', 'text/xml']"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide content_parameters as a Hash."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">gxg_message</span> = <span class="ruby-identifier">new_message</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>] = <span class="ruby-string">""</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>] = <span class="ruby-node">"<#{gxg_message[:id].to_s}@#{::Socket.gethostname}.mail>"</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:to</span>] = <span class="ruby-string">""</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>] = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>] = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:subject</span>] = <span class="ruby-string">""</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:date</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">now</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:header</span>] = {}
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>] = [{<span class="ruby-value">:prologue</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>},{<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mime_type</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>},{<span class="ruby-value">:epilogue</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>}]
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>] = []
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">gxg_message</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:content_parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-port" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">port</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="port-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1419</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">port</span>()
|
|
<span class="ruby-ivar">@port</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-send_message" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">send_message</span><span
|
|
class="method-args">(gxg_message=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="send_message-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1524</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_message</span>(<span class="ruby-identifier">gxg_message</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">started?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"SMTP session not started yet."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">gxg_message</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Events</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid message object of class ::GxG::Events::Message. Suggested: <SmtpClient>.message_template(<Mime-Type-String>)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># Build suitable mail message</span>
|
|
<span class="ruby-identifier">message</span> = <span class="ruby-constant">Mail</span>.<span class="ruby-identifier">new</span>
|
|
<span class="ruby-identifier">the_fields</span> = []
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_field_value</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">the_fields</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{the_key.to_s}: #{the_field_value.to_s}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">the_fields</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{the_key.to_s}: #{the_value.to_s}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">header</span> = <span class="ruby-identifier">the_fields</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\r\n"</span>)
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">from</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">reply_to</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"@"</span>)
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_id</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_s</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_id</span> = <span class="ruby-node">"<#{gxg_message[:id].to_s}@#{::Socket.gethostname}.mail>"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:to</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">cc</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">bcc</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:subject</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">date</span> = (<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:date</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_s</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">part_count</span> = <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
|
<span class="ruby-identifier">part_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part_count</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
|
|
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
|
<span class="ruby-identifier">type_info</span> = <span class="ruby-node">"Content-Type: #{part[:content_type][:type]}"</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:content_type</span>][<span class="ruby-value">:parameters</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">part</span>[<span class="ruby-value">:content_type</span>][<span class="ruby-value">:parameters</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">type_info</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"; '#{the_key.to_s}': '#{the_value.to_s}'"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">new_part</span> = <span class="ruby-constant">Mail</span><span class="ruby-operator">::</span><span class="ruby-constant">Part</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">type_info</span>)
|
|
<span class="ruby-identifier">new_part</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">part</span>[<span class="ruby-value">:content</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add_part</span>(<span class="ruby-identifier">new_part</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># Add file attachments:</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attachment</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">file_size</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:path</span>])
|
|
<span class="ruby-identifier">file_handle</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:path</span>],<span class="ruby-string">"rb"</span>)
|
|
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">apportioned_ranges</span>(<span class="ruby-identifier">file_size</span>,<span class="ruby-value">65536</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_range</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-identifier">the_range</span>.<span class="ruby-identifier">first</span>)
|
|
<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">the_range</span>.<span class="ruby-identifier">size</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">close</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add_file</span>({<span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:filename</span>], <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>].<span class="ruby-identifier">to_s</span>})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
|
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">part</span>[<span class="ruby-value">:content</span>]
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># Send it</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>], <span class="ruby-identifier">message</span>.<span class="ruby-identifier">destinations</span>)
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:message</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">gxg_message</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</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.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|