oxEmail Class Reference

Inheritance diagram for oxEmail:

Collaboration diagram for oxEmail:

List of all members.

Public Member Functions
	__construct ()
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	send ()
	setSmtp ($oShop=null)
	sendOrderEmailToUser ($oOrder, $sSubject=null)
	sendOrderEmailToOwner ($oOrder, $sSubject=null)
	sendRegisterConfirmEmail ($oUser, $sSubject=null)
	sendRegisterEmail ($oUser, $sSubject=null)
	sendForgotPwdEmail ($sEmailAddress, $sSubject=null)
	sendContactMail ($sEmailAddress=null, $sSubject=null, $sMessage=null)
	sendNewsletterDbOptInMail ($oUser, $sSubject=null)
	sendNewsletterMail ($oNewsLetter, $oUser, $sSubject=null)
	sendSuggestMail ($oParams, $oProduct)
	sendInviteMail ($oParams)
	sendSendedNowMail ($oOrder, $sSubject=null)
	sendDownloadLinksMail ($oOrder, $sSubject=null)
	sendBackupMail ($aAttFiles, $sAttPath, $sEmailAddress, $sSubject, $sMessage, &$aStatus, &$aError)
	sendEmail ($sTo, $sSubject, $sBody)
	sendStockReminder ($aBasketContents, $sSubject=null)
	sendWishlistMail ($oParams)
	sendPriceAlarmNotification ($aParams, $oAlarm, $sSubject=null)
	sendPricealarmToCustomer ($sRecipient, $oAlarm, $sBody=null, $sReturnMailBody=null)
	setSubject ($sSubject=null)
	getSubject ()
	setBody ($sBody=null, $blClearSid=true)
	getBody ()
	setAltBody ($sAltBody=null, $blClearSid=true)
	getAltBody ()
	setRecipient ($sAddress=null, $sName=null)
	getRecipient ()
	clearAllRecipients ()
	setReplyTo ($sEmail=null, $sName=null)
	getReplyTo ()
	clearReplyTos ()
	setFrom ($sFromAddress, $sFromName=null)
	getFrom ()
	getFromName ()
	setCharSet ($sCharSet=null)
	setMailer ($sMailer=null)
	getMailer ()
	setHost ($sHost=null)
	getErrorInfo ()
	setMailWordWrap ($iWordWrap=null)
	setUseInlineImages ($blUseImages=null)
	addAttachment ($sAttPath, $sAttFile= '', $sEncoding= 'base64', $sType= 'application/octet-stream')
	addEmbeddedImage ($sFullPath, $sCid, $sAttFile= '', $sEncoding= 'base64', $sType= 'application/octet-stream')
	getAttachments ()
	clearAttachments ()
	headerLine ($sName, $sValue)
	getCharset ()
	getShop ()
	setShop ($oShop)
	getViewConfig ()
	getView ()
	getCurrency ()
	setViewData ($sKey, $sValue)
	getViewData ()
	getViewDataItem ($sKey)
	setUser ($oUser)
	getUser ()
	getOrderFileList ($sOrderId)
Public Attributes
	$SMTP_PORT = 25
Protected Member Functions
	_getSmarty ()
	_setSmtpProtocol ($sUrl)
	_isValidSmtpHost ($sSmtpHost)
	_getNewsSubsLink ($sId, $sConfirmCode=null)
	_includeImages ($sImageDir=null, $sImageDirNoSSL=null, $sDynImageDir=null, $sAbsImageDir=null, $sAbsDynImageDir=null)
	_getUseInlineImages ()
	_sendMailErrorMsg ()
	_addUserInfoOrderEMail ($oOrder)
	_addUserRegisterEmail ($oUser)
	_addForgotPwdEmail ($oShop)
	_addNewsletterDbOptInMail ($oUser)
	_clearMailer ()
	_setMailParams ($oShop=null)
	_getShop ($iLangId=null, $iShopId=null)
	_setSmtpAuthInfo ($sUserName=null, $sUserPassword=null)
	_setSmtpDebug ($blDebug=null)
	_setMailerPluginDir ()
	_makeOutputProcessing ()
	_sendMail ()
	_processViewArray ()
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/sendednow.tpl"
	$_sSenedNowTemplatePlain = "email/plain/sendednow.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 = array()
	$_blInlineImgEmail = null
	$_aRecipients = array()
	$_aReplies = array()
	$_aAttachments = array()
	$_oSmarty = null
	$_aViewData = array()
	$_oShop = null
	$_sCharSet = null

---

Detailed Description

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

Definition at line 13 of file oxemail.php.

---

Constructor & Destructor Documentation

oxEmail.__construct

(

)

Class constructor.

Definition at line 265 of file oxemail.php.

---

Member Function Documentation

oxEmail.__call	(	$	sMethod,
		$	aArgs
	)

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

Parameters:

	string	$sMethod Methods name
	array	$aArgs Argument array

Exceptions:

oxSystemComponentException

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

Returns:

string

Definition at line 295 of file oxemail.php.

oxEmail._addForgotPwdEmail

(

$

oShop

)

[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:

oxShop

$oShop Shop object

Returns:

oxShop

Definition at line 1936 of file oxemail.php.

oxEmail._addNewsletterDbOptInMail

(

$

oUser

)

[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:

oxUser

$oUser User object

Returns:

oxUser

Definition at line 1950 of file oxemail.php.

oxEmail._addUserInfoOrderEMail

(

$

oOrder

)

[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:

oxOrder

$oOrder Ordering object

Returns:

oxOrder

Definition at line 1908 of file oxemail.php.

oxEmail._addUserRegisterEmail

(

$

oUser

)

[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:

oxUser

$oUser User object

Returns:

oxUser

Definition at line 1922 of file oxemail.php.

oxEmail._clearMailer

(

)

[protected]

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

Returns:

null

Definition at line 1960 of file oxemail.php.

oxEmail._getNewsSubsLink	(	$	sId,
		$	sConfirmCode = null
	)			[protected]

Returns newsletter subscription link

Parameters:

	string	$sId user id
	string	$sConfirmCode confirmation code

Returns:

string $sUrl

Definition at line 839 of file oxemail.php.

oxEmail._getShop	(	$	iLangId = null,
		$	iShopId = null
	)			[protected]

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

Parameters:

	int	$iLangId language id
	int	$iShopId shop id

Returns:

oxShop

Definition at line 1999 of file oxemail.php.

oxEmail._getSmarty

(

)

[protected]

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

Returns:

smarty

Definition at line 341 of file oxemail.php.

oxEmail._getUseInlineImages

(

)

[protected]

Gets use inline images.

Returns:

bool

Definition at line 1867 of file oxemail.php.

oxEmail._includeImages	(	$	sImageDir = null,
		$	sImageDirNoSSL = null,
		$	sDynImageDir = null,
		$	sAbsImageDir = null,
		$	sAbsDynImageDir = null
	)			[protected]

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

Parameters:

	string	$sImageDir Images directory url
	string	$sImageDirNoSSL Images directory url (no SSL)
	string	$sDynImageDir Path to Dyn images
	string	$sAbsImageDir Absolute path to images
	string	$sAbsDynImageDir Absolute path to Dyn images

Returns:

null

Definition at line 1416 of file oxemail.php.

oxEmail._isValidSmtpHost

(

$

sSmtpHost

)

[protected]

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

Parameters:

string

$sSmtpHost currently used smtp server host name

Returns:

bool

Definition at line 469 of file oxemail.php.

oxEmail._makeOutputProcessing

(

)

[protected]

Process email body and alt body thought oxOutput. Calls oxOutput.processEmail() on class instance.

Returns:

null

Definition at line 2066 of file oxemail.php.

oxEmail._processViewArray

(

)

[protected]

Process view data array through oxOutput processor

Returns:

bool

Definition at line 2101 of file oxemail.php.

oxEmail._sendMail

(

)

[protected]

Sends email via phpmailer.

Returns:

bool

Definition at line 2079 of file oxemail.php.

oxEmail._sendMailErrorMsg

(

)

[protected]

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

Returns:

bool

Definition at line 1877 of file oxemail.php.

oxEmail._setMailerPluginDir

(

)

[protected]

Sets path to PHPMailer plugins

Returns:

null

Definition at line 2055 of file oxemail.php.

oxEmail._setMailParams

(

$

oShop = null

)

[protected]

Set mail From, FromName, SMTP values

Parameters:

oxShop

$oShop Shop object

Returns:

void

Definition at line 1978 of file oxemail.php.

oxEmail._setSmtpAuthInfo	(	$	sUserName = null,
		$	sUserPassword = null
	)			[protected]

Sets smtp authentification parameters.

Parameters:

	string	$sUserName smtp user
	oxShop	$sUserPassword smtp password

Returns:

null

Definition at line 2031 of file oxemail.php.

oxEmail._setSmtpDebug

(

$

blDebug = null

)

[protected]

Sets SMTP class debugging on or off

Parameters:

bool

$blDebug show debug info or not

Returns:

null

Definition at line 2045 of file oxemail.php.

oxEmail._setSmtpProtocol

(

$

sUrl

)

[protected]

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

Parameters:

string

$sUrl initial smtp

Returns:

string

Definition at line 412 of file oxemail.php.

oxEmail.addAttachment	(	$	sAttPath,
		$	sAttFile = '',
		$	sEncoding = 'base64',
		$	sType = 'application/octet-stream'
	)

Adds an attachment to mail from a path on the filesystem

Parameters:

	string	$sAttPath path to the attachment
	string	$sAttFile attachment name
	string	$sEncoding attachment encoding
	string	$sType attachment type

Returns:

bool

Definition at line 1794 of file oxemail.php.

oxEmail.addEmbeddedImage	(	$	sFullPath,
		$	sCid,
		$	sAttFile = '',
		$	sEncoding = 'base64',
		$	sType = 'application/octet-stream'
	)

Adds an embedded attachment (check phpmail documentation for more details)

Parameters:

	string	$sFullPath Path to the attachment.
	string	$sCid Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
	string	$sAttFile Overrides the attachment name.
	string	$sEncoding File encoding (see $Encoding).
	string	$sType File extension (MIME) type.

Returns:

bool

Definition at line 1818 of file oxemail.php.

oxEmail.clearAllRecipients

(

)

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

Returns:

void

Definition at line 1603 of file oxemail.php.

oxEmail.clearAttachments

(

)

Clears all attachments from mail.

Returns:

null

Definition at line 1839 of file oxemail.php.

oxEmail.clearReplyTos

(

)

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

Returns:

null

Definition at line 1649 of file oxemail.php.

oxEmail.getAltBody

(

)

Gets mail text-only body

Returns:

string

Definition at line 1561 of file oxemail.php.

oxEmail.getAttachments

(

)

Gets mail attachment.

Returns:

array

Definition at line 1829 of file oxemail.php.

oxEmail.getBody

(

)

Gets mail body

Returns:

string

Definition at line 1530 of file oxemail.php.

oxEmail.getCharset

(

)

Get mail charset

Returns:

string

Definition at line 2124 of file oxemail.php.

oxEmail.getConfig

(

)

oxConfig instance getter

Returns:

oxConfig

Definition at line 314 of file oxemail.php.

oxEmail.getCurrency

(

)

Get active shop currency

Returns:

object

Definition at line 2180 of file oxemail.php.

oxEmail.getErrorInfo

(

)

Gets mailing error info.

Returns:

string

Definition at line 1754 of file oxemail.php.

oxEmail.getFrom

(

)

Gets mail "from address" field.

Returns:

string

Definition at line 1682 of file oxemail.php.

oxEmail.getFromName

(

)

Gets mail "from name" field.

Returns:

string

Definition at line 1692 of file oxemail.php.

oxEmail.getMailer

(

)

Gets mail mailer.

Returns:

string

Definition at line 1732 of file oxemail.php.

oxEmail.getOrderFileList

(

$

sOrderId

)

Get order files

Parameters:

string

$sOrderId order id

Returns:

oxOrderFileList

Definition at line 2253 of file oxemail.php.

oxEmail.getRecipient

(

)

Gets recipients array. Returns array of recipients f.e. array( array('mail1.com', 'user1Name'), array('mail2.com', 'user2Name') )

Returns:

array

Definition at line 1592 of file oxemail.php.

oxEmail.getReplyTo

(

)

Gets array of users for which reply is used.

Returns:

array

Definition at line 1639 of file oxemail.php.

oxEmail.getShop

(

)

Get shop object

Returns:

oxShop

Definition at line 2138 of file oxemail.php.

oxEmail.getSubject

(

)

Gets mail subject

Returns:

string

Definition at line 1502 of file oxemail.php.

oxEmail.getUser

(

)

Get user

Returns:

oxUser

Definition at line 2241 of file oxemail.php.

oxEmail.getView

(

)

Get active view

Returns:

object

Definition at line 2170 of file oxemail.php.

oxEmail.getViewConfig

(

)

Gets viewConfig object

Returns:

object

Definition at line 2160 of file oxemail.php.

oxEmail.getViewData

(

)

Get view data

Returns:

array

Definition at line 2205 of file oxemail.php.

oxEmail.getViewDataItem

(

$

sKey

)

Get view data item

Parameters:

string

$sKey view data array key

Returns:

misc

Definition at line 2217 of file oxemail.php.

oxEmail.headerLine	(	$	sName,
		$	sValue
	)

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

Parameters:

	string	$sName header name
	string	$sValue header value

Returns:

null

Definition at line 1854 of file oxemail.php.

oxEmail.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

Definition at line 360 of file oxemail.php.

oxEmail.sendBackupMail	(	$	aAttFiles,
		$	sAttPath,
		$	sEmailAddress,
		$	sSubject,
		$	sMessage,
		&$	aStatus,
		&$	aError
	)

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

Parameters:

	array	$aAttFiles Array of file names to attach
	string	$sAttPath Path to files to attach
	string	$sEmailAddress Email address
	string	$sSubject Email subject
	string	$sMessage Email body message
	array	&$aStatus Pointer to mailing status array
	array	&$aError Pointer to error status array

Returns:

bool

Definition at line 1150 of file oxemail.php.

oxEmail.sendContactMail	(	$	sEmailAddress = null,
		$	sSubject = null,
		$	sMessage = null
	)

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

Parameters:

	string	$sEmailAddress Email address
	string	$sSubject Email subject
	string	$sMessage Email message text

Returns:

bool

Definition at line 768 of file oxemail.php.

oxEmail.sendDownloadLinksMail	(	$	oOrder,
		$	sSubject = null
	)

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

Parameters:

	oxOrder	$oOrder order object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 1082 of file oxemail.php.

oxEmail.sendEmail	(	$	sTo,
		$	sSubject,
		$	sBody
	)

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

Parameters:

	mixed	$sTo Recipient or an array of the recipients
	string	$sSubject Mail subject
	string	$sBody Mail body

Returns:

bool

Definition at line 1203 of file oxemail.php.

oxEmail.sendForgotPwdEmail	(	$	sEmailAddress,
		$	sSubject = null
	)

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

Parameters:

	string	$sEmailAddress user email address
	string	$sSubject user defined subject [optional]

Returns:

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

Definition at line 701 of file oxemail.php.

oxEmail.sendInviteMail

(

$

oParams

)

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

Parameters:

object

$oParams Mailing parameters object

Returns:

bool

Definition at line 953 of file oxemail.php.

oxEmail.sendNewsletterDbOptInMail	(	$	oUser,
		$	sSubject = null
	)

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

Parameters:

	oxUser	$oUser user object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 796 of file oxemail.php.

oxEmail.sendNewsletterMail	(	$	oNewsLetter,
		$	oUser,
		$	sSubject = null
	)

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

Parameters:

	oxNewsletter	$oNewsLetter newsletter object
	oxUser	$oUser user object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 860 of file oxemail.php.

oxEmail.sendOrderEmailToOwner	(	$	oOrder,
		$	sSubject = null
	)

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

Parameters:

	oxOrder	$oOrder Order object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 557 of file oxemail.php.

oxEmail.sendOrderEmailToUser	(	$	oOrder,
		$	sSubject = null
	)

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

Parameters:

	oxOrder	$oOrder Order object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 500 of file oxemail.php.

oxEmail.sendPriceAlarmNotification	(	$	aParams,
		$	oAlarm,
		$	sSubject = null
	)

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

Parameters:

	array	$aParams Parameters array
	oxPriceAlarm	$oAlarm oxPriceAlarm object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 1316 of file oxemail.php.

oxEmail.sendPricealarmToCustomer	(	$	sRecipient,
		$	oAlarm,
		$	sBody = null,
		$	sReturnMailBody = null
	)

Sends price alarm to customer. Returns true on success.

Parameters:

	string	$sRecipient email
	oxPriceAlarm	$oAlarm oxPriceAlarm object
	string	$sBody optional mail body
	bool	$sReturnMailBody returns mail body instead of sending

Returns:

bool

Definition at line 1360 of file oxemail.php.

oxEmail.sendRegisterConfirmEmail	(	$	oUser,
		$	sSubject = null
	)

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

Parameters:

	oxUser	$oUser user object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 641 of file oxemail.php.

oxEmail.sendRegisterEmail	(	$	oUser,
		$	sSubject = null
	)

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

Parameters:

	oxUser	$oUser user object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 661 of file oxemail.php.

oxEmail.sendSendedNowMail	(	$	oOrder,
		$	sSubject = null
	)

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

Parameters:

	oxOrder	$oOrder order object
	string	$sSubject user defined subject [optional]

Returns:

bool

Definition at line 1016 of file oxemail.php.

oxEmail.sendStockReminder	(	$	aBasketContents,
		$	sSubject = null
	)

Sends reminder email to shop owner.

Parameters:

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

Returns:

bool

Definition at line 1235 of file oxemail.php.

oxEmail.sendSuggestMail	(	$	oParams,
		$	oProduct
	)

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

Parameters:

	object	$oParams Mailing parameters object
	object	$oProduct Product object

Returns:

bool

Definition at line 896 of file oxemail.php.

oxEmail.sendWishlistMail

(

$

oParams

)

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

Parameters:

object

$oParams Mailing parameters object

Returns:

bool

Definition at line 1276 of file oxemail.php.

oxEmail.setAltBody	(	$	sAltBody = null,
		$	blClearSid = true
	)

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

Parameters:

	string	$sAltBody mail subject
	bool	$blClearSid clear sid in mail body (default value is true)

Returns:

null

Definition at line 1544 of file oxemail.php.

oxEmail.setBody	(	$	sBody = null,
		$	blClearSid = true
	)

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

Parameters:

	string	$sBody mail body
	bool	$blClearSid clear sid in mail body

Returns:

null

Definition at line 1516 of file oxemail.php.

oxEmail.setCharSet

(

$

sCharSet = null

)

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

Parameters:

string

$sCharSet email charset

Returns:

null

Definition at line 1705 of file oxemail.php.

oxEmail.setConfig

(

$

oConfig

)

oxConfig instance setter

Parameters:

oxConfig

$oConfig config object

Returns:

null

Definition at line 330 of file oxemail.php.

oxEmail.setFrom	(	$	sFromAddress,
		$	sFromName = null
	)

Sets mail from address and name.

Parameters:

	string	$sFromAddress email address
	string	$sFromName user name

Returns:

null

Definition at line 1663 of file oxemail.php.

oxEmail.setHost

(

$

sHost = null

)

Sets smtp host.

Parameters:

string

$sHost smtp host

Returns:

null

Definition at line 1744 of file oxemail.php.

oxEmail.setMailer

(

$

sMailer = null

)

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

Parameters:

string

$sMailer email mailer

Returns:

null

Definition at line 1722 of file oxemail.php.

oxEmail.setMailWordWrap

(

$

iWordWrap = null

)

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

Parameters:

int

$iWordWrap word wrap

Returns:

string

Definition at line 1767 of file oxemail.php.

oxEmail.setRecipient	(	$	sAddress = null,
		$	sName = null
	)

Sets mail recipient to recipients array

Parameters:

	string	$sAddress recipient email address
	string	$sName recipient name

Returns:

null

Definition at line 1574 of file oxemail.php.

oxEmail.setReplyTo	(	$	sEmail = null,
		$	sName = 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.com', 'user1Name'), array('mail2.com', 'user2Name') )

Parameters:

	string	$sEmail email address
	string	$sName user name

Returns:

null

Definition at line 1620 of file oxemail.php.

oxEmail.setShop

(

$

oShop

)

Set shop object

Parameters:

oxShop

$oShop shop object

Returns:

null

Definition at line 2150 of file oxemail.php.

oxEmail.setSmtp

(

$

oShop = null

)

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

Parameters:

oxShop

$oShop Object, that keeps base shop info

Returns:

null

Definition at line 438 of file oxemail.php.

oxEmail.setSubject

(

$

sSubject = null

)

Sets mail subject

Parameters:

string

$sSubject mail subject

Returns:

null

Definition at line 1489 of file oxemail.php.

oxEmail.setUseInlineImages

(

$

blUseImages = null

)

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

Parameters:

bool

$blUseImages embed or not images into mail

Returns:

null

Definition at line 1779 of file oxemail.php.

oxEmail.setUser

(

$

oUser

)

Set user to view data

Parameters:

oxUser

$oUser user object

Returns:

null

Definition at line 2231 of file oxemail.php.

oxEmail.setViewData	(	$	sKey,
		$	sValue
	)

Set view data to email view.

Parameters:

	string	$sKey key value
	object	$sValue item value

Returns:

null

Definition at line 2195 of file oxemail.php.

---

Member Data Documentation

oxEmail.$_aAttachments = array() [protected]

Definition at line 232 of file oxemail.php.

oxEmail.$_aRecipients = array() [protected]

Definition at line 218 of file oxemail.php.

oxEmail.$_aReplies = array() [protected]

Definition at line 225 of file oxemail.php.

oxEmail.$_aShops = array() [protected]

Definition at line 204 of file oxemail.php.

oxEmail.$_aViewData = array() [protected]

Definition at line 246 of file oxemail.php.

oxEmail.$_blInlineImgEmail = null [protected]

Definition at line 211 of file oxemail.php.

oxEmail.$_oShop = null [protected]

Definition at line 253 of file oxemail.php.

oxEmail.$_oSmarty = null [protected]

Definition at line 239 of file oxemail.php.

oxEmail.$_sCharSet = null [protected]

Definition at line 260 of file oxemail.php.

oxEmail.$_sForgotPwdTemplate = "email/html/forgotpwd.tpl" [protected]

Definition at line 27 of file oxemail.php.

oxEmail.$_sForgotPwdTemplatePlain = "email/plain/forgotpwd.tpl" [protected]

Definition at line 34 of file oxemail.php.

oxEmail.$_sInviteTemplate = "email/html/invite.tpl" [protected]

Definition at line 69 of file oxemail.php.

oxEmail.$_sInviteTemplatePlain = "email/plain/invite.tpl" [protected]

Definition at line 76 of file oxemail.php.

oxEmail.$_sNewsletterOptInTemplate = "email/html/newsletteroptin.tpl" [protected]

Definition at line 41 of file oxemail.php.

oxEmail.$_sNewsletterOptInTemplatePlain = "email/plain/newsletteroptin.tpl" [protected]

Definition at line 48 of file oxemail.php.

oxEmail.$_sOrderOwnerPlainTemplate = "email/plain/order_owner.tpl" [protected]

Definition at line 167 of file oxemail.php.

oxEmail.$_sOrderOwnerSubjectTemplate = "email/html/order_owner_subj.tpl" [protected]

Definition at line 183 of file oxemail.php.

oxEmail.$_sOrderOwnerTemplate = "email/html/order_owner.tpl" [protected]

Definition at line 160 of file oxemail.php.

oxEmail.$_sOrderUserPlainTemplate = "email/plain/order_cust.tpl" [protected]

Definition at line 153 of file oxemail.php.

oxEmail.$_sOrderUserSubjectTemplate = "email/html/order_cust_subj.tpl" [protected]

Definition at line 176 of file oxemail.php.

oxEmail.$_sOrderUserTemplate = "email/html/order_cust.tpl" [protected]

Definition at line 146 of file oxemail.php.

oxEmail.$_sOwnerPricealarmTemplate = "email/html/pricealarm_owner.tpl" [protected]

Definition at line 190 of file oxemail.php.

oxEmail.$_sPricealamrCustomerTemplate = "email_pricealarm_customer.tpl" [protected]

Definition at line 197 of file oxemail.php.

oxEmail.$_sRegisterTemplate = "email/html/register.tpl" [protected]

Definition at line 125 of file oxemail.php.

oxEmail.$_sRegisterTemplatePlain = "email/plain/register.tpl" [protected]

Definition at line 132 of file oxemail.php.

oxEmail.$_sReminderMailTemplate = "email/html/owner_reminder.tpl" [protected]

Definition at line 139 of file oxemail.php.

oxEmail.$_sSendDownloadsTemplate = "email/html/senddownloadlinks.tpl" [protected]

Definition at line 97 of file oxemail.php.

oxEmail.$_sSendDownloadsTemplatePlain = "email/plain/senddownloadlinks.tpl" [protected]

Definition at line 104 of file oxemail.php.

oxEmail.$_sSenedNowTemplate = "email/html/sendednow.tpl" [protected]

Definition at line 83 of file oxemail.php.

oxEmail.$_sSenedNowTemplatePlain = "email/plain/sendednow.tpl" [protected]

Definition at line 90 of file oxemail.php.

oxEmail.$_sSuggestTemplate = "email/html/suggest.tpl" [protected]

Definition at line 55 of file oxemail.php.

oxEmail.$_sSuggestTemplatePlain = "email/plain/suggest.tpl" [protected]

Definition at line 62 of file oxemail.php.

oxEmail.$_sWishListTemplate = "email/html/wishlist.tpl" [protected]

Definition at line 111 of file oxemail.php.

oxEmail.$_sWishListTemplatePlain = "email/plain/wishlist.tpl" [protected]

Definition at line 118 of file oxemail.php.

oxEmail.$SMTP_PORT = 25

Definition at line 20 of file oxemail.php.

---

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

• core/oxemail.php