Inheritance diagram for XoopsMailer:

Public Member Functions
	__construct ()

	addHeaders ($value)

	assign ($tag, $value=null)

	encodeBody (&$text)

	encodeFromName ($text)

	encodeSubject ($text)

	getErrors ($ashtml=true)

	getSuccess ($ashtml=true)

	reset ()

	send ($debug=false)

	setBody ($value)

	setFromEmail ($value)

	setFromName ($value)

	setFromUser (XoopsUser $user)

	setHTML ($value=true)

	setPriority ($value)

	setSubject ($value)

	setTemplate ($value)

	setTemplateDir ($value=null)

	setToEmails ($email)

	setToGroups ($groups)

	setToUsers ($users)

	useMail ()

	usePM ()

Protected Attributes
	$charSet = 'iso-8859-1'

	$encoding = '8bit'

	$multimailer

Private Member Functions
	getTemplatePath ()

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

	sendPM ($uid, $subject, $body)

Private Attributes
	$assignedTags

	$body

	$errors

	$fromEmail

	$fromName

	$fromUser

	$headers

	$isMail

	$isPM

	$LE

	$priority

	$subject

	$success

	$template

	$templatedir

	$toEmails

	$toUsers

Detailed Description

Definition at line 33 of file xoopsmailer.php.

Constructor & Destructor Documentation

XoopsMailer::__construct ( )

Constructor

Returns: XoopsMailer

Definition at line 165 of file xoopsmailer.php.

References reset().

Here is the call graph for this function:

Member Function Documentation

XoopsMailer::addHeaders ( $value )

Parameters

string $value

Returns: void

Definition at line 561 of file xoopsmailer.php.

References $LE.

XoopsMailer::assign	(	$tag,
		$value = `null`
	)

Parameters

string \| array	$tag
null	$value

Returns: void

Definition at line 539 of file xoopsmailer.php.

Referenced by send().

Here is the caller graph for this function:

XoopsMailer::encodeBody ( & $text )

abstract, to be overridden by lang specific mail class, if needed

Parameters

string $text

Returns: void

Definition at line 645 of file xoopsmailer.php.

Referenced by sendMail().

Here is the caller graph for this function:

XoopsMailer::encodeFromName ( $text )

abstract, to be overridden by lang specific mail class, if needed

Parameters

$text

Returns

Definition at line 623 of file xoopsmailer.php.

References $text.

Referenced by sendMail().

Here is the caller graph for this function:

XoopsMailer::encodeSubject ( $text )

abstract, to be overridden by lang specific mail class, if needed

Parameters

string $text

Returns: string

Definition at line 634 of file xoopsmailer.php.

References $text.

Referenced by sendMail().

Here is the caller graph for this function:

XoopsMailer::getErrors ( $ashtml = true )

Parameters

bool $ashtml

Returns: string

Definition at line 502 of file xoopsmailer.php.

References $error, $errors, and XoopsLocaleEn_US\ERRORS.

XoopsMailer::getSuccess ( $ashtml = true )

Definition at line 519 of file xoopsmailer.php.

References $success.

XoopsMailer::getTemplatePath ( )

private

Returns: bool|string

Definition at line 227 of file xoopsmailer.php.

References $path, $template, $xoops, XoopsLoad\fileExists(), XoopsBaseConfig\get(), and Xoops\getInstance().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsMailer::reset ( )

reset all properties to default

Returns: void

Definition at line 187 of file xoopsmailer.php.

Referenced by __construct().

Here is the caller graph for this function:

XoopsMailer::send ( $debug = false )

Parameters

bool $debug

Returns: bool

Definition at line 331 of file xoopsmailer.php.

References $body, $headers, $path, $priority, $subject, $text, $user, $xoops, assign(), XoopsLocaleEn_US\E_MESSAGE_BODY_NOT_SET, XoopsLocaleEn_US\E_TEMPLATE_FILE_NOT_OPENED, XoopsLocaleEn_US\EF_EMAIL_NOT_SENT_TO, XoopsLocaleEn_US\EF_PRIVATE_MESSAGE_NOT_SENT_TO, XoopsBaseConfig\get(), Xoops\getInstance(), getTemplatePath(), sendMail(), sendPM(), setBody(), XoopsLocaleEn_US\SF_EMAIL_SENT_TO, and XoopsLocaleEn_US\SF_PRIVATE_MESSAGE_SENT_TO.

Here is the call graph for this function:

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

private

Send email

Uses the new XoopsMultiMailer

Parameters

string	$email
string	$subject
string	$body
array	$headers

Returns: bool

Definition at line 470 of file xoopsmailer.php.

References $body, $charSet, $email, $encoding, $fromEmail, $header, $subject, encodeBody(), encodeFromName(), and encodeSubject().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsMailer::sendPM	(	$uid,
		$subject,
		$body
	)

private

Parameters

int	$uid
string	$subject
string	$body

Returns: bool

Definition at line 441 of file xoopsmailer.php.

References $body, $pm_handler, $subject, $uid, $xoops, and Xoops\getInstance().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsMailer::setBody ( $value )

Parameters

string $value

Returns: void

Definition at line 306 of file xoopsmailer.php.

Referenced by send().

Here is the caller graph for this function:

XoopsMailer::setFromEmail ( $value )

Parameters

string $value

Returns: void

Definition at line 261 of file xoopsmailer.php.

XoopsMailer::setFromName ( $value )

Parameters

string $value

Returns: void

Definition at line 270 of file xoopsmailer.php.

XoopsMailer::setFromUser ( XoopsUser $user )

Parameters

XoopsUser $user

Returns: void

Definition at line 279 of file xoopsmailer.php.

References $user.

XoopsMailer::setHTML ( $value = true )

reset all properties to default

Parameters

bool $value

Returns: void

Definition at line 177 of file xoopsmailer.php.

XoopsMailer::setPriority ( $value )

Parameters

string $value

Returns: void

Definition at line 288 of file xoopsmailer.php.

XoopsMailer::setSubject ( $value )

Parameters

string $value

Returns: void

Definition at line 297 of file xoopsmailer.php.

XoopsMailer::setTemplate ( $value )

Parameters

string $value

Returns: void

Definition at line 252 of file xoopsmailer.php.

XoopsMailer::setTemplateDir ( $value = null )

Parameters

string $value

Returns: void

Definition at line 213 of file xoopsmailer.php.

References $xoops, DIRECTORY_SEPARATOR, and Xoops\getInstance().

Here is the call graph for this function:

XoopsMailer::setToEmails ( $email )

Parameters

$email

Returns: void

Definition at line 570 of file xoopsmailer.php.

References $email, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

XoopsMailer::setToGroups ( $groups )

Parameters

XoopsGroup $group

Returns: void

Definition at line 603 of file xoopsmailer.php.

References $groups, Xoops\getInstance(), and setToUsers().

Here is the call graph for this function:

XoopsMailer::setToUsers ( $users )

Parameters

XoopsUser | array $user

Returns: void

Definition at line 588 of file xoopsmailer.php.

Referenced by setToGroups().

Here is the caller graph for this function:

XoopsMailer::useMail ( )

Returns: void

Definition at line 314 of file xoopsmailer.php.

XoopsMailer::usePM ( )

Returns: void

Definition at line 322 of file xoopsmailer.php.

Member Data Documentation

XoopsMailer::$assignedTags

private

Definition at line 128 of file xoopsmailer.php.

XoopsMailer::$body

private

Definition at line 99 of file xoopsmailer.php.

Referenced by send(), sendMail(), and sendPM().

XoopsMailer::$charSet = 'iso-8859-1'

protected

Definition at line 143 of file xoopsmailer.php.

Referenced by sendMail().

XoopsMailer::$encoding = '8bit'

protected

Definition at line 148 of file xoopsmailer.php.

Referenced by sendMail().

XoopsMailer::$errors

private

Definition at line 106 of file xoopsmailer.php.

Referenced by getErrors().

XoopsMailer::$fromEmail

private

Definition at line 49 of file xoopsmailer.php.

Referenced by sendMail().

XoopsMailer::$fromName

private

Definition at line 56 of file xoopsmailer.php.

XoopsMailer::$fromUser

private

Definition at line 63 of file xoopsmailer.php.

XoopsMailer::$headers

private

Definition at line 85 of file xoopsmailer.php.

Referenced by send().

XoopsMailer::$isMail

private

Definition at line 118 of file xoopsmailer.php.

XoopsMailer::$isPM

private

Definition at line 123 of file xoopsmailer.php.

XoopsMailer::$LE

private

Definition at line 158 of file xoopsmailer.php.

Referenced by addHeaders().

XoopsMailer::$multimailer

protected

Definition at line 42 of file xoopsmailer.php.

XoopsMailer::$priority

private

Definition at line 153 of file xoopsmailer.php.

Referenced by send().

XoopsMailer::$subject

private

Definition at line 92 of file xoopsmailer.php.

Referenced by send(), sendMail(), and sendPM().

XoopsMailer::$success

private

Definition at line 113 of file xoopsmailer.php.

Referenced by getSuccess().

XoopsMailer::$template

private

Definition at line 133 of file xoopsmailer.php.

Referenced by getTemplatePath().

XoopsMailer::$templatedir

private

Definition at line 138 of file xoopsmailer.php.

XoopsMailer::$toEmails

private

Definition at line 77 of file xoopsmailer.php.

XoopsMailer::$toUsers

private

Definition at line 70 of file xoopsmailer.php.

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

C:/usr64/htdocs/class/xoopsmailer.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation