XoopsMailer Class Reference

Inheritance diagram for XoopsMailer:

Public Member Functions
	__construct ()
	XoopsMailer ()
	setHTML ($value=true)
	reset ()
	setTemplateDir ($value=null)
	getTemplatePath ()
	setTemplate ($value)
	setFromEmail ($value)
	setFromName ($value)
	setFromUser ($user)
	setPriority ($value)
	setSubject ($value)
	setBody ($value)
	useMail ()
	usePM ()
	send ($debug=false)
	sendPM ($uid, $subject, $body)
	sendMail ($email, $subject, $body, $headers)
	getErrors ($ashtml=true)
	getSuccess ($ashtml=true)
	assign ($tag, $value=null)
	addHeaders ($value)
	setToEmails ($email)
	setToUsers ($user)
	setToGroups ($group)
	encodeFromName ($text)
	encodeSubject ($text)
	encodeBody (&$text)

Data Fields
	$multimailer
	$fromEmail
	$fromName
	$fromUser
	$toUsers
	$toEmails
	$headers
	$subject
	$body
	$errors
	$success
	$isMail
	$isPM
	$assignedTags
	$template
	$templatedir
	$charSet = 'iso-8859-1'
	$encoding = '8bit'

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor

Returns

XoopsMailer

Reimplemented in XoopsMailerLocal.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

addHeaders()

addHeaders

(

$value

)

Parameters

$value

assign()

assign	(		$tag,
			$value = null
	)

Parameters

	$tag
null	$value

Here is the call graph for this function:

Here is the caller graph for this function:

encodeBody()

encodeBody

(

&

$text

)

Parameters

$text

Here is the caller graph for this function:

encodeFromName()

encodeFromName

(

$text

)

Parameters

$text

Returns

mixed

Reimplemented in XoopsMailerLocal.

Here is the caller graph for this function:

encodeSubject()

encodeSubject

(

$text

)

Parameters

$text

Returns

mixed

Reimplemented in XoopsMailerLocal.

Here is the caller graph for this function:

getErrors()

getErrors

(

$ashtml = true

)

Parameters

bool

$ashtml

Returns

string

getSuccess()

getSuccess

(

$ashtml = true

)

Parameters

bool

$ashtml

Returns

string

getTemplatePath()

getTemplatePath

(

)

Returns

bool|string

Here is the caller graph for this function:

reset()

reset

(

)

Here is the caller graph for this function:

send()

send

(

$debug = false

)

Parameters

bool

$debug

Returns

bool

Here is the call graph for this function:

sendMail()

sendMail	(		$email,
			$subject,
			$body,
			$headers
	)

Send email

Uses the new XoopsMultiMailer

Parameters

$email
$subject
$body
$headers

Returns

bool

Here is the call graph for this function:

Here is the caller graph for this function:

sendPM()

sendPM	(		$uid,
			$subject,
			$body
	)

Parameters

$uid
$subject
$body

Returns

bool

Here is the call graph for this function:

Here is the caller graph for this function:

setBody()

setBody

(

$value

)

Parameters

$value

Here is the caller graph for this function:

setFromEmail()

setFromEmail

(

$value

)

Parameters

$value

setFromName()

setFromName

(

$value

)

Parameters

$value

setFromUser()

setFromUser

(

$user

)

Parameters

$user

setHTML()

setHTML

(

$value = true

)

Parameters

bool

$value

setPriority()

setPriority

(

$value

)

Parameters

$value

setSubject()

setSubject

(

$value

)

Parameters

$value

setTemplate()

setTemplate

(

$value

)

Parameters

$value

setTemplateDir()

setTemplateDir

(

$value = null

)

Parameters

null

$value

setToEmails()

setToEmails

(

$email

)

Parameters

$email

Here is the call graph for this function:

Here is the caller graph for this function:

setToGroups()

setToGroups

(

$group

)

Parameters

$group

Here is the call graph for this function:

Here is the caller graph for this function:

setToUsers()

setToUsers

(

$user

)

Parameters

$user

Here is the call graph for this function:

Here is the caller graph for this function:

useMail()

useMail

(

)

usePM()

usePM

(

)

XoopsMailer()

XoopsMailer

(

)

PHP 4 style constructor compatibility shim

Deprecated:

all callers should be using parent::__construct()

Here is the call graph for this function:

Field Documentation

$assignedTags

$assignedTags

$body

$body

$charSet

$charSet = 'iso-8859-1'

$encoding

$encoding = '8bit'

$errors

$errors

$fromEmail

$fromEmail

$fromName

$fromName

$fromUser

$fromUser

$headers

$headers

$isMail

$isMail

$isPM

$isPM

$multimailer

$multimailer

$subject

$subject

$success

$success

$template

$template

$templatedir

$templatedir

$toEmails

$toEmails

$toUsers

$toUsers

---

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

• C:/xoops2511b2/htdocs/class/xoopsmailer.php