XH\Mail Class Reference

Emails. More...

Public Member Functions
	__construct ()
	Initializes a new instance.
	isValidAddress ($address)
	Returns whether an email address is valid. More...
	setTo ($to)
	Sets the To address. More...
	getSubject ()
	Returns the encoded subject. More...
	setSubject ($subject)
	Sets the Subject. More...
	setMessage ($message)
	Sets the message. More...
	addHeader ($name, $value)
	Adds a header field. More...
	send ()
	Sends the email and return whether that succeeded. More...

Detailed Description

Emails.

Author

Peter Harteg peter.nosp@m.@har.nosp@m.teg.d.nosp@m.k

The CMSimple_XH developers devs@.nosp@m.cmsi.nosp@m.mple-.nosp@m.xh.o.nosp@m.rg

Copyright

1999-2009 Peter Harteg

2009-2023 The CMSimple_XH developers https://www.cmsimple-xh.org/?About-CMSimple_XH/The-XH-Team

GNU GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html

Since

1.7

Member Function Documentation

addHeader()

XH\Mail::addHeader	(		$name,
			$value
	)

Adds a header field.

Parameters

string	$name	A header field name.
string	$value	A header field value.

Returns

void

getSubject()

XH\Mail::getSubject

(

)

Returns the encoded subject.

Returns

string

isValidAddress()

XH\Mail::isValidAddress

(

$address

)

Returns whether an email address is valid.

For simplicity we are not aiming for full compliance with RFC 5322. The local-part must be a dot-atom-text. The domain is checked with gethostbyname() after applying idn_to_ascii(), if the latter is available.

Parameters

string

$address

An email address.

Returns

bool

send()

XH\Mail::send

(

)

Sends the email and return whether that succeeded.

Returns

bool

setMessage()

XH\Mail::setMessage

(

$message

)

Sets the message.

Parameters

string

$message

A message.

Returns

void

setSubject()

XH\Mail::setSubject

(

$subject

)

Sets the Subject.

Parameters

string

$subject

A subject.

Returns

void

setTo()

XH\Mail::setTo

(

$to

)

Sets the To address.

Parameters

string

$to

A valid email address.

Returns

void

---

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

• cmsimple/classes/Mail.php