oxemail.php

Go to the documentation of this file.

<?php
require oxConfig::getInstance()->getConfigParam( 'sCoreDir' ) . "/phpmailer/class.phpmailer.php";


class oxEmail extends PHPMailer
{
    public $SMTP_PORT = 25;

    protected $_sForgotPwdTemplate = "email_forgotpwd_html.tpl";

    protected $_sForgotPwdTemplatePlain = "email_forgotpwd_plain.tpl";

    protected $_sNewsletterOptInTemplate = "email_newsletteroptin_html.tpl";

    protected $_sNewsletterOptInTemplatePlain = "email_newsletteroptin_plain.tpl";

    protected $_sSuggestTemplate = "email_suggest_html.tpl";

    protected $_sSuggestTemplatePlain = "email_suggest_plain.tpl";

    protected $_sInviteTemplate = "email_invite_html.tpl";

    protected $_sInviteTemplatePlain = "email_invite_plain.tpl";

    protected $_sSenedNowTemplate = "email_sendednow_html.tpl";

    protected $_sSenedNowTemplatePlain = "email_sendednow_plain.tpl";

    protected $_sWishListTemplate = "email_wishlist_html.tpl";

    protected $_sWishListTemplatePlain = "email_wishlist_plain.tpl";

    protected $_sRegisterTemplate = "email_register_html.tpl";

    protected $_sRegisterTemplatePlain = "email_register_plain.tpl";

    protected $_sReminderMailTemplate = "email_owner_reminder_html.tpl";

    protected $_sOrderUserTemplate          = "email_order_cust_html.tpl";

    protected $_sOrderUserPlainTemplate     = "email_order_cust_plain.tpl";

    protected $_sOrderOwnerTemplate         = "email_order_owner_html.tpl";

    protected $_sOrderOwnerPlainTemplate    = "email_order_owner_plain.tpl";

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

    protected $_sOrderUserSubjectTemplate   = "email_order_cust_subj.tpl";

    protected $_sOrderOwnerSubjectTemplate  = "email_order_owner_subj.tpl";

    protected $_sOwnerPricealarmTemplate    = "email_pricealarm_owner.tpl";

    protected $_aShops = array();

    protected $_blInlineImgEmail = null;

    protected $_aRecipients = array();

    protected $_aReplies = array();

    protected $_aAttachments = array();

    protected $_oSmarty = 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/");
    }

    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 = oxConfig::getInstance();
        }

        return $this->_oConfig;
    }

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


    protected function _getSmarty()
    {
        if ( $this->_oSmarty === null ) {
            $this->_oSmarty = oxUtilsView::getInstance()->getSmarty();
        }
        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->getNoSSLImageDir( isAdmin() ), $myConfig->getDynImageDir(),
                                   $myConfig->getAbsImageDir(), $myConfig->getAbsDynImageDir());
        }

        $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 ) {
                $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 );

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

        // P
        // setting some deprecated variables
        $oOrder->oDelSet = $oOrder->getDelSet();

        $oUser = $oOrder->getOrderUser();
        // create messages
        $oSmarty = $this->_getSmarty();
        $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset"));
        $oSmarty->assign( "order", $oOrder);
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "user", $oUser );
        $oSmarty->assign( "currency", $myConfig->getActShopCurrencyObject() );
        $oSmarty->assign( "basket", $oOrder->getBasket() );
        $oSmarty->assign( "payment", $oOrder->getPayment() );
        if ( $oUser ) {
            $oSmarty->assign( "reviewuserhash", $oUser->getReviewUserHash( $oUser->getId() ) );
        }
        $oSmarty->assign( "paymentinfo", $myConfig->getActiveShop() );

        //deprecated vars
        $oSmarty->assign( "iswishlist", true );
        $oSmarty->assign( "isreview", true );

        if ( $aVoucherList = $oOrder->getVoucherList() ) {
            $oSmarty->assign( "vouchers", $aVoucherList );
        }

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

        $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 );

        // send confirmation to shop owner
        $sFullName = $oOrder->getOrderUser()->oxuser__oxfname->getRawValue() . " " . $oOrder->getOrderUser()->oxuser__oxlname->getRawValue();
        $this->setFrom( $oOrder->getOrderUser()->oxuser__oxusername->value, $sFullName );

        $oLang = oxLang::getInstance();
        $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();
        $oSmarty->assign( "charset", $oLang->translateString("charset"));
        $oSmarty->assign( "order", $oOrder );
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "user", $oOrder->getOrderUser() );
        $oSmarty->assign( "currency", $myConfig->getActShopCurrencyObject() );
        $oSmarty->assign( "basket", $oOrder->getBasket() );
        $oSmarty->assign( "payment", $oOrder->getPayment() );

        //deprecated var
        $oSmarty->assign( "iswishlist", true);

        if( $oOrder->getVoucherList() )
            $oSmarty->assign( "vouchers", $oOrder->getVoucherList() );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray($oSmarty->get_template_vars(), "oxemail");
        foreach ($aNewSmartyArray as $key => $val)
            $oSmarty->assign( $key, $val );

        $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 ( $oOrder->getOrderUser()->oxuser__oxusername->value != "admin" )
            $this->setReplyTo( $oOrder->getOrderUser()->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($oOrder->getOrderUser()->getId(), oxField::T_RAW);
        $oRemark->oxremark__oxtype      = new oxField("o", oxField::T_RAW);
        $oRemark->save();


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

        return $blSuccess;
    }

    public function sendRegisterConfirmEmail( $oUser, $sSubject = null )
    {
        // setting content ident
        $oSmarty = $this->_getSmarty();
        $oSmarty->assign( "contentident", "oxregisteraltemail" );
        $oSmarty->assign( "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();
        $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset") );
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $this->getConfig()->getActiveView() );
        $oSmarty->assign( "user", $oUser );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

        $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 )
    {
        $myConfig = $this->getConfig();
        $oDb = oxDb::getDb();

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

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

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

        // user
        $sWhere = "oxuser.oxactive = 1 and oxuser.oxusername = ".$oDb->quote( $sEmailAddress )." and oxuser.oxpassword != ''";
        $sOrder = "";
        if ( $myConfig->getConfigParam( 'blMallUsers' )) {
            $sOrder = "order by oxshopid = '".$oShop->getId()."' desc";
        } else {
            $sWhere .= " and oxshopid = '".$oShop->getId()."'";
        }

        $sSelect = "select oxid from oxuser where $sWhere $sOrder";
        if ( ( $sOxId = $oDb->getOne( $sSelect ) ) ) {

            $oUser = oxNew( 'oxuser' );
            if ( $oUser->load($sOxId) ) {
                // create messages
                $oSmarty = $this->_getSmarty();
                $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset"));
                $oSmarty->assign( "shop", $oShop );
                $oSmarty->assign( "oViewConf", $oShop );
                $oSmarty->assign( "oView", $myConfig->getActiveView() );
                $oSmarty->assign( "user", $oUser );

                $oOutputProcessor = oxNew( "oxoutput" );
                $aNewSmartyArray  = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

                $this->setBody( $oSmarty->fetch( $this->_sForgotPwdTemplate ) );
                $this->setAltBody( $oSmarty->fetch( $this->_sForgotPwdTemplatePlain ) );

                //sets subject of email
                $this->setSubject( ( $sSubject !== null ) ? $sSubject : $oShop->oxshops__oxforgotpwdsubject->getRawValue() );

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

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

                return $this->send();
            }
        }

        return false;
    }

    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( $sEmailAddress, "" );
        $this->setReplyTo( $sEmailAddress, "" );

        return $this->send();
    }

    public function sendNewsletterDbOptInMail( $oUser, $sSubject = null )
    {
        $oLang = oxLang::getInstance();

        // 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();
        $oSmarty->assign( "charset", $oLang->translateString("charset"));
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $this->getConfig()->getActiveView() );
        $oSmarty->assign( "subscribeLink", $this->_getNewsSubsLink($oUser->oxuser__oxid->value) );
        $oSmarty->assign( "user", $oUser );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );
        foreach ( $aNewSmartyArray as $key => $val ) {
            $oSmarty->assign( $key, $val );
        }

        $this->setBody( $oSmarty->fetch( $this->_sNewsletterOptInTemplate ) );
        $this->setAltBody( $oSmarty->fetch( $this->_sNewsletterOptInTemplatePlain ) );
        $this->setSubject( ( $sSubject !== null ) ? $sSubject : oxLang::getInstance()->translateString("EMAIL_NEWSLETTERDBOPTINMAIL_SUBJECT") . " " . $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 )
    {
        $myConfig = $this->getConfig();
        $iActShopLang = $myConfig->getActiveShop()->getLanguage();

        $sUrl = $myConfig->getShopHomeURL().'cl=newsletter&amp;fnc=addme&amp;uid='.$sId;
        $sUrl.= ( $iActShopLang ) ? '&amp;lang='.$iActShopLang : "";
        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
        $this->setFrom( $oParams->send_email, $oParams->send_name );
        $this->setSMTP();

        // create messages
        $oSmarty = $this->_getSmarty();
        $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset") );
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "userinfo", $oParams );
        $oSmarty->assign( "product", $oProduct );

        $sArticleUrl = $oProduct->getLink();

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

        $oSmarty->assign( "sArticleUrl", $sArticleUrl );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

        $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 = oxUtilsView::getInstance()->getSmarty();
        $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset") );
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "userinfo", $oParams );
        $oSmarty->assign( "sShopUrl", $myConfig->getShopCurrentUrl() );

        $sHomeUrl = $oShop->getHomeLink();

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

        $oSmarty->assign( "sHomeUrl", $sHomeUrl );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

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

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

        if ( is_array($oParams->rec_email) && count($oParams->rec_email) > 0  ) {
            foreach ( $oParams->rec_email as $sEmail ) {
                if ( !empty( $sEmail ) ) {
                    $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 );

        //override default wrap
        //$this->setMailWordWrap( 0 );

        //create messages
        $oLang = oxLang::getInstance();
        $oSmarty = $this->_getSmarty();
        $oSmarty->assign( "charset", $oLang->translateString("charset"));
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "order", $oOrder );
        $oSmarty->assign( "currency", $myConfig->getActShopCurrencyObject() );

        //deprecated var
        $oSmarty->assign( "isreview", true);
        $oUser = oxNew( 'oxuser' );
        $oSmarty->assign( "reviewuserhash", $oUser->getReviewUserHash($oOrder->oxorder__oxuserid->value) );

        $oOutputProcessor = oxNew( "oxoutput" );
        $aNewSmartyArray = $oOutputProcessor->processViewArray( $oSmarty->get_template_vars(), "oxemail" );

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

        // dodger #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;

        $this->setBody( $oSmarty->fetch( $myConfig->getTemplatePath( $this->_sSenedNowTemplate, false ) ) );
        $this->setAltBody( $oSmarty->fetch( $myConfig->getTemplatePath( $this->_sSenedNowTemplatePlain, false ) ) );
        $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 sendBackupMail( $aAttFiles, $sAttPath, $sEmailAddress, $sSubject, $sMessage, &$aStatus, &$aError )
    {

        /* P
        $sMailMessage = $myConfig->getConfigParam( 'sMailMessage' );
        $sMessage = ( !empty($sMailMessage) ) ? $sMailMessage : "" ;
        */

        // 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 = oxUtilsFile::getInstance()->normalizeDir($sAttPath);
        foreach ( $aAttFiles as $iNum => $sAttFile ) {
            if ( file_exists($sAttPath . $sAttFile) && is_file($sAttPath . $sAttFile) ) {
                $blAttashSucc = $this->addAttachment( $sAttPath, $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 = oxLang::getInstance();

            $oSmarty = $this->_getSmarty();
            $oSmarty->assign( "charset", $oLang->translateString( "charset" ) );
            $oSmarty->assign( "shop", $oShop );
            $oSmarty->assign( "oViewConf", $oShop );
            $oSmarty->assign( "oView", $this->getConfig()->getActiveView() );
            $oSmarty->assign( "articles", $oArticleList );

            $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( 'EMAIL_STOCKREMINDER_SUBJECT' ) );

            $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();
        $oSmarty->assign( "charset", oxLang::getInstance()->translateString("charset") );
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $myConfig->getActiveView() );
        $oSmarty->assign( "userinfo", $oParams );

        $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'] );

        $oCur  = $this->getConfig()->getActShopCurrencyObject();
        $oLang = oxLang::getInstance();

        // create messages
        $oSmarty = $this->_getSmarty();
        $oSmarty->assign( "shop", $oShop );
        $oSmarty->assign( "oViewConf", $oShop );
        $oSmarty->assign( "oView", $this->getConfig()->getActiveView() );
        $oSmarty->assign( "product", $oArticle );
        $oSmarty->assign( "email", $aParams['email']);
        $oSmarty->assign( "bidprice", $oLang->formatCurrency( $oAlarm->oxpricealarm__oxprice->value, $oCur ) );
        $oSmarty->assign( "currency", $oCur );

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

        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 = oxUtilsFile::getInstance();
            $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 = oxUtils::getInstance();
                $myUtilsObject = oxUtilsObject::getInstance();

                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_file($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 entites 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 = getStr()->preg_replace('/((\?|&(amp;)?)(force_)?(admin_)?)sid=[A-Z0-9\.]+/i', '\1sid=x&amp;shp=' . $this->getConfig()->getShopId(), $sBody);
        }

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

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

    public function setAltBody( $sAltBody = null, $blClearSid = true )
    {
        if ( $blClearSid ) {
            $sAltBody = getStr()->preg_replace('/((\?|&(amp;)?)(force_)?(admin_)?)sid=[A-Z0-9\.]+/i', '\1sid=x&amp;shp=' . $this->getConfig()->getShopId(), $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 {
            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 ( !oxUtils::getInstance()->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( $sFromAdress, $sFromName = null )
    {
        // preventing possible email spam over php mail() exploit (http://www.securephpwiki.com/index.php/Email_Injection)
        // this is simple but must work
        // dodger Task #1532 field "From" in emails from shops
        $sFromAdress = substr($sFromAdress, 0, 150);
        $sFromName   = substr($sFromName, 0, 150);

        try {
            parent::setFrom( $sFromAdress, $sFromName );
        } catch( Exception $oEx ) {
        }
    }

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

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

    public function setCharSet( $sCharSet = null )
    {
        $this->set( "CharSet", $sCharSet ? $sCharSet : oxLang::getInstance()->translateString( "charset" ) );
    }

    public function getCharSet()
    {
        return $this->CharSet;
    }

    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( $sAttPath, $sAttFile = '', $sEncoding = 'base64', $sType = 'application/octet-stream' )
    {
        $sFullPath = $sAttPath . $sAttFile;

        $this->_aAttachments[] = array( $sFullPath, $sAttFile, $sEncoding, $sType );
        $blResult = false;

        try {
             $blResult = parent::addAttachment( $sFullPath, $sAttFile, $sEncoding, $sType );
        } catch( Exception $oEx ) {
        }

        return $blResult;
    }

    public function addEmbeddedImage( $sFullPath, $sCid, $sAttFile = '', $sEncoding = 'base64', $sType = 'application/octet-stream' )
    {
        $this->_aAttachments[] = array( $sFullPath, basename($sFullPath), $sAttFile, $sEncoding, $sType, false, 'inline', $sCid );
        return parent::addEmbeddedImage( $sFullPath, $sCid, $sAttFile, $sEncoding, $sType );
    }

    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
        $sToAdress  = "";
        $sToName    = "";

        $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 )
    {
        $myConfig = $this->getConfig();
        if ( $iLangId === null ) {
            $iLangId = $myConfig->getActiveShop()->getLanguage();
        }
        $iLangId = oxLang::getInstance()->validateLanguage( $iLangId );

        if ( !isset( $this->_aShops[$iLangId] ) ) {
            $oShop = oxNew( 'oxshop' );
            $oShop->loadInLang( $iLangId, $myConfig->getShopId() );
            $this->_aShops[$iLangId] = $myConfig->getActiveView()->addGlobalParams( $oShop );
        }

        return $this->_aShops[$iLangId];
    }

    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 $oEx ) {
        }

        return $blResult;
    }
}