535 lines
13 KiB
HTML
535 lines
13 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
<title>Class Opencart\System\Library\Mail | OpenCart API API</title>
|
|
<link rel="stylesheet" href="http://localhost\opencart-master/docs/api/assets/main.css">
|
|
<script src="http://localhost\opencart-master/docs/api/assets/main.js" defer></script>
|
|
</head>
|
|
|
|
<body class="layout">
|
|
<div class="layout-aside">
|
|
<div class="menu">
|
|
<div class="menu-section">
|
|
<h3>Namespaces</h3>
|
|
<ul>
|
|
<li class="menuGroup-item active">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>
|
|
<ul>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.html">Admin</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Catalog.html">Catalog</a>
|
|
</li>
|
|
<li class="menuGroup-item active">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>
|
|
<ul>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Engine.html">Engine</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Helper.html">Helper</a>
|
|
</li>
|
|
<li class="menuGroup-item active">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Library</a>
|
|
<ul>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Cache.html">Cache</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Cart.html">Cart</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.DB.html">DB</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Mail.html">Mail</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Session.html">Session</a>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Template.html">Template</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="menuGroup-item">
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-none.html">none</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="menu-section">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Cache.html">
|
|
Cache
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.DB.html">
|
|
DB
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Document.html">
|
|
Document
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Image.html">
|
|
Image
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Language.html">
|
|
Language
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Log.html">
|
|
Log
|
|
</a>
|
|
</li>
|
|
<li class="active">
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Mail.html">
|
|
Mail
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Request.html">
|
|
Request
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Response.html">
|
|
Response
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Session.html">
|
|
Session
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Template.html">
|
|
Template
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Url.html">
|
|
Url
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="layout-main">
|
|
<div class="layout-navbar">
|
|
<nav class="navbar">
|
|
<div class="navbar-left">
|
|
<ul class="navbar-links">
|
|
<li>
|
|
<a href="http://localhost\opencart-master/docs/api/index.html">Overview</a>
|
|
</li>
|
|
<li>
|
|
|
|
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Namespace</a>
|
|
|
|
</li>
|
|
<li class="active"><a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Mail.html">Class</a></li> <li>
|
|
<a href="http://localhost\opencart-master/docs/api/tree.html">Tree</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="navbar-right">
|
|
<div class="search" data-elements="http://localhost\opencart-master/docs/api/assets/elements.js">
|
|
<input class="search-input" placeholder="Search class, function or namespace" autofocus>
|
|
<ul class="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</div>
|
|
|
|
<div class="layout-content">
|
|
<h1>
|
|
Class <a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Library</a>\<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Mail.html">Mail</a>
|
|
</h1>
|
|
|
|
|
|
<table class="classLikeSignatureTable">
|
|
|
|
|
|
|
|
|
|
</table>
|
|
<div class="classLikeDescription">
|
|
<div class="description"><p>Class Mail</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="classLikeSection">
|
|
<b>Located at</b> <a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#15" title="Go to source code">system\library\mail.php</a><br>
|
|
</div>
|
|
|
|
|
|
|
|
<table class="table" id="methods">
|
|
<tr>
|
|
<th class="table-heading sortable" colspan="3" title="Switch between natural and alphabetical order">Methods</th>
|
|
</tr>
|
|
|
|
<tr class="expandable collapsed" data-order="__construct" id="___construct">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#22-38" title="Go to source code">__construct</a>(<span>string <var>$adaptor</var> = <span class="php-str">'mail'</span></span>, <span>array<string, mixed> <var>$option</var> = []</span>)</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Constructor</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Constructor</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#___construct">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setTo" id="_setTo">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#40-49" title="Go to source code">setTo</a>(<span>array<string>|string <var>$to</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setTo</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setTo</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setTo">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setFrom" id="_setFrom">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#51-60" title="Go to source code">setFrom</a>(<span>string <var>$from</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setFrom</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setFrom</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setFrom">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setSender" id="_setSender">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#62-71" title="Go to source code">setSender</a>(<span>string <var>$sender</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setSender</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setSender</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setSender">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setReplyTo" id="_setReplyTo">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#73-82" title="Go to source code">setReplyTo</a>(<span>string <var>$reply_to</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setReplyTo</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setReplyTo</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setReplyTo">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setSubject" id="_setSubject">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#84-93" title="Go to source code">setSubject</a>(<span>string <var>$subject</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setSubject</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setSubject</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setSubject">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setText" id="_setText">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#95-104" title="Go to source code">setText</a>(<span>string <var>$text</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setText</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setText</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setText">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="setHtml" id="_setHtml">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#106-115" title="Go to source code">setHtml</a>(<span>string <var>$html</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>setHtml</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>setHtml</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_setHtml">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="addAttachment" id="_addAttachment">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#117-126" title="Go to source code">addAttachment</a>(<span>string <var>$filename</var></span>): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>addAttachment</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>addAttachment</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_addAttachment">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="send" id="_send">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.mail.html#128-155" title="Go to source code">send</a>(): bool</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Send</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Send</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_send">#</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="layout-footer">
|
|
OpenCart API API documentation generated by <a href="https://www.apigen.org">ApiGen dev-master</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="layout-rest">
|
|
<div class="navbar"></div>
|
|
</div>
|
|
</body>
|
|
</html>
|