📚 Looking for current Exponential documentation? This site contains legacy SDK & API reference docs (eZ Publish era). For up-to-date 2026 product documentation, visit doc.exponential.earth.

class / eZMail

eZMail Class Reference
[Utility classes]

Mail object. More...

List of all members.


Public Methods
	eZMail ()
	receiverEmailText ()
	receiverText ()
	receiverTextList ()
	receiverElements ()
	ccElements ()
	bccElements ()
	replyTo ()
	sender ()
	senderText ()
	setReceiverElements ($toElements)
	setReceiver ($email,$name=false)
	setReceiverText ($text)
	addReceiver ($email,$name=false)
	setReplyTo ($email,$name=false)
	setSender ($email,$name=false)
	setSenderText ($text)
	setCcElements ($newCc)
	addCc ($email,$name=false)
	setBccElements ($newBcc)
	addBcc ($email,$name=false)
	extraHeaders ($headers)
	addExtraHeader ($headerName,$headerValue)
	setExtraHeaders ($headers)
	messageID ()
	setMessageID ($newMessageID)
	references ()
	setReferences ($newReference)
	subject ()
	setSubject ($newSubject)
	body ()
	setBody ($newBody)
	blankNewlines ($text)
	headers ()
	headerText ()
Static Public Methods
&	splitList ($emails)
	validate ($address)
	stripEmail ($address)
	composeEmailName ($item,$key=false)
	composeEmailItems ($items,$join=true,$key=false)
Public Attributes
	ReceiverElements
	\privatesection

Detailed Description

Mail object.

Class for storing the details about en email and providing text serialization.

Definition at line ezmail.php.

Constructor & Destructor Documentation

eZMail::eZMail

(

)

Constructs a new eZMail object.

Definition at line ezmail.php.

References ReceiverElements.

Member Function Documentation

eZMail::addBcc	(	$	email,
		$	name = false
	)

Adds a new Bcc address.

Definition at line ezmail.php.

eZMail::addCc	(	$	email,
		$	name = false
	)

Adds a new Cc address.

Definition at line ezmail.php.

eZMail::addExtraHeader	(	$	headerName,
		$	headerValue
	)

Adds the headers $headerName with header value $headerValue to the extra headers.

Definition at line ezmail.php.

eZMail::addReceiver	(	$	email,
		$	name = false
	)

Adds a new receiver address.

Definition at line ezmail.php.

References ReceiverElements.

eZMail::bccElements

(

)

Returns the addresses which should get a blind carbon copy.

Definition at line ezmail.php.

eZMail::blankNewlines

(

$

text

)

Returns:: a text which does not contain newlines, newlines are converted to spaces.

Definition at line ezmail.php.

Referenced by headerText().

eZMail::body

(

)

returns the body.

Definition at line ezmail.php.

eZMail::ccElements

(

)

Returns the addresses which should get a carbon copy.

Definition at line ezmail.php.

eZMail::composeEmailItems	(	$	items,
		$	join = true,
		$	key = false
	)	`[static]`

Composes an email text out of all items in $items and returns it. All items are comma separated.

Definition at line ezmail.php.

References composeEmailName().

Referenced by receiverTextList().

eZMail::composeEmailName	(	$	item,
		$	key = false
	)	`[static]`

Composes a text out of the email and name and returns it.

Example: John Doe <john@doe.com> or just john@doe.com

Definition at line ezmail.php.

Referenced by senderText().

eZMail::extraHeaders

(

$

headers

)

Sets the extra headers to $headers

Definition at line ezmail.php.

References headers().

Referenced by headers().

eZMail::headers

(

)

Returns:: an array with headers, each header item is an associative array with the keys name and content.

Definition at line ezmail.php.

References headers().

Referenced by setExtraHeaders().

eZMail::headerText

(

)

Composes a text field out of all the headers and returns it.

Definition at line ezmail.php.

References headers().

eZMail::messageID

(

)

Returns the message ID format : <number@serverID> Read in the RFC's if you want to know more about it..

Definition at line ezmail.php.

eZMail::receiverElements

(

)

Returns the receiver addresses.

Definition at line ezmail.php.

References ReceiverElements.

eZMail::receiverEmailText

(

)

Returns the receiver addresses as text.

Definition at line ezmail.php.

References composeEmailItems().

eZMail::receiverText

(

)

Returns the receiver addresses as text.

Definition at line ezmail.php.

References composeEmailItems().

eZMail::receiverTextList

(

)

Returns the receiver addresses as an array with texts.

Definition at line ezmail.php.

References composeEmailItems().

eZMail::references

(

)

Returns the messageID that this message is a reply to.

Definition at line ezmail.php.

eZMail::replyTo

(

)

Returns the receiver address.

Definition at line ezmail.php.

eZMail::sender

(

)

Returns the sender address.

Definition at line ezmail.php.

eZMail::senderText

(

)

Returns the sender address as text.

Definition at line ezmail.php.

References composeEmailName().

eZMail::setBccElements

(

$

newBcc

)

Sets the bcc addresses.

Definition at line ezmail.php.

eZMail::setBody

(

$

newBody

)

Sets the body.

Definition at line ezmail.php.

eZMail::setCcElements

(

$

newCc

)

Sets the cc addresses.

Definition at line ezmail.php.

eZMail::setExtraHeaders

(

$

headers

)

Sets the extra headers to $headers.

Definition at line ezmail.php.

References headers().

eZMail::setMessageID

(

$

newMessageID

)

Sets the message ID. This is a server setting only so BE CAREFULL WITH THIS.

Definition at line ezmail.php.

eZMail::setReceiver	(	$	email,
		$	name = false
	)

Sets the receiver address.

Note:: This will remove all other receivers

See also:: addReceiver, setReceiverElements

Definition at line ezmail.php.

References ReceiverElements.

eZMail::setReceiverElements

(

$

toElements

)

Sets the receiver addresses.

Definition at line ezmail.php.

References ReceiverElements.

eZMail::setReceiverText

(

$

text

)

Sets the receiver address, the email and name will be extracted from $text.

Note:: This will remove all other receivers

See also:: addReceiver, setReceiverElements

Definition at line ezmail.php.

References ReceiverElements.

eZMail::setReferences

(

$

newReference

)

Sets the messageID that this message is a reply to.

Definition at line ezmail.php.

eZMail::setReplyTo	(	$	email,
		$	name = false
	)

Sets the receiver address.

Definition at line ezmail.php.

eZMail::setSender	(	$	email,
		$	name = false
	)

Sets the sender address.

Definition at line ezmail.php.

eZMail::setSenderText

(

$

text

)

Sets the sender address, the email and name will be extracted from $text.

Definition at line ezmail.php.

eZMail::setSubject

(

$

newSubject

)

Sets the subject of the mail.

Definition at line ezmail.php.

& eZMail::splitList ( $ emails ) [static]

Splits a list of email addresses into an array where each entry is an email address.

Definition at line ezmail.php.

eZMail::stripEmail ( $ address ) [static]

Static function for extracting an e-mail from text

Returns the first valid e-mail in address, returns false if no e-mail addresses found

Definition at line ezmail.php.

eZMail::subject

(

)

Returns the subject.

Definition at line ezmail.php.

eZMail::validate ( $ address ) [static]

Static function for validating e-mail addresses.

Returns true if successful, false if not.

Definition at line ezmail.php.

Referenced by eZAuthorType::validateObjectAttributeHTTPInput().

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

ezmail.php

Exponential Copyright © 1998 - 2026 7x