Inheritance diagram for OxidEsales\EshopCommunity\Core\Email:

Collaboration diagram for OxidEsales\EshopCommunity\Core\Email:

Public Member Functions
	__construct ()

	__call ($method, $args)

	getConfig ()

	setConfig ($config)

	send ()

	setSmtp ($shop=null)

	sendOrderEmailToUser ($order, $subject=null)

	sendOrderEmailToOwner ($order, $subject=null)

	sendRegisterConfirmEmail ($user, $subject=null)

	sendRegisterEmail ($user, $subject=null)

	sendForgotPwdEmail ($emailAddress, $subject=null)

	sendContactMail ($emailAddress=null, $subject=null, $message=null)

	sendNewsletterDbOptInMail ($user, $subject=null)

	sendNewsletterMail ($newsLetter, $user, $subject=null)

	sendSuggestMail ($params, $product)

	sendInviteMail ($params)

	sendSendedNowMail ($order, $subject=null)

	sendDownloadLinksMail ($order, $subject=null)

	sendBackupMail ($attFiles, $attPath, $emailAddress, $subject, $message, &$status, &$error)

	sendEmail ($to, $subject, $body)

	sendStockReminder ($basketContents, $subject=null)

	sendWishlistMail ($params)

	sendPriceAlarmNotification ($params, $alarm, $subject=null)

	sendPricealarmToCustomer ($recipient, $alarm, $body=null, $returnMailBody=null)

	setSubject ($subject=null)

	getSubject ()

	setBody ($body=null, $clearSid=true)

	getBody ()

	setAltBody ($altBody=null, $clearSid=true)

	getAltBody ()

	setRecipient ($address=null, $name=null)

	getRecipient ()

	clearAllRecipients ()

	setReplyTo ($email=null, $name=null)

	getReplyTo ()

	clearReplyTos ()

	setFrom ($address, $name=null, $auto=true)

	getFrom ()

	getFromName ()

	setCharSet ($charSet=null)

	setMailer ($mailer=null)

	getMailer ()

	setHost ($host=null)

	getErrorInfo ()

	setMailWordWrap ($wordWrap=null)

	setUseInlineImages ($useImages=null)

	addAttachment ( $path, $name='', $encoding='base64', $type='application/octet-stream', $disposition='attachment')

	addEmbeddedImage ( $path, $cid, $name='', $encoding='base64', $type='application/octet-stream', $disposition='inline')

	getAttachments ()

	clearAttachments ()

	headerLine ($name, $value)

	getCharset ()

	getShop ()

	setShop ($shop)

	getViewConfig ()

	getView ()

	getCurrency ()

	setViewData ($key, $value)

	getViewData ()

	getViewDataItem ($key)

	setUser ($user)

	getUser ()

	getOrderFileList ($orderId)

Public Attributes
	$Version = '5.2.27'

	$SMTP_PORT = 25

	$smtpPort = 25

Protected Member Functions
	_getSmarty ()

	_setSmtpProtocol ($url)

	_isValidSmtpHost ($smtpHost)

	onOrderEmailToOwnerSent ($user, $order)

	_getNewsSubsLink ($id, $confirmCode=null)

	_includeImages ($imageDir=null, $imageDirNoSSL=null, $dynImageDir=null, $absImageDir=null, $absDynImageDir=null)

	_getUseInlineImages ()

	_sendMailErrorMsg ()

	_addUserInfoOrderEMail ($order)

	_addUserRegisterEmail ($user)

	_addForgotPwdEmail ($shop)

	_addNewsletterDbOptInMail ($user)

	_clearMailer ()

	_setMailParams ($shop=null)

	_getShop ($langId=null, $shopId=null)

	_setSmtpAuthInfo ($userName=null, $userPassword=null)

	_setSmtpDebug ($debug=null)

	_setMailerPluginDir ()

	_makeOutputProcessing ()

	_sendMail ()

	_processViewArray ()

	getUtilsObjectInstance ()

Protected Attributes
	$_sForgotPwdTemplate = "email/html/forgotpwd.tpl"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	$_sPricealamrCustomerTemplate = "email_pricealarm_customer.tpl"

	$_aShops = []

	$_blInlineImgEmail = null

	$_aRecipients = []

	$_aReplies = []

	$_aAttachments = []

	$_oSmarty = null

	$_aViewData = []

	$_oShop = null

	$_sCharSet = null

	$_oConfig = null

Private Member Functions
	_clearSidFromBody ($altBody)

	isDebugModeEnabled ()

	getUserIdByUserName ($userName, $shopId)

	shouldProductReviewLinksBeIncluded ()

Detailed Description

Mailing manager. Collects mailing configuration, other parameters, performs mailing functions (newsletters, ordering, registration emails, etc.).

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\Email::__construct ( )

Class constructor.

Member Function Documentation

◆ __call()

OxidEsales\EshopCommunity\Core\Email::__call	(	$method,
		$args
	)

Only used for convenience in UNIT tests by doing so we avoid writing extended classes for testing protected or private methods

Parameters

string	$method	Methods name
array	$args	Argument array

Exceptions

oxSystemComponentException Throws an exception if the called method does not exist or is not accessible in current class

Returns: string

◆ _addForgotPwdEmail()

OxidEsales\EshopCommunity\Core\Email::_addForgotPwdEmail ( $shop )

protected

Does nothing, returns same object as passed to method. This method is called from oxemail::SendForgotPWDEMail() to do additional operation with shop object before sending email

Parameters

\OxidEsales\Eshop\Application\Model\Shop $shop Shop object

Returns: \OxidEsales\Eshop\Application\Model\Shop

◆ _addNewsletterDbOptInMail()

OxidEsales\EshopCommunity\Core\Email::_addNewsletterDbOptInMail ( $user )

protected

Does nothing, returns same object as passed to method. This method is called from oxEmail::SendNewsletterDBOptInMail() to do additional operation with user object before sending email

Parameters

\OxidEsales\Eshop\Application\Model\User $user User object

Returns: \OxidEsales\Eshop\Application\Model\User

◆ _addUserInfoOrderEMail()

OxidEsales\EshopCommunity\Core\Email::_addUserInfoOrderEMail ( $order )

protected

Does nothing, returns same object as passed to method. This method is called from oxEmail::sendOrderEMailToUser() to do additional operation with order object before sending email

Parameters

\OxidEsales\Eshop\Application\Model\Order $order Ordering object

Returns: \OxidEsales\Eshop\Application\Model\Order

◆ _addUserRegisterEmail()

OxidEsales\EshopCommunity\Core\Email::_addUserRegisterEmail ( $user )

protected

Does nothing, returns same object as passed to method. This method is called from oxEmail::SendRegisterEMail() to do additional operation with user object before sending email

Parameters

\OxidEsales\Eshop\Application\Model\User $user User object

Returns: \OxidEsales\Eshop\Application\Model\User

◆ _clearMailer()

OxidEsales\EshopCommunity\Core\Email::_clearMailer ( )

protected

Clears mailer settings (AllRecipients, ReplyTos, Attachments, Errors)

◆ _clearSidFromBody()

OxidEsales\EshopCommunity\Core\Email::_clearSidFromBody ( $altBody )

private

Performs search for "sid", removes it and adds shop id to string.

Parameters

string $altBody Body.

Returns: string

◆ _getNewsSubsLink()

OxidEsales\EshopCommunity\Core\Email::_getNewsSubsLink	(	$id,
		$confirmCode = `null`
	)

protected

Returns newsletter subscription link

Parameters

string	$id	user id
string	$confirmCode	confirmation code

Returns: string $url

◆ _getShop()

OxidEsales\EshopCommunity\Core\Email::_getShop	(	$langId = `null`,
		$shopId = `null`
	)

protected

Get active shop and set global params for it If is set language parameter, load shop in given language

Parameters

int	$langId	language id
int	$shopId	shop id

Returns: \OxidEsales\Eshop\Application\Model\Shop

◆ _getSmarty()

OxidEsales\EshopCommunity\Core\Email::_getSmarty ( )

protected

Smarty instance getter, assigns this oxEmail instance to "oEmailView" variable

Returns: smarty

◆ _getUseInlineImages()

OxidEsales\EshopCommunity\Core\Email::_getUseInlineImages ( )

protected

Gets use inline images.

Returns: bool

◆ _includeImages()

OxidEsales\EshopCommunity\Core\Email::_includeImages	(	$imageDir = `null`,
		$imageDirNoSSL = `null`,
		$dynImageDir = `null`,
		$absImageDir = `null`,
		$absDynImageDir = `null`
	)

protected

Checks for external images and embeds them to email message if possible

Parameters

string	$imageDir	Images directory url
string	$imageDirNoSSL	Images directory url (no SSL)
string	$dynImageDir	Path to Dyn images
string	$absImageDir	Absolute path to images
string	$absDynImageDir	Absolute path to Dyn images

◆ _isValidSmtpHost()

OxidEsales\EshopCommunity\Core\Email::_isValidSmtpHost ( $smtpHost )

protected

Checks if smtp host is valid (tries to connect to it)

Parameters

string $smtpHost currently used smtp server host name

Returns: bool

◆ _makeOutputProcessing()

OxidEsales\EshopCommunity\Core\Email::_makeOutputProcessing ( )

protected

Process email body and alt body thought oxOutput. Calls \OxidEsales\Eshop\Core\Output::processEmail() on class instance.

◆ _processViewArray()

OxidEsales\EshopCommunity\Core\Email::_processViewArray ( )

protected

Process view data array through oxOutput processor

◆ _sendMail()

OxidEsales\EshopCommunity\Core\Email::_sendMail ( )

protected

Sends email via phpmailer.

Returns: bool

◆ _sendMailErrorMsg()

OxidEsales\EshopCommunity\Core\Email::_sendMailErrorMsg ( )

protected

Try to send error message when original mailing by smtp and via mail() fails

Returns: bool

◆ _setMailerPluginDir()

OxidEsales\EshopCommunity\Core\Email::_setMailerPluginDir ( )

protected

Sets path to PHPMailer plugins

◆ _setMailParams()

OxidEsales\EshopCommunity\Core\Email::_setMailParams ( $shop = null )

protected

Set mail From, FromName, SMTP values

Parameters

\OxidEsales\Eshop\Application\Model\Shop $shop Shop object

◆ _setSmtpAuthInfo()

OxidEsales\EshopCommunity\Core\Email::_setSmtpAuthInfo	(	$userName = `null`,
		$userPassword = `null`
	)

protected

Sets smtp authentification parameters.

Parameters

string	$userName	smtp user
\OxidEsales\Eshop\Application\Model\Shop	$userPassword	smtp password

◆ _setSmtpDebug()

OxidEsales\EshopCommunity\Core\Email::_setSmtpDebug ( $debug = null )

protected

Sets SMTP class debugging on or off

Parameters

bool $debug show debug info or not

◆ _setSmtpProtocol()

OxidEsales\EshopCommunity\Core\Email::_setSmtpProtocol ( $url )

protected

Sets smtp parameters depending on the protocol used returns smtp url which should be used for fsockopen

Parameters

string $url initial smtp

Returns: string

◆ addAttachment()

OxidEsales\EshopCommunity\Core\Email::addAttachment	(	$path,
		$name = `''`,
		$encoding = `'base64'`,
		$type = `'application/octet-stream'`,
		$disposition = `'attachment'`
	)

Parameters

string	$path
string	$name
string	$encoding
string	$type
string	$disposition

Returns: bool

◆ addEmbeddedImage()

OxidEsales\EshopCommunity\Core\Email::addEmbeddedImage	(	$path,
		$cid,
		$name = `''`,
		$encoding = `'base64'`,
		$type = `'application/octet-stream'`,
		$disposition = `'inline'`
	)

Parameters

string	$path
string	$cid
string	$name
string	$encoding
string	$type
string	$disposition

Returns: bool

◆ clearAllRecipients()

OxidEsales\EshopCommunity\Core\Email::clearAllRecipients ( )

Clears all recipients assigned in the TO, CC and BCC array.

◆ clearAttachments()

OxidEsales\EshopCommunity\Core\Email::clearAttachments ( )

Clears all attachments from mail.

◆ clearReplyTos()

OxidEsales\EshopCommunity\Core\Email::clearReplyTos ( )

Clears all recipients assigned in the ReplyTo array. Returns void.

◆ getAltBody()

OxidEsales\EshopCommunity\Core\Email::getAltBody ( )

Gets mail text-only body

Returns: string

◆ getAttachments()

OxidEsales\EshopCommunity\Core\Email::getAttachments ( )

Gets mail attachment.

Returns: array

◆ getBody()

OxidEsales\EshopCommunity\Core\Email::getBody ( )

Gets mail body

Returns: string

◆ getCharset()

OxidEsales\EshopCommunity\Core\Email::getCharset ( )

Get mail charset

Returns: string

◆ getConfig()

OxidEsales\EshopCommunity\Core\Email::getConfig ( )

oxConfig instance getter

Returns: \OxidEsales\Eshop\Core\Config

◆ getCurrency()

OxidEsales\EshopCommunity\Core\Email::getCurrency ( )

Get active shop currency

Returns: object

◆ getErrorInfo()

OxidEsales\EshopCommunity\Core\Email::getErrorInfo ( )

Gets mailing error info.

Returns: string

◆ getFrom()

OxidEsales\EshopCommunity\Core\Email::getFrom ( )

Gets mail "from address" field.

Returns: string

◆ getFromName()

OxidEsales\EshopCommunity\Core\Email::getFromName ( )

Gets mail "from name" field.

Returns: string

◆ getMailer()

OxidEsales\EshopCommunity\Core\Email::getMailer ( )

Gets mail mailer.

Returns: string

◆ getOrderFileList()

OxidEsales\EshopCommunity\Core\Email::getOrderFileList ( $orderId )

Get order files

Parameters

string $orderId order id

Returns: oxOrderFileList

◆ getRecipient()

OxidEsales\EshopCommunity\Core\Email::getRecipient ( )

Gets recipients array. Returns array of recipients f.e. array( array('mail1.nosp@m.@mai.nosp@m.l1.co.nosp@m.m', 'user1Name'), array('mail2.nosp@m.@mai.nosp@m.l2.co.nosp@m.m', 'user2Name') )

Returns: array

◆ getReplyTo()

OxidEsales\EshopCommunity\Core\Email::getReplyTo ( )

Gets array of users for which reply is used.

Returns: array

◆ getShop()

OxidEsales\EshopCommunity\Core\Email::getShop ( )

Get shop object

Returns: \OxidEsales\Eshop\Application\Model\Shop

◆ getSubject()

OxidEsales\EshopCommunity\Core\Email::getSubject ( )

Gets mail subject

Returns: string

◆ getUser()

OxidEsales\EshopCommunity\Core\Email::getUser ( )

Get user

Returns: \OxidEsales\Eshop\Application\Model\User

◆ getUserIdByUserName()

OxidEsales\EshopCommunity\Core\Email::getUserIdByUserName	(	$userName,
		$shopId
	)

private

Parameters

string	$userName
int	$shopId

Returns: false|string

◆ getUtilsObjectInstance()

OxidEsales\EshopCommunity\Core\Email::getUtilsObjectInstance ( )

protected

Returns: \OxidEsales\Eshop\Core\UtilsObject

◆ getView()

OxidEsales\EshopCommunity\Core\Email::getView ( )

Get active view

Returns: object

◆ getViewConfig()

OxidEsales\EshopCommunity\Core\Email::getViewConfig ( )

Gets viewConfig object

Returns: object

◆ getViewData()

OxidEsales\EshopCommunity\Core\Email::getViewData ( )

Get view data

Returns: array

◆ getViewDataItem()

OxidEsales\EshopCommunity\Core\Email::getViewDataItem ( $key )

Get view data item

Parameters

string $key view data array key

Returns: mixed

◆ headerLine()

OxidEsales\EshopCommunity\Core\Email::headerLine	(	$name,
		$value
	)

Inherited phpMailer function adding a header to email message. We override it to skip X-Mailer header.

Parameters

string	$name	header name
string	$value	header value

Returns: string|null

◆ isDebugModeEnabled()

OxidEsales\EshopCommunity\Core\Email::isDebugModeEnabled ( )

private

Return true if debug mode is enabled.

Returns: bool

◆ onOrderEmailToOwnerSent()

OxidEsales\EshopCommunity\Core\Email::onOrderEmailToOwnerSent	(	$user,
		$order
	)

protected

Method is called when order email is sent to owner.

Parameters

\OxidEsales\Eshop\Application\Model\User	$user
\OxidEsales\Eshop\Application\Model\Order	$order

◆ send()

OxidEsales\EshopCommunity\Core\Email::send ( )

Outputs email fields thought email output processor, includes images, and initiate email sending If fails to send mail via SMTP, tries to send via mail(). On failing to send, sends mail to shop administrator about failing mail sending

Returns: bool

◆ sendBackupMail()

OxidEsales\EshopCommunity\Core\Email::sendBackupMail	(		$attFiles,
			$attPath,
			$emailAddress,
			$subject,
			$message,
		&	$status,
		&	$error
	)

Sets mailer additional settings and sends backup data to user. Returns true on success.

Parameters

array	$attFiles	Array of file names to attach
string	$attPath	Path to files to attach
string	$emailAddress	Email address
string	$subject	Email subject
string	$message	Email body message
array	$status	Pointer to mailing status array
array	$error	Pointer to error status array

Returns: bool

◆ sendContactMail()

OxidEsales\EshopCommunity\Core\Email::sendContactMail	(	$emailAddress = `null`,
		$subject = `null`,
		$message = `null`
	)

Sets mailer additional settings and sends contact info mail to user. Returns true on success.

Parameters

string	$emailAddress	Email address
string	$subject	Email subject
string	$message	Email message text

Returns: bool

◆ sendDownloadLinksMail()

OxidEsales\EshopCommunity\Core\Email::sendDownloadLinksMail	(	$order,
		$subject = `null`
	)

Sets mailer additional settings and sends "SendDownloadLinks" mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\Order	$order	order object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendEmail()

OxidEsales\EshopCommunity\Core\Email::sendEmail	(	$to,
		$subject,
		$body
	)

Basic wrapper for email message sending with default parameters from the oxBaseShop. Returns true on success.

Parameters

mixed	$to	Recipient or an array of the recipients
string	$subject	Mail subject
string	$body	Mail body

Returns: bool

◆ sendForgotPwdEmail()

OxidEsales\EshopCommunity\Core\Email::sendForgotPwdEmail	(	$emailAddress,
		$subject = `null`
	)

Sets mailer additional settings and sends "forgot password" mail to user. Returns true on success.

Parameters

string	$emailAddress	user email address
string	$subject	user defined subject [optional]

Returns: mixed true - success, false - user not found, -1 - could not send

◆ sendInviteMail()

OxidEsales\EshopCommunity\Core\Email::sendInviteMail ( $params )

Sets mailer additional settings and sends "InviteMail" mail to user. Returns true on success.

Parameters

object $params Mailing parameters object

Returns: bool

◆ sendNewsletterDbOptInMail()

OxidEsales\EshopCommunity\Core\Email::sendNewsletterDbOptInMail	(	$user,
		$subject = `null`
	)

Sets mailer additional settings and sends "NewsletterDBOptInMail" mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\User	$user	user object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendNewsletterMail()

OxidEsales\EshopCommunity\Core\Email::sendNewsletterMail	(	$newsLetter,
		$user,
		$subject = `null`
	)

Sets mailer additional settings and sends "newsletter" mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\Newsletter	$newsLetter	newsletter object
\OxidEsales\Eshop\Application\Model\User	$user	user object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendOrderEmailToOwner()

OxidEsales\EshopCommunity\Core\Email::sendOrderEmailToOwner	(	$order,
		$subject = `null`
	)

Sets mailer additional settings and sends ordering mail to shop owner. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\Order	$order	Order object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendOrderEmailToUser()

OxidEsales\EshopCommunity\Core\Email::sendOrderEmailToUser	(	$order,
		$subject = `null`
	)

Sets mailer additional settings and sends ordering mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\Order	$order	Order object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendPriceAlarmNotification()

OxidEsales\EshopCommunity\Core\Email::sendPriceAlarmNotification	(	$params,
		$alarm,
		$subject = `null`
	)

Sends a notification to the shop owner that price alarm was subscribed. Returns true on success.

Parameters

array	$params	Parameters array
\OxidEsales\Eshop\Application\Model\PriceAlarm	$alarm	oxPriceAlarm object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendPricealarmToCustomer()

OxidEsales\EshopCommunity\Core\Email::sendPricealarmToCustomer	(	$recipient,
		$alarm,
		$body = `null`,
		$returnMailBody = `null`
	)

Sends price alarm to customer. Returns true on success.

Parameters

string	$recipient	email
\OxidEsales\Eshop\Application\Model\PriceAlarm	$alarm	oxPriceAlarm object
string	$body	optional mail body
bool	$returnMailBody	returns mail body instead of sending

Returns: bool

◆ sendRegisterConfirmEmail()

OxidEsales\EshopCommunity\Core\Email::sendRegisterConfirmEmail	(	$user,
		$subject = `null`
	)

Sets mailer additional settings and sends registration mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\User	$user	user object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendRegisterEmail()

OxidEsales\EshopCommunity\Core\Email::sendRegisterEmail	(	$user,
		$subject = `null`
	)

Sets mailer additional settings and sends registration mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\User	$user	user object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendSendedNowMail()

OxidEsales\EshopCommunity\Core\Email::sendSendedNowMail	(	$order,
		$subject = `null`
	)

Sets mailer additional settings and sends "SendedNowMail" mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\Order	$order	order object
string	$subject	user defined subject [optional]

Returns: bool

◆ sendStockReminder()

OxidEsales\EshopCommunity\Core\Email::sendStockReminder	(	$basketContents,
		$subject = `null`
	)

Sends reminder email to shop owner.

Parameters

array	$basketContents	array of objects to pass to template
string	$subject	user defined subject [optional]

Returns: bool

◆ sendSuggestMail()

OxidEsales\EshopCommunity\Core\Email::sendSuggestMail	(	$params,
		$product
	)

Sets mailer additional settings and sends "SuggestMail" mail to user. Returns true on success.

Parameters

object	$params	Mailing parameters object
object	$product	Product object

Returns: bool

◆ sendWishlistMail()

OxidEsales\EshopCommunity\Core\Email::sendWishlistMail ( $params )

Sets mailer additional settings and sends "WishlistMail" mail to user. Returns true on success.

Parameters

\OxidEsales\Eshop\Application\Model\User | object $params Mailing parameters object

Returns: bool

◆ setAltBody()

OxidEsales\EshopCommunity\Core\Email::setAltBody	(	$altBody = `null`,
		$clearSid = `true`
	)

Sets text-only body of the message. If second parameter is set to true, performs search for "sid", removes it and adds shop id to string.

Parameters

string	$altBody	mail subject
bool	$clearSid	clear sid in mail body (default value is true)

◆ setBody()

OxidEsales\EshopCommunity\Core\Email::setBody	(	$body = `null`,
		$clearSid = `true`
	)

Set mail body. If second parameter (default value is true) is set to true, performs search for "sid", removes it and adds shop id to string.

Parameters

string	$body	mail body
bool	$clearSid	clear sid in mail body

◆ setCharSet()

OxidEsales\EshopCommunity\Core\Email::setCharSet ( $charSet = null )

Sets mail charset. If $charSet is not defined, sets charset from translation file.

Parameters

string $charSet email charset

◆ setConfig()

OxidEsales\EshopCommunity\Core\Email::setConfig ( $config )

oxConfig instance setter

Parameters

\OxidEsales\Eshop\Core\Config $config config object

◆ setFrom()

OxidEsales\EshopCommunity\Core\Email::setFrom	(	$address,
		$name = `null`,
		$auto = `true`
	)

Preventing possible email spam over php mail() exploit (http://www.securephpwiki.com/index.php/Email_Injection)

Parameters

string	$address
null	$name
bool	$auto

Returns: bool

◆ setHost()

OxidEsales\EshopCommunity\Core\Email::setHost ( $host = null )

Sets smtp host.

Parameters

string $host smtp host

◆ setMailer()

OxidEsales\EshopCommunity\Core\Email::setMailer ( $mailer = null )

Sets mail mailer. Set to send mail via smtp, mail() or sendmail.

Parameters

string $mailer email mailer

◆ setMailWordWrap()

OxidEsales\EshopCommunity\Core\Email::setMailWordWrap ( $wordWrap = null )

Sets word wrapping on the body of the message to a given number of characters

Parameters

int $wordWrap word wrap

◆ setRecipient()

OxidEsales\EshopCommunity\Core\Email::setRecipient	(	$address = `null`,
		$name = `null`
	)

Sets mail recipient to recipients array

Parameters

string	$address	recipient email address
string	$name	recipient name

◆ setReplyTo()

OxidEsales\EshopCommunity\Core\Email::setReplyTo	(	$email = `null`,
		$name = `null`
	)

Sets user address and name to "reply to" array. On error (wrong email) default shop email is added as a reply address. Returns array of recipients f.e. array( array('mail1.nosp@m.@mai.nosp@m.l1.co.nosp@m.m', 'user1Name'), array('mail2.nosp@m.@mai.nosp@m.l2.co.nosp@m.m', 'user2Name') )

Parameters

string	$email	email address
string	$name	user name

◆ setShop()

OxidEsales\EshopCommunity\Core\Email::setShop ( $shop )

Set shop object

Parameters

\OxidEsales\Eshop\Application\Model\Shop $shop shop object

◆ setSmtp()

OxidEsales\EshopCommunity\Core\Email::setSmtp ( $shop = null )

Sets SMTP mailer parameters, such as user name, password, location.

Parameters

\OxidEsales\Eshop\Application\Model\Shop $shop Object, that keeps base shop info

Returns: null

◆ setSubject()

OxidEsales\EshopCommunity\Core\Email::setSubject ( $subject = null )

Sets mail subject

Parameters

string $subject mail subject

◆ setUseInlineImages()

OxidEsales\EshopCommunity\Core\Email::setUseInlineImages ( $useImages = null )

Sets use inline images. If true, images will be embedded into mail.

Parameters

bool $useImages embed or not images into mail

◆ setUser()

OxidEsales\EshopCommunity\Core\Email::setUser ( $user )

Set user to view data

Parameters

\OxidEsales\Eshop\Application\Model\User $user user object

◆ setViewData()

OxidEsales\EshopCommunity\Core\Email::setViewData	(	$key,
		$value
	)

Set view data to email view.

Parameters

string	$key	key value
mixed	$value	item value

◆ shouldProductReviewLinksBeIncluded()

OxidEsales\EshopCommunity\Core\Email::shouldProductReviewLinksBeIncluded ( )

private

Returns: bool

Member Data Documentation

◆ $_aAttachments

OxidEsales\EshopCommunity\Core\Email::$_aAttachments = []

protected

◆ $_aRecipients

OxidEsales\EshopCommunity\Core\Email::$_aRecipients = []

protected

◆ $_aReplies

OxidEsales\EshopCommunity\Core\Email::$_aReplies = []

protected

◆ $_aShops

OxidEsales\EshopCommunity\Core\Email::$_aShops = []

protected

◆ $_aViewData

OxidEsales\EshopCommunity\Core\Email::$_aViewData = []

protected

◆ $_blInlineImgEmail

OxidEsales\EshopCommunity\Core\Email::$_blInlineImgEmail = null

protected

◆ $_oConfig

OxidEsales\EshopCommunity\Core\Email::$_oConfig = null

protected

◆ $_oShop

OxidEsales\EshopCommunity\Core\Email::$_oShop = null

protected

◆ $_oSmarty

OxidEsales\EshopCommunity\Core\Email::$_oSmarty = null

protected

◆ $_sCharSet

OxidEsales\EshopCommunity\Core\Email::$_sCharSet = null

protected

◆ $_sForgotPwdTemplate

OxidEsales\EshopCommunity\Core\Email::$_sForgotPwdTemplate = "email/html/forgotpwd.tpl"

protected

◆ $_sForgotPwdTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sForgotPwdTemplatePlain = "email/plain/forgotpwd.tpl"

protected

◆ $_sInviteTemplate

OxidEsales\EshopCommunity\Core\Email::$_sInviteTemplate = "email/html/invite.tpl"

protected

◆ $_sInviteTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sInviteTemplatePlain = "email/plain/invite.tpl"

protected

◆ $_sNewsletterOptInTemplate

OxidEsales\EshopCommunity\Core\Email::$_sNewsletterOptInTemplate = "email/html/newsletteroptin.tpl"

protected

◆ $_sNewsletterOptInTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sNewsletterOptInTemplatePlain = "email/plain/newsletteroptin.tpl"

protected

◆ $_sOrderOwnerPlainTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderOwnerPlainTemplate = "email/plain/order_owner.tpl"

protected

◆ $_sOrderOwnerSubjectTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderOwnerSubjectTemplate = "email/html/order_owner_subj.tpl"

protected

◆ $_sOrderOwnerTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderOwnerTemplate = "email/html/order_owner.tpl"

protected

◆ $_sOrderUserPlainTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderUserPlainTemplate = "email/plain/order_cust.tpl"

protected

◆ $_sOrderUserSubjectTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderUserSubjectTemplate = "email/html/order_cust_subj.tpl"

protected

◆ $_sOrderUserTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOrderUserTemplate = "email/html/order_cust.tpl"

protected

◆ $_sOwnerPricealarmTemplate

OxidEsales\EshopCommunity\Core\Email::$_sOwnerPricealarmTemplate = "email/html/pricealarm_owner.tpl"

protected

◆ $_sPricealamrCustomerTemplate

OxidEsales\EshopCommunity\Core\Email::$_sPricealamrCustomerTemplate = "email_pricealarm_customer.tpl"

protected

◆ $_sRegisterTemplate

OxidEsales\EshopCommunity\Core\Email::$_sRegisterTemplate = "email/html/register.tpl"

protected

◆ $_sRegisterTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sRegisterTemplatePlain = "email/plain/register.tpl"

protected

◆ $_sReminderMailTemplate

OxidEsales\EshopCommunity\Core\Email::$_sReminderMailTemplate = "email/html/owner_reminder.tpl"

protected

◆ $_sSendDownloadsTemplate

OxidEsales\EshopCommunity\Core\Email::$_sSendDownloadsTemplate = "email/html/senddownloadlinks.tpl"

protected

◆ $_sSendDownloadsTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sSendDownloadsTemplatePlain = "email/plain/senddownloadlinks.tpl"

protected

◆ $_sSenedNowTemplate

OxidEsales\EshopCommunity\Core\Email::$_sSenedNowTemplate = "email/html/ordershipped.tpl"

protected

◆ $_sSenedNowTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sSenedNowTemplatePlain = "email/plain/ordershipped.tpl"

protected

◆ $_sSuggestTemplate

OxidEsales\EshopCommunity\Core\Email::$_sSuggestTemplate = "email/html/suggest.tpl"

protected

◆ $_sSuggestTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sSuggestTemplatePlain = "email/plain/suggest.tpl"

protected

◆ $_sWishListTemplate

OxidEsales\EshopCommunity\Core\Email::$_sWishListTemplate = "email/html/wishlist.tpl"

protected

◆ $_sWishListTemplatePlain

OxidEsales\EshopCommunity\Core\Email::$_sWishListTemplatePlain = "email/plain/wishlist.tpl"

protected

◆ $SMTP_PORT

OxidEsales\EshopCommunity\Core\Email::$SMTP_PORT = 25

◆ $smtpPort

OxidEsales\EshopCommunity\Core\Email::$smtpPort = 25

◆ $Version

OxidEsales\EshopCommunity\Core\Email::$Version = '5.2.27'

The documentation for this class was generated from the following file:

/oxideshop-ce/source/Core/Email.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ _addForgotPwdEmail()

◆ _addNewsletterDbOptInMail()

◆ _addUserInfoOrderEMail()

◆ _addUserRegisterEmail()

◆ _clearMailer()

◆ _clearSidFromBody()

◆ _getNewsSubsLink()

◆ _getShop()

◆ _getSmarty()

◆ _getUseInlineImages()

◆ _includeImages()

◆ _isValidSmtpHost()

◆ _makeOutputProcessing()

◆ _processViewArray()

◆ _sendMail()

◆ _sendMailErrorMsg()

◆ _setMailerPluginDir()

◆ _setMailParams()

◆ _setSmtpAuthInfo()

◆ _setSmtpDebug()

◆ _setSmtpProtocol()

◆ addAttachment()

◆ addEmbeddedImage()

◆ clearAllRecipients()

◆ clearAttachments()

◆ clearReplyTos()

◆ getAltBody()

◆ getAttachments()

◆ getBody()

◆ getCharset()

◆ getConfig()

◆ getCurrency()

◆ getErrorInfo()

◆ getFrom()

◆ getFromName()

◆ getMailer()

◆ getOrderFileList()

◆ getRecipient()

◆ getReplyTo()

◆ getShop()

◆ getSubject()

◆ getUser()

◆ getUserIdByUserName()

◆ getUtilsObjectInstance()

◆ getView()

◆ getViewConfig()

◆ getViewData()

◆ getViewDataItem()

◆ headerLine()

◆ isDebugModeEnabled()

◆ onOrderEmailToOwnerSent()

◆ send()

◆ sendBackupMail()

◆ sendContactMail()

◆ sendDownloadLinksMail()

◆ sendEmail()

◆ sendForgotPwdEmail()

◆ sendInviteMail()

◆ sendNewsletterDbOptInMail()

◆ sendNewsletterMail()

◆ sendOrderEmailToOwner()

◆ sendOrderEmailToUser()

◆ sendPriceAlarmNotification()

◆ sendPricealarmToCustomer()

◆ sendRegisterConfirmEmail()

◆ sendRegisterEmail()

◆ sendSendedNowMail()

◆ sendStockReminder()

◆ sendSuggestMail()

◆ sendWishlistMail()