opencart/docs/api/source-system.library.mail.html
2024-03-04 23:29:14 +08:00

179 lines
30 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>File system\library\mail.php | 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">
<table class="source"><tr id="1" class="source-line"><td><a class="source-lineNum" href="#1"> 1: </a></td><td><span class="php-tag">&lt;?php
</span></td></tr><tr id="2" class="source-line"><td><a class="source-lineNum" href="#2"> 2: </a></td><td><span class="php-tag"></span><span class="php-comment">/**
</span></td></tr><tr id="3" class="source-line"><td><a class="source-lineNum" href="#3"> 3: </a></td><td><span class="php-comment"> * @package OpenCart
</span></td></tr><tr id="4" class="source-line"><td><a class="source-lineNum" href="#4"> 4: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="5" class="source-line"><td><a class="source-lineNum" href="#5"> 5: </a></td><td><span class="php-comment"> * @author Daniel Kerr
</span></td></tr><tr id="6" class="source-line"><td><a class="source-lineNum" href="#6"> 6: </a></td><td><span class="php-comment"> * @copyright Copyright (c) 2005 - 2017, OpenCart, Ltd. (https://www.opencart.com/)
</span></td></tr><tr id="7" class="source-line"><td><a class="source-lineNum" href="#7"> 7: </a></td><td><span class="php-comment"> * @license https://opensource.org/licenses/GPL-3.0
</span></td></tr><tr id="8" class="source-line"><td><a class="source-lineNum" href="#8"> 8: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="9" class="source-line"><td><a class="source-lineNum" href="#9"> 9: </a></td><td><span class="php-comment"> * @see https://www.opencart.com
</span></td></tr><tr id="10" class="source-line"><td><a class="source-lineNum" href="#10"> 10: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="11" class="source-line"><td><a class="source-lineNum" href="#11"> 11: </a></td><td><span class="php-kw">namespace</span> Opencart\System\Library;
</td></tr><tr id="12" class="source-line"><td><a class="source-lineNum" href="#12"> 12: </a></td><td><span class="php-comment">/**
</span></td></tr><tr id="13" class="source-line"><td><a class="source-lineNum" href="#13"> 13: </a></td><td><span class="php-comment"> * Class Mail
</span></td></tr><tr id="14" class="source-line"><td><a class="source-lineNum" href="#14"> 14: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="15" class="source-line"><td><a class="source-lineNum" href="#15"> 15: </a></td><td><span class="php-kw">class</span> Mail {
</td></tr><tr id="16" class="source-line"><td><a class="source-lineNum" href="#16"> 16: </a></td><td> <span class="php-kw">private</span> object <span class="php-var">$adaptor</span>;
</td></tr><tr id="17" class="source-line"><td><a class="source-lineNum" href="#17"> 17: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="18" class="source-line"><td><a class="source-lineNum" href="#18"> 18: </a></td><td><span class="php-comment"> * @var array&lt;string, mixed&gt;
</span></td></tr><tr id="19" class="source-line"><td><a class="source-lineNum" href="#19"> 19: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="20" class="source-line"><td><a class="source-lineNum" href="#20"> 20: </a></td><td> <span class="php-kw">private</span> <span class="php-kw">array</span> <span class="php-var">$option</span> = [];
</td></tr><tr id="21" class="source-line"><td><a class="source-lineNum" href="#21"> 21: </a></td><td>
</td></tr><tr id="22" class="source-line"><td><a class="source-lineNum" href="#22"> 22: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="23" class="source-line"><td><a class="source-lineNum" href="#23"> 23: </a></td><td><span class="php-comment"> * Constructor
</span></td></tr><tr id="24" class="source-line"><td><a class="source-lineNum" href="#24"> 24: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="25" class="source-line"><td><a class="source-lineNum" href="#25"> 25: </a></td><td><span class="php-comment"> * @param string $adaptor
</span></td></tr><tr id="26" class="source-line"><td><a class="source-lineNum" href="#26"> 26: </a></td><td><span class="php-comment"> * @param array&lt;string, mixed&gt; $option
</span></td></tr><tr id="27" class="source-line"><td><a class="source-lineNum" href="#27"> 27: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="28" class="source-line"><td><a class="source-lineNum" href="#28"> 28: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> __construct(string <span class="php-var">$adaptor</span> = <span class="php-str">&#039;mail&#039;</span>, <span class="php-kw">array</span> <span class="php-var">$option</span> = []) {
</td></tr><tr id="29" class="source-line"><td><a class="source-lineNum" href="#29"> 29: </a></td><td> <span class="php-var">$class</span> = <span class="php-str">&#039;Opencart\System\Library\Mail\\&#039;</span> . <span class="php-var">$adaptor</span>;
</td></tr><tr id="30" class="source-line"><td><a class="source-lineNum" href="#30"> 30: </a></td><td>
</td></tr><tr id="31" class="source-line"><td><a class="source-lineNum" href="#31"> 31: </a></td><td> <span class="php-kw">if</span> (class_exists(<span class="php-var">$class</span>)) {
</td></tr><tr id="32" class="source-line"><td><a class="source-lineNum" href="#32"> 32: </a></td><td> <span class="php-var">$this</span>-&gt;option = &amp;<span class="php-var">$option</span>;
</td></tr><tr id="33" class="source-line"><td><a class="source-lineNum" href="#33"> 33: </a></td><td>
</td></tr><tr id="34" class="source-line"><td><a class="source-lineNum" href="#34"> 34: </a></td><td> <span class="php-var">$this</span>-&gt;adaptor = <span class="php-kw">new</span> <span class="php-var">$class</span>(<span class="php-var">$option</span>);
</td></tr><tr id="35" class="source-line"><td><a class="source-lineNum" href="#35"> 35: </a></td><td> } <span class="php-kw">else</span> {
</td></tr><tr id="36" class="source-line"><td><a class="source-lineNum" href="#36"> 36: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: Could not load mail adaptor &#039;</span> . <span class="php-var">$adaptor</span> . <span class="php-str">&#039;!&#039;</span>);
</td></tr><tr id="37" class="source-line"><td><a class="source-lineNum" href="#37"> 37: </a></td><td> }
</td></tr><tr id="38" class="source-line"><td><a class="source-lineNum" href="#38"> 38: </a></td><td> }
</td></tr><tr id="39" class="source-line"><td><a class="source-lineNum" href="#39"> 39: </a></td><td>
</td></tr><tr id="40" class="source-line"><td><a class="source-lineNum" href="#40"> 40: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="41" class="source-line"><td><a class="source-lineNum" href="#41"> 41: </a></td><td><span class="php-comment"> * setTo
</span></td></tr><tr id="42" class="source-line"><td><a class="source-lineNum" href="#42"> 42: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="43" class="source-line"><td><a class="source-lineNum" href="#43"> 43: </a></td><td><span class="php-comment"> * @param array&lt;string&gt;|string $to
</span></td></tr><tr id="44" class="source-line"><td><a class="source-lineNum" href="#44"> 44: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="45" class="source-line"><td><a class="source-lineNum" href="#45"> 45: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="46" class="source-line"><td><a class="source-lineNum" href="#46"> 46: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="47" class="source-line"><td><a class="source-lineNum" href="#47"> 47: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setTo(<span class="php-var">$to</span>): void {
</td></tr><tr id="48" class="source-line"><td><a class="source-lineNum" href="#48"> 48: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;to&#039;</span>] = <span class="php-var">$to</span>;
</td></tr><tr id="49" class="source-line"><td><a class="source-lineNum" href="#49"> 49: </a></td><td> }
</td></tr><tr id="50" class="source-line"><td><a class="source-lineNum" href="#50"> 50: </a></td><td>
</td></tr><tr id="51" class="source-line"><td><a class="source-lineNum" href="#51"> 51: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="52" class="source-line"><td><a class="source-lineNum" href="#52"> 52: </a></td><td><span class="php-comment"> * setFrom
</span></td></tr><tr id="53" class="source-line"><td><a class="source-lineNum" href="#53"> 53: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="54" class="source-line"><td><a class="source-lineNum" href="#54"> 54: </a></td><td><span class="php-comment"> * @param string $from
</span></td></tr><tr id="55" class="source-line"><td><a class="source-lineNum" href="#55"> 55: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="56" class="source-line"><td><a class="source-lineNum" href="#56"> 56: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="57" class="source-line"><td><a class="source-lineNum" href="#57"> 57: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="58" class="source-line"><td><a class="source-lineNum" href="#58"> 58: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setFrom(string <span class="php-var">$from</span>): void {
</td></tr><tr id="59" class="source-line"><td><a class="source-lineNum" href="#59"> 59: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;from&#039;</span>] = <span class="php-var">$from</span>;
</td></tr><tr id="60" class="source-line"><td><a class="source-lineNum" href="#60"> 60: </a></td><td> }
</td></tr><tr id="61" class="source-line"><td><a class="source-lineNum" href="#61"> 61: </a></td><td>
</td></tr><tr id="62" class="source-line"><td><a class="source-lineNum" href="#62"> 62: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="63" class="source-line"><td><a class="source-lineNum" href="#63"> 63: </a></td><td><span class="php-comment"> * setSender
</span></td></tr><tr id="64" class="source-line"><td><a class="source-lineNum" href="#64"> 64: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="65" class="source-line"><td><a class="source-lineNum" href="#65"> 65: </a></td><td><span class="php-comment"> * @param string $sender
</span></td></tr><tr id="66" class="source-line"><td><a class="source-lineNum" href="#66"> 66: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="67" class="source-line"><td><a class="source-lineNum" href="#67"> 67: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="68" class="source-line"><td><a class="source-lineNum" href="#68"> 68: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="69" class="source-line"><td><a class="source-lineNum" href="#69"> 69: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setSender(string <span class="php-var">$sender</span>): void {
</td></tr><tr id="70" class="source-line"><td><a class="source-lineNum" href="#70"> 70: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;sender&#039;</span>] = <span class="php-var">$sender</span>;
</td></tr><tr id="71" class="source-line"><td><a class="source-lineNum" href="#71"> 71: </a></td><td> }
</td></tr><tr id="72" class="source-line"><td><a class="source-lineNum" href="#72"> 72: </a></td><td>
</td></tr><tr id="73" class="source-line"><td><a class="source-lineNum" href="#73"> 73: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="74" class="source-line"><td><a class="source-lineNum" href="#74"> 74: </a></td><td><span class="php-comment"> * setReplyTo
</span></td></tr><tr id="75" class="source-line"><td><a class="source-lineNum" href="#75"> 75: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="76" class="source-line"><td><a class="source-lineNum" href="#76"> 76: </a></td><td><span class="php-comment"> * @param string $reply_to
</span></td></tr><tr id="77" class="source-line"><td><a class="source-lineNum" href="#77"> 77: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="78" class="source-line"><td><a class="source-lineNum" href="#78"> 78: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="79" class="source-line"><td><a class="source-lineNum" href="#79"> 79: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="80" class="source-line"><td><a class="source-lineNum" href="#80"> 80: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setReplyTo(string <span class="php-var">$reply_to</span>): void {
</td></tr><tr id="81" class="source-line"><td><a class="source-lineNum" href="#81"> 81: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;reply_to&#039;</span>] = <span class="php-var">$reply_to</span>;
</td></tr><tr id="82" class="source-line"><td><a class="source-lineNum" href="#82"> 82: </a></td><td> }
</td></tr><tr id="83" class="source-line"><td><a class="source-lineNum" href="#83"> 83: </a></td><td>
</td></tr><tr id="84" class="source-line"><td><a class="source-lineNum" href="#84"> 84: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="85" class="source-line"><td><a class="source-lineNum" href="#85"> 85: </a></td><td><span class="php-comment"> * setSubject
</span></td></tr><tr id="86" class="source-line"><td><a class="source-lineNum" href="#86"> 86: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="87" class="source-line"><td><a class="source-lineNum" href="#87"> 87: </a></td><td><span class="php-comment"> * @param string $subject
</span></td></tr><tr id="88" class="source-line"><td><a class="source-lineNum" href="#88"> 88: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="89" class="source-line"><td><a class="source-lineNum" href="#89"> 89: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="90" class="source-line"><td><a class="source-lineNum" href="#90"> 90: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="91" class="source-line"><td><a class="source-lineNum" href="#91"> 91: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setSubject(string <span class="php-var">$subject</span>): void {
</td></tr><tr id="92" class="source-line"><td><a class="source-lineNum" href="#92"> 92: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;subject&#039;</span>] = <span class="php-var">$subject</span>;
</td></tr><tr id="93" class="source-line"><td><a class="source-lineNum" href="#93"> 93: </a></td><td> }
</td></tr><tr id="94" class="source-line"><td><a class="source-lineNum" href="#94"> 94: </a></td><td>
</td></tr><tr id="95" class="source-line"><td><a class="source-lineNum" href="#95"> 95: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="96" class="source-line"><td><a class="source-lineNum" href="#96"> 96: </a></td><td><span class="php-comment"> * setText
</span></td></tr><tr id="97" class="source-line"><td><a class="source-lineNum" href="#97"> 97: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="98" class="source-line"><td><a class="source-lineNum" href="#98"> 98: </a></td><td><span class="php-comment"> * @param string $text
</span></td></tr><tr id="99" class="source-line"><td><a class="source-lineNum" href="#99"> 99: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="100" class="source-line"><td><a class="source-lineNum" href="#100">100: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="101" class="source-line"><td><a class="source-lineNum" href="#101">101: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="102" class="source-line"><td><a class="source-lineNum" href="#102">102: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setText(string <span class="php-var">$text</span>): void {
</td></tr><tr id="103" class="source-line"><td><a class="source-lineNum" href="#103">103: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;text&#039;</span>] = <span class="php-var">$text</span>;
</td></tr><tr id="104" class="source-line"><td><a class="source-lineNum" href="#104">104: </a></td><td> }
</td></tr><tr id="105" class="source-line"><td><a class="source-lineNum" href="#105">105: </a></td><td>
</td></tr><tr id="106" class="source-line"><td><a class="source-lineNum" href="#106">106: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="107" class="source-line"><td><a class="source-lineNum" href="#107">107: </a></td><td><span class="php-comment"> * setHtml
</span></td></tr><tr id="108" class="source-line"><td><a class="source-lineNum" href="#108">108: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="109" class="source-line"><td><a class="source-lineNum" href="#109">109: </a></td><td><span class="php-comment"> * @param string $html
</span></td></tr><tr id="110" class="source-line"><td><a class="source-lineNum" href="#110">110: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="111" class="source-line"><td><a class="source-lineNum" href="#111">111: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="112" class="source-line"><td><a class="source-lineNum" href="#112">112: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="113" class="source-line"><td><a class="source-lineNum" href="#113">113: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> setHtml(string <span class="php-var">$html</span>): void {
</td></tr><tr id="114" class="source-line"><td><a class="source-lineNum" href="#114">114: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;html&#039;</span>] = <span class="php-var">$html</span>;
</td></tr><tr id="115" class="source-line"><td><a class="source-lineNum" href="#115">115: </a></td><td> }
</td></tr><tr id="116" class="source-line"><td><a class="source-lineNum" href="#116">116: </a></td><td>
</td></tr><tr id="117" class="source-line"><td><a class="source-lineNum" href="#117">117: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="118" class="source-line"><td><a class="source-lineNum" href="#118">118: </a></td><td><span class="php-comment"> * addAttachment
</span></td></tr><tr id="119" class="source-line"><td><a class="source-lineNum" href="#119">119: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="120" class="source-line"><td><a class="source-lineNum" href="#120">120: </a></td><td><span class="php-comment"> * @param string $filename
</span></td></tr><tr id="121" class="source-line"><td><a class="source-lineNum" href="#121">121: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="122" class="source-line"><td><a class="source-lineNum" href="#122">122: </a></td><td><span class="php-comment"> * @return void
</span></td></tr><tr id="123" class="source-line"><td><a class="source-lineNum" href="#123">123: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="124" class="source-line"><td><a class="source-lineNum" href="#124">124: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> addAttachment(string <span class="php-var">$filename</span>): void {
</td></tr><tr id="125" class="source-line"><td><a class="source-lineNum" href="#125">125: </a></td><td> <span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;attachments&#039;</span>][] = <span class="php-var">$filename</span>;
</td></tr><tr id="126" class="source-line"><td><a class="source-lineNum" href="#126">126: </a></td><td> }
</td></tr><tr id="127" class="source-line"><td><a class="source-lineNum" href="#127">127: </a></td><td>
</td></tr><tr id="128" class="source-line"><td><a class="source-lineNum" href="#128">128: </a></td><td> <span class="php-comment">/**
</span></td></tr><tr id="129" class="source-line"><td><a class="source-lineNum" href="#129">129: </a></td><td><span class="php-comment"> * Send
</span></td></tr><tr id="130" class="source-line"><td><a class="source-lineNum" href="#130">130: </a></td><td><span class="php-comment"> *
</span></td></tr><tr id="131" class="source-line"><td><a class="source-lineNum" href="#131">131: </a></td><td><span class="php-comment"> * @return bool
</span></td></tr><tr id="132" class="source-line"><td><a class="source-lineNum" href="#132">132: </a></td><td><span class="php-comment"> */</span>
</td></tr><tr id="133" class="source-line"><td><a class="source-lineNum" href="#133">133: </a></td><td> <span class="php-kw">public</span> <span class="php-kw">function</span> send(): bool {
</td></tr><tr id="134" class="source-line"><td><a class="source-lineNum" href="#134">134: </a></td><td> <span class="php-kw">if</span> (<span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;to&#039;</span>])) {
</td></tr><tr id="135" class="source-line"><td><a class="source-lineNum" href="#135">135: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: E-Mail to required!&#039;</span>);
</td></tr><tr id="136" class="source-line"><td><a class="source-lineNum" href="#136">136: </a></td><td> }
</td></tr><tr id="137" class="source-line"><td><a class="source-lineNum" href="#137">137: </a></td><td>
</td></tr><tr id="138" class="source-line"><td><a class="source-lineNum" href="#138">138: </a></td><td> <span class="php-kw">if</span> (<span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;from&#039;</span>])) {
</td></tr><tr id="139" class="source-line"><td><a class="source-lineNum" href="#139">139: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: E-Mail from required!&#039;</span>);
</td></tr><tr id="140" class="source-line"><td><a class="source-lineNum" href="#140">140: </a></td><td> }
</td></tr><tr id="141" class="source-line"><td><a class="source-lineNum" href="#141">141: </a></td><td>
</td></tr><tr id="142" class="source-line"><td><a class="source-lineNum" href="#142">142: </a></td><td> <span class="php-kw">if</span> (<span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;sender&#039;</span>])) {
</td></tr><tr id="143" class="source-line"><td><a class="source-lineNum" href="#143">143: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: E-Mail sender required!&#039;</span>);
</td></tr><tr id="144" class="source-line"><td><a class="source-lineNum" href="#144">144: </a></td><td> }
</td></tr><tr id="145" class="source-line"><td><a class="source-lineNum" href="#145">145: </a></td><td>
</td></tr><tr id="146" class="source-line"><td><a class="source-lineNum" href="#146">146: </a></td><td> <span class="php-kw">if</span> (<span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;subject&#039;</span>])) {
</td></tr><tr id="147" class="source-line"><td><a class="source-lineNum" href="#147">147: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: E-Mail subject required!&#039;</span>);
</td></tr><tr id="148" class="source-line"><td><a class="source-lineNum" href="#148">148: </a></td><td> }
</td></tr><tr id="149" class="source-line"><td><a class="source-lineNum" href="#149">149: </a></td><td>
</td></tr><tr id="150" class="source-line"><td><a class="source-lineNum" href="#150">150: </a></td><td> <span class="php-kw">if</span> (<span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;text&#039;</span>]) &amp;&amp; <span class="php-kw">empty</span>(<span class="php-var">$this</span>-&gt;option[<span class="php-str">&#039;html&#039;</span>])) {
</td></tr><tr id="151" class="source-line"><td><a class="source-lineNum" href="#151">151: </a></td><td> <span class="php-kw">throw</span> <span class="php-kw">new</span> \Exception(<span class="php-str">&#039;Error: E-Mail message required!&#039;</span>);
</td></tr><tr id="152" class="source-line"><td><a class="source-lineNum" href="#152">152: </a></td><td> }
</td></tr><tr id="153" class="source-line"><td><a class="source-lineNum" href="#153">153: </a></td><td>
</td></tr><tr id="154" class="source-line"><td><a class="source-lineNum" href="#154">154: </a></td><td> <span class="php-kw">return</span> <span class="php-var">$this</span>-&gt;adaptor-&gt;send();
</td></tr><tr id="155" class="source-line"><td><a class="source-lineNum" href="#155">155: </a></td><td> }
</td></tr><tr id="156" class="source-line"><td><a class="source-lineNum" href="#156">156: </a></td><td>}
</td></tr><tr id="157" class="source-line"><td><a class="source-lineNum" href="#157">157: </a></td><td></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>