oxemail.php

Go to the documentation of this file.

<?php
require oxRegistry::getConfig()->getConfigParam('sCoreDir') . "/phpmailer/class.phpmailer.php";
require oxRegistry::getConfig()->getConfigParam('sCoreDir') . "/phpmailer/class.smtp.php";


class oxEmail extends PHPMailer
{

    public $SMTP_PORT = 25;

    protected $_sForgotPwdTemplate = "email/html/forgotpwd.tpl";

    protected $_sForgotPwdTemplatePlain = "email/plain/forgotpwd.tpl";

    protected $_sNewsletterOptInTemplate = "email/html/newsletteroptin.tpl";

    protected $_sNewsletterOptInTemplatePlain = "email/plain/newsletteroptin.tpl";

    protected $_sSuggestTemplate = "email/html/suggest.tpl";

    protected $_sSuggestTemplatePlain = "email/plain/suggest.tpl";

    protected $_sInviteTemplate = "email/html/invite.tpl";

    protected $_sInviteTemplatePlain = "email/plain/invite.tpl";

    protected $_sSenedNowTemplate = "email/html/ordershipped.tpl";

    protected $_sSenedNowTemplatePlain = "email/plain/ordershipped.tpl";

    protected $_sSendDownloadsTemplate = "email/html/senddownloadlinks.tpl";

    protected $_sSendDownloadsTemplatePlain = "email/plain/senddownloadlinks.tpl";

    protected $_sWishListTemplate = "email/html/wishlist.tpl";

    protected $_sWishListTemplatePlain = "email/plain/wishlist.tpl";

    protected $_sRegisterTemplate = "email/html/register.tpl";

    protected $_sRegisterTemplatePlain = "email/plain/register.tpl";

    protected $_sReminderMailTemplate = "email/html/owner_reminder.tpl";

    protected $_sOrderUserTemplate = "email/html/order_cust.tpl";

    protected $_sOrderUserPlainTemplate = "email/plain/order_cust.tpl";

    protected $_sOrderOwnerTemplate = "email/html/order_owner.tpl";

    protected $_sOrderOwnerPlainTemplate = "email/plain/order_owner.tpl";

    // #586A - additional templates for more customizable subjects

    protected $_sOrderUserSubjectTemplate = "email/html/order_cust_subj.tpl";

    protected $_sOrderOwnerSubjectTemplate = "email/html/order_owner_subj.tpl";

    protected $_sOwnerPricealarmTemplate = "email/html/pricealarm_owner.tpl";

    protected $_sPricealamrCustomerTemplate = "email_pricealarm_customer.tpl";

    protected $_aShops = array();

    protected $_blInlineImgEmail = null;

    protected $_aRecipients = array();

    protected $_aReplies = array();

    protected $_aAttachments = array();

    protected $_oSmarty = null;

    protected $_aViewData = array();

    protected $_oShop = null;

    protected $_sCharSet = null;

    public function __construct()
    {
        //enabling exception handling in phpmailer class
        parent::__construct(true);

        $myConfig = $this->getConfig();

        $this->_setMailerPluginDir();
        $this->setSmtp();

        $this->setUseInlineImages($myConfig->getConfigParam('blInlineImgEmail'));
        $this->setMailWordWrap(100);

        $this->isHtml(true);
        $this->setLanguage("en", $myConfig->getConfigParam('sShopDir') . "/core/phpmailer/language/");

        $this->_getSmarty();
    }

    public function __call($sMethod, $aArgs)
    {
        if (defined('OXID_PHP_UNIT')) {
            if (substr($sMethod, 0, 4) == "UNIT") {
                $sMethod = str_replace("UNIT", "_", $sMethod);
            }
            if (method_exists($this, $sMethod)) {
                return call_user_func_array(array(& $this, $sMethod), $aArgs);
            }
        }

        throw new oxSystemComponentException("Function '$sMethod' does not exist or is not accessible! (" . get_class($this) . ")" . PHP_EOL);
    }

    public function getConfig()
    {
        if ($this->_oConfig == null) {
            $this->_oConfig = oxRegistry::getConfig();
        }

        return $this->_oConfig;
    }

    public function setConfig($oConfig)
    {
        $this->_oConfig = $oConfig;
    }


    protected function _getSmarty()
    {
        if ($this->_oSmarty === null) {
            $this->_oSmarty = oxRegistry::get("oxUtilsView")->getSmarty();
        }

        //setting default view
        $this->_oSmarty->assign("oEmailView", $this);

        return $this->_oSmarty;
    }

    public function send()
    {
        // if no recipients found, skipping sending
        if (count($this->getRecipient()) < 1) {
            return false;
        }

        $myConfig = $this->getConfig();
        $this->setCharSet();

        if ($this->_getUseInlineImages()) {
            $this->_includeImages(
                $myConfig->getImageDir(), $myConfig->getImageUrl(false, false), $myConfig->getPictureUrl(null, false),
                $myConfig->getImageDir(), $myConfig->getPictureDir(false)
            );
        }

        $this->_makeOutputProcessing();

        // try to send mail via SMTP
        if ($this->getMailer() == 'smtp') {
            $blRet = $this->_sendMail();

            // if sending failed, try to send via mail()
            if (!$blRet) {
                // failed sending via SMTP, sending notification to shop owner
                $this->_sendMailErrorMsg();

                // trying to send using standard mailer
                $this->setMailer('mail');
                $blRet = $this->_sendMail();
            }
        } else {
            // sending mail via mail()
            $this->setMailer('mail');
            $blRet = $this->_sendMail();
        }

        if (!$blRet) {
            // failed sending, giving up, trying to send notification to shop owner
            $this->_sendMailErrorMsg();
        }

        return $blRet;
    }

    protected function _setSmtpProtocol($sUrl)
    {
        $sProtocol = '';
        $sSmtpHost = $sUrl;
        $aMatch = array();
        if (getStr()->preg_match('@^([0-9a-z]+://)?(.*)$@i', $sUrl, $aMatch)) {
            if ($aMatch[1]) {
                if (($aMatch[1] == 'ssl://') || ($aMatch[1] == 'tls://')) {
                    $this->set("SMTPSecure", substr($aMatch[1], 0, 3));
                } else {
                    $sProtocol = $aMatch[1];
                }
            }
            $sSmtpHost = $aMatch[2];
        }

        return $sProtocol . $sSmtpHost;
    }

    public function setSmtp($oShop = null)
    {
        $myConfig = $this->getConfig();
        $oShop = ($oShop) ? $oShop : $this->_getShop();

        $sSmtpUrl = $this->_setSmtpProtocol($oShop->oxshops__oxsmtp->value);

        if (!$this->_isValidSmtpHost($sSmtpUrl)) {
            $this->setMailer("mail");

            return;
        }

        $this->setHost($sSmtpUrl);
        $this->setMailer("smtp");

        if ($oShop->oxshops__oxsmtpuser->value) {
            $this->_setSmtpAuthInfo($oShop->oxshops__oxsmtpuser->value, $oShop->oxshops__oxsmtppwd->value);
        }

        if ($myConfig->getConfigParam('iDebug') == 6) {
            $this->_setSmtpDebug(true);
        }
    }

    protected function _isValidSmtpHost($sSmtpHost)
    {
        $blIsSmtp = false;
        if ($sSmtpHost) {
            $sSmtpPort = $this->SMTP_PORT;
            $aMatch = array();
            if (getStr()->preg_match('@^(.*?)(:([0-9]+))?$@i', $sSmtpHost, $aMatch)) {
                $sSmtpHost = $aMatch[1];
                $sSmtpPort = (int) $aMatch[3];
                if (!$sSmtpPort) {
                    $sSmtpPort = $this->SMTP_PORT;
                }
            }
            if ($blIsSmtp = (bool) ($rHandle = @fsockopen($sSmtpHost, $sSmtpPort, $iErrNo, $sErrStr, 30))) {
                // closing connection ..
                fclose($rHandle);
            }
        }

        return $blIsSmtp;
    }

    public function sendOrderEmailToUser($oOrder, $sSubject = null)
    {
        $myConfig = $this->getConfig();

        // add user defined stuff if there is any
        $oOrder = $this->_addUserInfoOrderEMail($oOrder);

        $oShop = $this->_getShop();
        $this->_setMailParams($oShop);

        $oUser = $oOrder->getOrderUser();
        $this->setUser($oUser);

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setViewData("order", $oOrder);

        if ($myConfig->getConfigParam("bl_perfLoadReviews")) {
            $this->setViewData("blShowReviewLink", true);
        }

        // Process view data array through oxOutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($this->_sOrderUserTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sOrderUserPlainTemplate));

        // #586A
        if ($sSubject === null) {
            if ($oSmarty->template_exists($this->_sOrderUserSubjectTemplate)) {
                $sSubject = $oSmarty->fetch($this->_sOrderUserSubjectTemplate);
            } else {
                $sSubject = $oShop->oxshops__oxordersubject->getRawValue() . " (#" . $oOrder->oxorder__oxordernr->value . ")";
            }
        }

        $this->setSubject($sSubject);

        $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();

        $this->setRecipient($oUser->oxuser__oxusername->value, $sFullName);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        $blSuccess = $this->send();

        return $blSuccess;
    }

    public function sendOrderEmailToOwner($oOrder, $sSubject = null)
    {
        $myConfig = $this->getConfig();

        $oShop = $this->_getShop();

        // cleanup
        $this->_clearMailer();

        // add user defined stuff if there is any
        $oOrder = $this->_addUserInfoOrderEMail($oOrder);

        $oUser = $oOrder->getOrderUser();
        $this->setUser($oUser);

        // send confirmation to shop owner
        // send not pretending from order user, as different email domain rise spam filters
        $this->setFrom($oShop->oxshops__oxowneremail->value);

        $oLang = oxRegistry::getLang();
        $iOrderLang = $oLang->getObjectTplLanguage();

        // if running shop language is different from admin lang. set in config
        // we have to load shop in config language
        if ($oShop->getLanguage() != $iOrderLang) {
            $oShop = $this->_getShop($iOrderLang);
        }

        $this->setSmtp($oShop);

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setViewData("order", $oOrder);

        // Process view data array through oxoutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($myConfig->getTemplatePath($this->_sOrderOwnerTemplate, false)));
        $this->setAltBody($oSmarty->fetch($myConfig->getTemplatePath($this->_sOrderOwnerPlainTemplate, false)));

        //Sets subject to email
        // #586A
        if ($sSubject === null) {
            if ($oSmarty->template_exists($this->_sOrderOwnerSubjectTemplate)) {
                $sSubject = $oSmarty->fetch($this->_sOrderOwnerSubjectTemplate);
            } else {
                $sSubject = $oShop->oxshops__oxordersubject->getRawValue() . " (#" . $oOrder->oxorder__oxordernr->value . ")";
            }
        }

        $this->setSubject($sSubject);
        $this->setRecipient($oShop->oxshops__oxowneremail->value, $oLang->translateString("order"));

        if ($oUser->oxuser__oxusername->value != "admin") {
            $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();
            $this->setReplyTo($oUser->oxuser__oxusername->value, $sFullName);
        }

        $blSuccess = $this->send();

        // add user history
        $oRemark = oxNew("oxremark");
        $oRemark->oxremark__oxtext = new oxField($this->getAltBody(), oxField::T_RAW);
        $oRemark->oxremark__oxparentid = new oxField($oUser->getId(), oxField::T_RAW);
        $oRemark->oxremark__oxtype = new oxField("o", oxField::T_RAW);
        $oRemark->save();


        if ($myConfig->getConfigParam('iDebug') == 6) {
            oxRegistry::getUtils()->showMessageAndExit("");
        }

        return $blSuccess;
    }

    public function sendRegisterConfirmEmail($oUser, $sSubject = null)
    {
        // setting content ident

        $this->setViewData("contentident", "oxregisteraltemail");
        $this->setViewData("contentplainident", "oxregisterplainaltemail");

        // sending email
        return $this->sendRegisterEmail($oUser, $sSubject);
    }

    public function sendRegisterEmail($oUser, $sSubject = null)
    {
        // add user defined stuff if there is any
        $oUser = $this->_addUserRegisterEmail($oUser);

        // shop info
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp )
        $this->_setMailParams($oShop);

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setUser($oUser);

        // Process view data array through oxOutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($this->_sRegisterTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sRegisterTemplatePlain));

        $this->setSubject(($sSubject !== null) ? $sSubject : $oShop->oxshops__oxregistersubject->getRawValue());

        $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();

        $this->setRecipient($oUser->oxuser__oxusername->value, $sFullName);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        return $this->send();
    }

    public function sendForgotPwdEmail($sEmailAddress, $sSubject = null)
    {
        $result = false;

        $oShop = $this->_addForgotPwdEmail($this->_getShop());

        $sOxId = $this->_getUserIdByUserName($sEmailAddress, $oShop->getId());
        $oUser = oxNew('oxuser');
        if ($sOxId && $oUser->load($sOxId)) {
            // create messages
            $oSmarty = $this->_getSmarty();
            $this->setUser($oUser);
            $this->_processViewArray();

            $this->_setMailParams($oShop);
            $this->setBody($oSmarty->fetch($this->_sForgotPwdTemplate));
            $this->setAltBody($oSmarty->fetch($this->_sForgotPwdTemplatePlain));
            $this->setSubject(($sSubject !== null) ? $sSubject : $oShop->oxshops__oxforgotpwdsubject->getRawValue());

            $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();
            $sRecipientAddress = $oUser->oxuser__oxusername->getRawValue();

            $this->setRecipient($sRecipientAddress, $sFullName);
            $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

            if (!$this->send()) {
                $result = -1; // failed to send
            } else {
                $result = true; // success
            }
        }

        return $result;
    }

    public function sendContactMail($sEmailAddress = null, $sSubject = null, $sMessage = null)
    {

        // shop info
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        $this->setBody($sMessage);
        $this->setSubject($sSubject);

        $this->setRecipient($oShop->oxshops__oxinfoemail->value, "");
        $this->setFrom($oShop->oxshops__oxowneremail->value, $oShop->oxshops__oxname->getRawValue());
        $this->setReplyTo($sEmailAddress, "");

        return $this->send();
    }

    public function sendNewsletterDbOptInMail($oUser, $sSubject = null)
    {
        $oLang = oxRegistry::getLang();

        // add user defined stuff if there is any
        $oUser = $this->_addNewsletterDbOptInMail($oUser);

        // shop info
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        // create messages
        $oSmarty = $this->_getSmarty();
        $sConfirmCode = md5($oUser->oxuser__oxusername->value . $oUser->oxuser__oxpasssalt->value);
        $this->setViewData("subscribeLink", $this->_getNewsSubsLink($oUser->oxuser__oxid->value, $sConfirmCode));
        $this->setUser($oUser);

        // Process view data array through oxOutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($this->_sNewsletterOptInTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sNewsletterOptInTemplatePlain));
        $this->setSubject(($sSubject !== null) ? $sSubject : oxRegistry::getLang()->translateString("NEWSLETTER") . " " . $oShop->oxshops__oxname->getRawValue());

        $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();

        $this->setRecipient($oUser->oxuser__oxusername->value, $sFullName);
        $this->setFrom($oShop->oxshops__oxinfoemail->value, $oShop->oxshops__oxname->getRawValue());
        $this->setReplyTo($oShop->oxshops__oxinfoemail->value, $oShop->oxshops__oxname->getRawValue());

        return $this->send();
    }

    protected function _getNewsSubsLink($sId, $sConfirmCode = null)
    {
        $myConfig = $this->getConfig();
        $iActShopLang = $myConfig->getActiveShop()->getLanguage();

        $sUrl = $myConfig->getShopHomeURL() . 'cl=newsletter&amp;fnc=addme&amp;uid=' . $sId;
        $sUrl .= '&amp;lang=' . $iActShopLang;
        $sUrl .= ($sConfirmCode) ? '&amp;confirm=' . $sConfirmCode : "";

        return $sUrl;
    }

    public function sendNewsletterMail($oNewsLetter, $oUser, $sSubject = null)
    {
        // shop info
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        $sBody = $oNewsLetter->getHtmlText();

        if (!empty($sBody)) {
            $this->setBody($sBody);
            $this->setAltBody($oNewsLetter->getPlainText());
        } else {
            $this->isHtml(false);
            $this->setBody($oNewsLetter->getPlainText());
        }

        $this->setSubject(($sSubject !== null) ? $sSubject : $oNewsLetter->oxnewsletter__oxtitle->getRawValue());

        $sFullName = $oUser->oxuser__oxfname->getRawValue() . " " . $oUser->oxuser__oxlname->getRawValue();
        $this->setRecipient($oUser->oxuser__oxusername->value, $sFullName);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        return $this->send();
    }


    public function sendSuggestMail($oParams, $oProduct)
    {
        $myConfig = $this->getConfig();

        //sets language of shop
        $iCurrLang = $myConfig->getActiveShop()->getLanguage();

        // shop info
        $oShop = $this->_getShop($iCurrLang);

        //sets language to article
        if ($oProduct->getLanguage() != $iCurrLang) {
            $oProduct->setLanguage($iCurrLang);
            $oProduct->load($oProduct->getId());
        }

        // mailer stuff
        // send not pretending from suggesting user, as different email domain rise spam filters
        $this->setFrom($oShop->oxshops__oxinfoemail->value);
        $this->setSMTP();

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setViewData("product", $oProduct);
        $this->setUser($oParams);

        $sArticleUrl = $oProduct->getLink();

        //setting recommended user id
        if ($myConfig->getActiveView()->isActive('Invitations') && $oActiveUser = $oShop->getUser()) {
            $sArticleUrl = oxRegistry::get("oxUtilsUrl")->appendParamSeparator($sArticleUrl);
            $sArticleUrl .= "su=" . $oActiveUser->getId();
        }

        $this->setViewData("sArticleUrl", $sArticleUrl);

        // Process view data array through oxOutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($this->_sSuggestTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sSuggestTemplatePlain));
        $this->setSubject($oParams->send_subject);

        $this->setRecipient($oParams->rec_email, $oParams->rec_name);
        $this->setReplyTo($oParams->send_email, $oParams->send_name);

        return $this->send();
    }

    public function sendInviteMail($oParams)
    {
        $myConfig = $this->getConfig();

        //sets language of shop
        $iCurrLang = $myConfig->getActiveShop()->getLanguage();

        // shop info
        $oShop = $this->_getShop($iCurrLang);

        // mailer stuff
        $this->setFrom($oParams->send_email, $oParams->send_name);
        $this->setSMTP();

        // create messages
        $oSmarty = oxRegistry::get("oxUtilsView")->getSmarty();
        $this->setUser($oParams);

        $sHomeUrl = $this->getViewConfig()->getHomeLink();

        //setting recommended user id
        if ($myConfig->getActiveView()->isActive('Invitations') && $oActiveUser = $oShop->getUser()) {
            $sHomeUrl = oxRegistry::get("oxUtilsUrl")->appendParamSeparator($sHomeUrl);
            $sHomeUrl .= "su=" . $oActiveUser->getId();
        }

        if (is_array($oParams->rec_email) && count($oParams->rec_email) > 0) {
            foreach ($oParams->rec_email as $sEmail) {
                if (!empty($sEmail)) {
                    $sRegisterUrl = oxRegistry::get("oxUtilsUrl")->appendParamSeparator($sHomeUrl);
                    //setting recipient user email
                    $sRegisterUrl .= "re=" . md5($sEmail);
                    $this->setViewData("sHomeUrl", $sRegisterUrl);

                    // Process view data array through oxoutput processor
                    $this->_processViewArray();

                    $this->setBody($oSmarty->fetch($this->_sInviteTemplate));

                    $this->setAltBody($oSmarty->fetch($this->_sInviteTemplatePlain));
                    $this->setSubject($oParams->send_subject);

                    $this->setRecipient($sEmail);
                    $this->setReplyTo($oParams->send_email, $oParams->send_name);
                    $this->send();
                    $this->clearAllRecipients();
                }
            }

            return true;
        }

        return false;
    }

    public function sendSendedNowMail($oOrder, $sSubject = null)
    {
        $myConfig = $this->getConfig();

        $iOrderLang = (int) (isset($oOrder->oxorder__oxlang->value) ? $oOrder->oxorder__oxlang->value : 0);

        // shop info
        $oShop = $this->_getShop($iOrderLang);

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        //create messages
        $oLang = oxRegistry::getLang();
        $oSmarty = $this->_getSmarty();
        $this->setViewData("order", $oOrder);
        $this->setViewData("shopTemplateDir", $myConfig->getTemplateDir(false));

        if ($myConfig->getConfigParam("bl_perfLoadReviews")) {
            $this->setViewData("blShowReviewLink", true);
            $oUser = oxNew('oxuser');
            $this->setViewData("reviewuserhash", $oUser->getReviewUserHash($oOrder->oxorder__oxuserid->value));
        }

        // Process view data array through oxoutput processor
        $this->_processViewArray();

        // #1469 - we need to patch security here as we do not use standard template dir, so smarty stops working
        $aStore['INCLUDE_ANY'] = $oSmarty->security_settings['INCLUDE_ANY'];
        //V send email in order language
        $iOldTplLang = $oLang->getTplLanguage();
        $iOldBaseLang = $oLang->getTplLanguage();
        $oLang->setTplLanguage($iOrderLang);
        $oLang->setBaseLanguage($iOrderLang);

        $oSmarty->security_settings['INCLUDE_ANY'] = true;
        // force non admin to get correct paths (tpl, img)
        $myConfig->setAdminMode(false);
        $this->setBody($oSmarty->fetch($this->_sSenedNowTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sSenedNowTemplatePlain));
        $myConfig->setAdminMode(true);
        $oLang->setTplLanguage($iOldTplLang);
        $oLang->setBaseLanguage($iOldBaseLang);
        // set it back
        $oSmarty->security_settings['INCLUDE_ANY'] = $aStore['INCLUDE_ANY'];

        //Sets subject to email
        $this->setSubject(($sSubject !== null) ? $sSubject : $oShop->oxshops__oxsendednowsubject->getRawValue());

        $sFullName = $oOrder->oxorder__oxbillfname->getRawValue() . " " . $oOrder->oxorder__oxbilllname->getRawValue();

        $this->setRecipient($oOrder->oxorder__oxbillemail->value, $sFullName);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        return $this->send();
    }

    public function sendDownloadLinksMail($oOrder, $sSubject = null)
    {
        $myConfig = $this->getConfig();

        $iOrderLang = (int) (isset($oOrder->oxorder__oxlang->value) ? $oOrder->oxorder__oxlang->value : 0);

        // shop info
        $oShop = $this->_getShop($iOrderLang);

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        //create messages
        $oLang = oxRegistry::getLang();
        $oSmarty = $this->_getSmarty();
        $this->setViewData("order", $oOrder);
        $this->setViewData("shopTemplateDir", $myConfig->getTemplateDir(false));

        $oUser = oxNew('oxuser');
        $this->setViewData("reviewuserhash", $oUser->getReviewUserHash($oOrder->oxorder__oxuserid->value));

        // Process view data array through oxoutput processor
        $this->_processViewArray();

        // #1469 - we need to patch security here as we do not use standard template dir, so smarty stops working
        $aStore['INCLUDE_ANY'] = $oSmarty->security_settings['INCLUDE_ANY'];
        //V send email in order language
        $iOldTplLang = $oLang->getTplLanguage();
        $iOldBaseLang = $oLang->getTplLanguage();
        $oLang->setTplLanguage($iOrderLang);
        $oLang->setBaseLanguage($iOrderLang);

        $oSmarty->security_settings['INCLUDE_ANY'] = true;
        // force non admin to get correct paths (tpl, img)
        $myConfig->setAdminMode(false);
        $this->setBody($oSmarty->fetch($this->_sSendDownloadsTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sSendDownloadsTemplatePlain));
        $myConfig->setAdminMode(true);
        $oLang->setTplLanguage($iOldTplLang);
        $oLang->setBaseLanguage($iOldBaseLang);
        // set it back
        $oSmarty->security_settings['INCLUDE_ANY'] = $aStore['INCLUDE_ANY'];

        //Sets subject to email
        $this->setSubject(($sSubject !== null) ? $sSubject : $oLang->translateString("DOWNLOAD_LINKS", null, false));

        $sFullName = $oOrder->oxorder__oxbillfname->getRawValue() . " " . $oOrder->oxorder__oxbilllname->getRawValue();

        $this->setRecipient($oOrder->oxorder__oxbillemail->value, $sFullName);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        return $this->send();
    }

    public function sendBackupMail($aAttFiles, $sAttPath, $sEmailAddress, $sSubject, $sMessage, &$aStatus, &$aError)
    {
        // shop info
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        $this->setBody($sMessage);
        $this->setSubject($sSubject);

        $this->setRecipient($oShop->oxshops__oxinfoemail->value, "");
        $sEmailAddress = $sEmailAddress ? $sEmailAddress : $oShop->oxshops__oxowneremail->value;

        $this->setFrom($sEmailAddress, "");
        $this->setReplyTo($sEmailAddress, "");

        //attaching files
        $blAttashSucc = true;
        $sAttPath = oxRegistry::get("oxUtilsFile")->normalizeDir($sAttPath);
        foreach ($aAttFiles as $iNum => $sAttFile) {
            $sFullPath = $sAttPath . $sAttFile;
            if (@is_readable($sFullPath) && @is_file($sFullPath)) {
                $blAttashSucc = $this->addAttachment($sFullPath, $sAttFile);
            } else {
                $blAttashSucc = false;
                $aError[] = array(5, $sAttFile); //"Error: backup file $sAttFile not found";
            }
        }

        if (!$blAttashSucc) {
            $aError[] = array(4, ""); //"Error: backup files was not sent to email ...";
            $this->clearAttachments();

            return false;
        }

        $aStatus[] = 3; //"Mailing backup files ...";
        $blSend = $this->send();
        $this->clearAttachments();

        return $blSend;
    }

    public function sendEmail($sTo, $sSubject, $sBody)
    {
        //set mail params (from, fromName, smtp)
        $this->_setMailParams();

        if (is_array($sTo)) {
            foreach ($sTo as $sAddress) {
                $this->setRecipient($sAddress, "");
                $this->setReplyTo($sAddress, "");
            }
        } else {
            $this->setRecipient($sTo, "");
            $this->setReplyTo($sTo, "");
        }

        //may be changed later
        $this->isHtml(false);

        $this->setSubject($sSubject);
        $this->setBody($sBody);

        return $this->send();
    }

    public function sendStockReminder($aBasketContents, $sSubject = null)
    {
        $blSend = false;

        $oArticleList = oxNew("oxarticlelist");
        $oArticleList->loadStockRemindProducts($aBasketContents);

        // nothing to remind?
        if ($oArticleList->count()) {
            $oShop = $this->_getShop();

            //set mail params (from, fromName, smtp... )
            $this->_setMailParams($oShop);
            $oLang = oxRegistry::getLang();

            $oSmarty = $this->_getSmarty();
            $this->setViewData("articles", $oArticleList);

            // Process view data array through oxOutput processor
            $this->_processViewArray();

            $this->setRecipient($oShop->oxshops__oxowneremail->value, $oShop->oxshops__oxname->getRawValue());
            $this->setFrom($oShop->oxshops__oxowneremail->value, $oShop->oxshops__oxname->getRawValue());
            $this->setBody($oSmarty->fetch($this->getConfig()->getTemplatePath($this->_sReminderMailTemplate, false)));
            $this->setAltBody("");
            $this->setSubject(($sSubject !== null) ? $sSubject : $oLang->translateString('STOCK_LOW'));

            $blSend = $this->send();
        }

        return $blSend;
    }

    public function sendWishlistMail($oParams)
    {
        $myConfig = $this->getConfig();

        $this->_clearMailer();

        // shop info
        $oShop = $this->_getShop();

        // mailer stuff
        $this->setFrom($oParams->send_email, $oParams->send_name);
        $this->setSMTP();

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setUser($oParams);

        // Process view data array through oxoutput processor
        $this->_processViewArray();

        $this->setBody($oSmarty->fetch($this->_sWishListTemplate));
        $this->setAltBody($oSmarty->fetch($this->_sWishListTemplatePlain));
        $this->setSubject($oParams->send_subject);

        $this->setRecipient($oParams->rec_email, $oParams->rec_name);
        $this->setReplyTo($oParams->send_email, $oParams->send_name);

        return $this->send();
    }

    public function sendPriceAlarmNotification($aParams, $oAlarm, $sSubject = null)
    {
        $this->_clearMailer();
        $oShop = $this->_getShop();

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        $iAlarmLang = $oAlarm->oxpricealarm__oxlang->value;

        $oArticle = oxNew("oxarticle");
        //$oArticle->setSkipAbPrice( true );
        $oArticle->loadInLang($iAlarmLang, $aParams['aid']);
        $oLang = oxRegistry::getLang();

        // create messages
        $oSmarty = $this->_getSmarty();
        $this->setViewData("product", $oArticle);
        $this->setViewData("email", $aParams['email']);
        $this->setViewData("bidprice", $oLang->formatCurrency($oAlarm->oxpricealarm__oxprice->value, $oCur));

        // Process view data array through oxOutput processor
        $this->_processViewArray();

        $this->setRecipient($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());
        $this->setSubject(($sSubject !== null) ? $sSubject : $oLang->translateString('PRICE_ALERT_FOR_PRODUCT', $iAlarmLang) . " " . $oArticle->oxarticles__oxtitle->getRawValue());
        $this->setBody($oSmarty->fetch($this->_sOwnerPricealarmTemplate));
        $this->setFrom($aParams['email'], "");
        $this->setReplyTo($aParams['email'], "");

        return $this->send();
    }

    public function sendPricealarmToCustomer($sRecipient, $oAlarm, $sBody = null, $sReturnMailBody = null)
    {
        $this->_clearMailer();

        $oShop = $this->_getShop();

        if ($oShop->getId() != $oAlarm->oxpricealarm__oxshopid->value) {
            $oShop = oxNew("oxshop");
            $oShop->load($oAlarm->oxpricealarm__oxshopid->value);
            $this->setShop($oShop);
        }

        //set mail params (from, fromName, smtp)
        $this->_setMailParams($oShop);

        // create messages
        $oSmarty = $this->_getSmarty();

        $this->setViewData("product", $oAlarm->getArticle());
        $this->setViewData("oPriceAlarm", $oAlarm);
        $this->setViewData("bidprice", $oAlarm->getFProposedPrice());
        $this->setViewData("currency", $oAlarm->getPriceAlarmCurrency());

        // Process view data array through oxoutput processor
        $this->_processViewArray();

        $this->setRecipient($sRecipient, $sRecipient);
        $this->setSubject($oShop->oxshops__oxname->value);

        if ($sBody === null) {
            $sBody = $oSmarty->fetch($this->_sPricealamrCustomerTemplate);
        }

        $this->setBody($sBody);

        $this->addAddress($sRecipient, $sRecipient);
        $this->setReplyTo($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());

        if ($sReturnMailBody) {
            return $this->getBody();
        } else {
            return $this->send();
        }
    }

    protected function _includeImages($sImageDir = null, $sImageDirNoSSL = null, $sDynImageDir = null, $sAbsImageDir = null, $sAbsDynImageDir = null)
    {
        $sBody = $this->getBody();
        if (preg_match_all('/<\s*img\s+[^>]*?src[\s]*=[\s]*[\'"]?([^[\'">]]+|.*?)?[\'">]/i', $sBody, $matches, PREG_SET_ORDER)) {

            $oFileUtils = oxRegistry::get("oxUtilsFile");
            $blReSetBody = false;

            // preparing imput
            $sDynImageDir = $oFileUtils->normalizeDir($sDynImageDir);
            $sImageDir = $oFileUtils->normalizeDir($sImageDir);
            $sImageDirNoSSL = $oFileUtils->normalizeDir($sImageDirNoSSL);

            if (is_array($matches) && count($matches)) {
                $aImageCache = array();
                $myUtils = oxRegistry::getUtils();
                $myUtilsObject = oxUtilsObject::getInstance();
                $oImgGenerator = oxNew("oxDynImgGenerator");

                foreach ($matches as $aImage) {

                    $image = $aImage[1];
                    $sFileName = '';
                    if (strpos($image, $sDynImageDir) === 0) {
                        $sFileName = $oFileUtils->normalizeDir($sAbsDynImageDir) . str_replace($sDynImageDir, '', $image);
                    } elseif (strpos($image, $sImageDir) === 0) {
                        $sFileName = $oFileUtils->normalizeDir($sAbsImageDir) . str_replace($sImageDir, '', $image);
                    } elseif (strpos($image, $sImageDirNoSSL) === 0) {
                        $sFileName = $oFileUtils->normalizeDir($sAbsImageDir) . str_replace($sImageDirNoSSL, '', $image);
                    }

                    if ($sFileName && !@is_readable($sFileName)) {
                        $sFileName = $oImgGenerator->getImagePath($sFileName);
                    }

                    if ($sFileName) {
                        $sCId = '';
                        if (isset($aImageCache[$sFileName]) && $aImageCache[$sFileName]) {
                            $sCId = $aImageCache[$sFileName];
                        } else {
                            $sCId = $myUtilsObject->generateUID();
                            $sMIME = $myUtils->oxMimeContentType($sFileName);
                            if ($sMIME == 'image/jpeg' || $sMIME == 'image/gif' || $sMIME == 'image/png') {
                                if ($this->addEmbeddedImage($sFileName, $sCId, "image", "base64", $sMIME)) {
                                    $aImageCache[$sFileName] = $sCId;
                                } else {
                                    $sCId = '';
                                }
                            }
                        }
                        if ($sCId && $sCId == $aImageCache[$sFileName]) {
                            if ($sReplTag = str_replace($image, 'cid:' . $sCId, $aImage[0])) {
                                $sBody = str_replace($aImage[0], $sReplTag, $sBody);
                                $blReSetBody = true;
                            }
                        }
                    }
                }
            }

            if ($blReSetBody) {
                $this->setBody($sBody);
            }
        }
    }

    public function setSubject($sSubject = null)
    {
        // A. HTML entities in subjects must be replaced
        $sSubject = str_replace(array('&amp;', '&quot;', '&#039;', '&lt;', '&gt;'), array('&', '"', "'", '<', '>'), $sSubject);

        $this->set("Subject", $sSubject);
    }

    public function getSubject()
    {
        return $this->Subject;
    }

    public function setBody($sBody = null, $blClearSid = true)
    {
        if ($blClearSid) {
            $sBody = $this->_clearSidFromBody($sBody);
        }

        $this->set("Body", $sBody);
    }

    public function getBody()
    {
        return $this->Body;
    }

    public function setAltBody($sAltBody = null, $blClearSid = true)
    {
        if ($blClearSid) {
            $sAltBody = $this->_clearSidFromBody($sAltBody);
        }

        // A. alt body is used for plain text emails so we should eliminate HTML entities
        $sAltBody = str_replace(array('&amp;', '&quot;', '&#039;', '&lt;', '&gt;'), array('&', '"', "'", '<', '>'), $sAltBody);

        $this->set("AltBody", $sAltBody);
    }

    public function getAltBody()
    {
        return $this->AltBody;
    }

    public function setRecipient($sAddress = null, $sName = null)
    {
        try {
            if ($this->getConfig()->isUtf() && function_exists('idn_to_ascii') ) {
                $sAddress = idn_to_ascii($sAddress);
            }

            parent::AddAddress($sAddress, $sName);

            // copying values as original class does not allow to access recipients array
            $this->_aRecipients[] = array($sAddress, $sName);
        } catch (Exception $oEx) {
        }
    }

    public function getRecipient()
    {
        return $this->_aRecipients;
    }

    public function clearAllRecipients()
    {
        $this->_aRecipients = array();
        parent::clearAllRecipients();
    }

    public function setReplyTo($sEmail = null, $sName = null)
    {
        if (!oxRegistry::getUtils()->isValidEmail($sEmail)) {
            $sEmail = $this->_getShop()->oxshops__oxorderemail->value;
        }

        $this->_aReplies[] = array($sEmail, $sName);

        try {
            parent::addReplyTo($sEmail, $sName);
        } catch (Exception $oEx) {
        }
    }

    public function getReplyTo()
    {
        return $this->_aReplies;
    }

    public function clearReplyTos()
    {
        $this->_aReplies = array();
        parent::clearReplyTos();
    }

    public function setFrom($address, $name = null, $auto = true)
    {
        $address = substr($address, 0, 150);
        $name = substr($name, 0, 150);

        $success = false;
        try {
            $success = parent::setFrom($address, $name, $auto);
        } catch (Exception $exception) {
        }

        return $success;
    }

    public function getFrom()
    {
        return $this->From;
    }

    public function getFromName()
    {
        return $this->FromName;
    }

    public function setCharSet($sCharSet = null)
    {
        if ($sCharSet) {
            $this->_sCharSet = $sCharSet;
        } else {
            $this->_sCharSet = oxRegistry::getLang()->translateString("charset");
        }
        $this->set("CharSet", $this->_sCharSet);
    }

    public function setMailer($sMailer = null)
    {
        $this->set("Mailer", $sMailer);
    }

    public function getMailer()
    {
        return $this->Mailer;
    }

    public function setHost($sHost = null)
    {
        $this->set("Host", $sHost);
    }

    public function getErrorInfo()
    {
        return $this->ErrorInfo;
    }

    public function setMailWordWrap($iWordWrap = null)
    {
        $this->set("WordWrap", $iWordWrap);
    }

    public function setUseInlineImages($blUseImages = null)
    {
        $this->_blInlineImgEmail = $blUseImages;
    }

    public function addAttachment(
        $path,
        $name = '',
        $encoding = 'base64',
        $type = 'application/octet-stream',
        $disposition = 'attachment'
    ) {
        $this->_aAttachments[] = array($path, $name, $encoding, $type, $disposition);
        $result = false;

        try {
            $result = parent::addAttachment($path, $name, $encoding, $type, $disposition);
        } catch (Exception $exception) {
        }

        return $result;
    }

    public function addEmbeddedImage(
        $path,
        $cid,
        $name = '',
        $encoding = 'base64',
        $type = 'application/octet-stream',
        $disposition = 'inline'
    ) {
        $this->_aAttachments[] = array(
            $path,
            basename($path),
            $name,
            $encoding,
            $type,
            false,
            $disposition,
            $cid
        );

        return parent::addEmbeddedImage($path, $cid, $name, $encoding, $type, $disposition);
    }

    public function getAttachments()
    {
        return $this->_aAttachments;
    }

    public function clearAttachments()
    {
        $this->_aAttachments = array();

        return parent::clearAttachments();
    }

    public function headerLine($sName, $sValue)
    {
        if (stripos($sName, 'X-') !== false) {
            return;
        }

        return parent::headerLine($sName, $sValue);
    }

    protected function _getUseInlineImages()
    {
        return $this->_blInlineImgEmail;
    }

    protected function _sendMailErrorMsg()
    {
        // build addresses
        $aRecipients = $this->getRecipient();

        $sOwnerMessage = "Error sending eMail(" . $this->getSubject() . ") to: \n\n";

        foreach ($aRecipients as $aEMail) {
            $sOwnerMessage .= $aEMail[0];
            $sOwnerMessage .= (!empty($aEMail[1])) ? ' (' . $aEMail[1] . ')' : '';
            $sOwnerMessage .= " \n ";
        }
        $sOwnerMessage .= "\n\nError : " . $this->getErrorInfo();

        // shop info
        $oShop = $this->_getShop();

        $blRet = @mail($oShop->oxshops__oxorderemail->value, "eMail problem in shop!", $sOwnerMessage);

        return $blRet;
    }

    protected function _addUserInfoOrderEMail($oOrder)
    {
        return $oOrder;
    }

    protected function _addUserRegisterEmail($oUser)
    {
        return $oUser;
    }

    protected function _addForgotPwdEmail($oShop)
    {
        return $oShop;
    }

    protected function _addNewsletterDbOptInMail($oUser)
    {
        return $oUser;
    }

    protected function _clearMailer()
    {
        $this->clearAllRecipients();
        $this->clearReplyTos();
        $this->clearAttachments();

        //workaround for phpmailer as it doesn't cleanup as it should
        $this->error_count = 0;
        $this->ErrorInfo = '';
    }

    protected function _setMailParams($oShop = null)
    {
        $this->_clearMailer();

        if (!$oShop) {
            $oShop = $this->_getShop();
        }

        $this->setFrom($oShop->oxshops__oxorderemail->value, $oShop->oxshops__oxname->getRawValue());
        $this->setSmtp($oShop);
    }

    protected function _getShop($iLangId = null, $iShopId = null)
    {
        if ($iLangId === null && $iShopId === null) {
            if (isset($this->_oShop)) {
                return $this->_oShop;
            } else {
                return $this->_oShop = $this->getConfig()->getActiveShop();
            }
        }

        $myConfig = $this->getConfig();

        $oShop = oxNew('oxShop');
        if ($iShopId !== null) {
            $oShop->setShopId($iShopId);
        }
        if ($iLangId !== null) {
            $oShop->setLanguage($iLangId);
        }
        $oShop->load($myConfig->getShopId());

        return $oShop;
    }

    protected function _setSmtpAuthInfo($sUserName = null, $sUserPassword = null)
    {
        $this->set("SMTPAuth", true);
        $this->set("Username", $sUserName);
        $this->set("Password", $sUserPassword);
    }

    protected function _setSmtpDebug($blDebug = null)
    {
        $this->set("SMTPDebug", $blDebug);
    }

    protected function _setMailerPluginDir()
    {
        $this->set("PluginDir", getShopBasePath() . "core/phpmailer/");
    }

    protected function _makeOutputProcessing()
    {
        $oOutput = oxNew("oxOutput");
        $this->setBody($oOutput->process($this->getBody(), "oxemail"));
        $this->setAltBody($oOutput->process($this->getAltBody(), "oxemail"));
        $oOutput->processEmail($this);
    }

    protected function _sendMail()
    {
        $blResult = false;
        try {
            $blResult = parent::send();
        } catch (Exception $oException) {
            $oEx = oxNew("oxException");
            $oEx->setMessage($oException->getMessage());
            $oEx->debugOut();
            if ($this->getConfig()->getConfigParam('iDebug') != 0) {
                throw $oEx;
            }
        }

        return $blResult;
    }


    protected function _processViewArray()
    {
        $oSmarty = $this->_getSmarty();
        $oOutputProcessor = oxNew("oxOutput");

        // processing all view data
        foreach ($this->_aViewData as $sKey => $sValue) {
            $oSmarty->assign($sKey, $sValue);
        }

        // processing assigned smarty variables
        $aNewSmartyArray = $oOutputProcessor->processViewArray($oSmarty->get_template_vars(), "oxemail");

        foreach ($aNewSmartyArray as $key => $val) {
            $oSmarty->assign($key, $val);
        }
    }

    public function getCharset()
    {
        if (!$this->_sCharSet) {
            return oxRegistry::getLang()->translateString("charset");
        } else {
            return $this->CharSet;
        }
    }

    public function getShop()
    {
        return $this->_getShop();
    }

    public function setShop($oShop)
    {
        $this->_oShop = $oShop;
    }

    public function getViewConfig()
    {
        return $this->getConfig()->getActiveView()->getViewConfig();
    }

    public function getView()
    {
        return $this->getConfig()->getActiveView();
    }

    public function getCurrency()
    {
        $oConfig = oxRegistry::getConfig();

        return $oConfig->getActShopCurrencyObject();
    }

    public function setViewData($sKey, $sValue)
    {
        $this->_aViewData[$sKey] = $sValue;
    }

    public function getViewData()
    {
        return $this->_aViewData;
    }

    public function getViewDataItem($sKey)
    {
        if (isset($this->_aViewData[$sKey])) {
            return $this->_aViewData;
        }
    }

    public function setUser($oUser)
    {
        $this->_aViewData["oUser"] = $oUser;
    }

    public function getUser()
    {
        return $this->_aViewData["oUser"];
    }

    public function getOrderFileList($sOrderId)
    {
        $oOrderList = oxNew('oxOrderFileList');
        $oOrderList->loadOrderFiles($sOrderId);

        if (count($oOrderList) > 0) {
            return $oOrderList;
        }

        return false;
    }

    private function _clearSidFromBody($sAltBody)
    {
        return oxStr::getStr()->preg_replace('/(\?|&(amp;)?)(force_)?(admin_)?sid=[A-Z0-9\.]+/i', '\1shp=' . $this->getConfig()->getShopId(), $sAltBody);
    }

    private function _getUserIdByUserName($sUserName, $ShopId)
    {
        $sSelect = "SELECT `OXID` 
          FROM `oxuser` 
          WHERE `OXACTIVE` = 1 
          AND `OXUSERNAME` = ? 
          AND `OXPASSWORD` != ''";

        if ($this->getConfig()->getConfigParam('blMallUsers')) {
            $sSelect .= "ORDER BY OXSHOPID = ? DESC";
        } else {
            $sSelect .= "AND OXSHOPID = ?";
        }

        $sOxId = oxDb::getDb()->getOne(
            $sSelect,
            array(
                $sUserName,
                $ShopId)
        );

        return $sOxId;
    }
}