class.Solar_Smtp_Adapter_CramMd5Auth.Properties

/version/1.1.2/apidoc/website/class.Solar_Smtp_Adapter_CramMd5Auth.Properties

https://bitbucket.org/solarphp/docs
Properties File | 281 lines | 171 code | 110 blank | 0 comment | 0 complexity | 7180f176aa4cb6a4711c66565ca8b297 MD5 | raw file
Possible License(s): IPL-1.0, LGPL-2.0, Apache-2.0, 0BSD


    <div class="navheader">
        <table width="100%" summary="Navigation header">
            <tr>
                <th colspan="3" align="center">Properties</th>
            </tr>
            <tr>
                <td width="20%" align="left"><a accesskey="p" href="class.Solar_Smtp_Adapter_CramMd5Auth.Constants">Prev</a></td>
                <th width="60%" align="center">Solar_Smtp_Adapter_CramMd5Auth</th>
                <td width="20%" align="right"><a accesskey="n" href="class.Solar_Smtp_Adapter_CramMd5Auth.Methods">Next</a></td>
            </tr>
        </table>
    </div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties" class="section">

<h1>Properties</h1>

<p class="para">Properties existing in the <code class="literal">Solar_Smtp_Adapter_CramMd5Auth</code> class.</p>

<div>
<h2>Public</h2>

<p class="para">None.</p>

</div>

<div>
<h2>Protected</h2>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._Solar_Smtp_Adapter">
<h3><code class="literal">$_Solar_Smtp_Adapter</code> </h3>

<p class="para"><em class="emphasis">(array)</em> Default configuration values.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._Solar_Smtp_Adapter" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._Solar_Smtp_Adapter_PlainAuth">
<h3><code class="literal">$_Solar_Smtp_Adapter_PlainAuth</code> </h3>

<p class="para"><em class="emphasis">(array)</em> Default configuration values.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter_PlainAuth.Properties#class.Solar_Smtp_Adapter_PlainAuth.Properties._Solar_Smtp_Adapter_PlainAuth" class="link">Solar_Smtp_Adapter_PlainAuth</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._auth">
<h3><code class="literal">$_auth</code> </h3>

<p class="para"><em class="emphasis">(bool)</em> Has SMTP AUTH has been issued successfully?</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._auth" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._client">
<h3><code class="literal">$_client</code> </h3>

<p class="para"><em class="emphasis">(string)</em> The client address making SMTP request (that is, the local machine).</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._client" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._config">
<h3><code class="literal">$_config</code> </h3>

<p class="para"><em class="emphasis">(array)</em> Collection point for configuration values.</p>

<p class="para">Inherited from <a href="class.Solar_Base.Properties#class.Solar_Base.Properties._config" class="link">Solar_Base</a>.</p>

<p class="para">Note that you do not define config defaults in $_config directly.</p>

<pre class="programlisting"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #FF8000">// DO NOT DO THIS
</span><span style="color: #007700">protected </span><span style="color: #0000BB">$_config </span><span style="color: #007700">= array(
    </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">,
    </span><span style="color: #DD0000">'baz' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'dib'</span><span style="color: #007700">,
);</span></span></code></pre>


<p class="para">Instead, define config defaults in a protected property named for the
class, withan underscore prefix.</p>

<p class="para">For exmple, a &quot;Vendor_Class_Name&quot; class would define the default 
config array in &quot;$_Vendor_Class_Name&quot;.  This convention lets 
child classes inherit parent config keys and values.</p>

<pre class="programlisting"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #FF8000">// DO THIS INSTEAD
</span><span style="color: #007700">protected </span><span style="color: #0000BB">$_Vendor_Class_Name </span><span style="color: #007700">= array(
    </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">,
    </span><span style="color: #DD0000">'baz' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'dib'</span><span style="color: #007700">,
);</span></span></code></pre>


</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._conn">
<h3><code class="literal">$_conn</code> </h3>

<p class="para"><em class="emphasis">(resource)</em> Connection resource.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._conn" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._context">
<h3><code class="literal">$_context</code> </h3>

<p class="para"><em class="emphasis">(array)</em> The stream context for this connection, if any.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._context" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._crlf">
<h3><code class="literal">$_crlf</code> </h3>

<p class="para"><em class="emphasis">(string)</em> Line-ending string; default &quot;\r\n&quot;.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._crlf" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._data">
<h3><code class="literal">$_data</code> </h3>

<p class="para"><em class="emphasis">(bool)</em> Has SMTP DATA has been issued successfully?</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._data" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._flags">
<h3><code class="literal">$_flags</code> </h3>

<p class="para"><em class="emphasis">(int)</em> The connection flags for this connection; default is  STREAM_CLIENT_CONNECT.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._flags" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._helo">
<h3><code class="literal">$_helo</code> </h3>

<p class="para"><em class="emphasis">(bool)</em> Has a session been started (that is, has HELO/EHLO been issued)?</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._helo" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._host">
<h3><code class="literal">$_host</code> </h3>

<p class="para"><em class="emphasis">(string)</em> Hostname or IP address of SMTP server.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._host" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._log">
<h3><code class="literal">$_log</code> </h3>

<p class="para"><em class="emphasis">(array())</em> Log of requests and response strings.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._log" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._mail">
<h3><code class="literal">$_mail</code> </h3>

<p class="para"><em class="emphasis">(bool)</em> Has SMTP MAIL been issued?</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._mail" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._password">
<h3><code class="literal">$_password</code> </h3>

<p class="para"><em class="emphasis">(string)</em> Password for authentication.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter_PlainAuth.Properties#class.Solar_Smtp_Adapter_PlainAuth.Properties._password" class="link">Solar_Smtp_Adapter_PlainAuth</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._port">
<h3><code class="literal">$_port</code> </h3>

<p class="para"><em class="emphasis">(int)</em> Connect to SMTP server on this port.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._port" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._rcpt">
<h3><code class="literal">$_rcpt</code> </h3>

<p class="para"><em class="emphasis">(bool)</em> Has SMTP RCPT been issued?</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._rcpt" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._secure">
<h3><code class="literal">$_secure</code> </h3>

<p class="para"><em class="emphasis">(string)</em> The security protocol for this connection, if any.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._secure" class="link">Solar_Smtp_Adapter</a>.</p>

<p class="para">Values are &#039;ssl&#039; and &#039;tls&#039;.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._time">
<h3><code class="literal">$_time</code> </h3>

<p class="para"><em class="emphasis">(array)</em> Expected timeouts for various activities.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._time" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._timeout">
<h3><code class="literal">$_timeout</code> </h3>

<p class="para"><em class="emphasis">(int)</em> Timeout in seconds for initiating session; default 30.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._timeout" class="link">Solar_Smtp_Adapter</a>.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._transport">
<h3><code class="literal">$_transport</code> </h3>

<p class="para"><em class="emphasis">(string)</em> The transport method for the socket; default is &#039;tcp&#039;.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter.Properties#class.Solar_Smtp_Adapter.Properties._transport" class="link">Solar_Smtp_Adapter</a>.</p>

<p class="para">Values are &#039;tcp&#039; and &#039;ssl&#039;.</p>

</div>

<div id="class.Solar_Smtp_Adapter_CramMd5Auth.Properties._username">
<h3><code class="literal">$_username</code> </h3>

<p class="para"><em class="emphasis">(string)</em> Username for authentication.</p>

<p class="para">Inherited from <a href="class.Solar_Smtp_Adapter_PlainAuth.Properties#class.Solar_Smtp_Adapter_PlainAuth.Properties._username" class="link">Solar_Smtp_Adapter_PlainAuth</a>.</p>

</div>

</div>

<div>
<h2>Private</h2>

<p class="para">None.</p>

</div>
    
</div>
    <div class="navfooter">
        <table width="100%" summary="Navigation footer">
            <tr>
                <td width="40%" align="left"><a accesskey="p" href="class.Solar_Smtp_Adapter_CramMd5Auth.Constants">Prev</a></td>
                <td width="20%" align="center"><a accesskey="u" href="class.Solar_Smtp_Adapter_CramMd5Auth">Up</a></td>
                <td width="40%" align="right"><a accesskey="n" href="class.Solar_Smtp_Adapter_CramMd5Auth.Methods">Next</a></td>
            </tr>
            <tr>
                <td width="40%" align="left" valign="top">Constants</td>
                <td width="20%" align="center"><a accesskey="h" href="apidoc">Home</a></td>
                <td width="40%" align="right" valign="top">Methods</td>
            </tr>
        </table>
    </div>