eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZMail

class eZMail

Constants

REGEXP

Properties

$ReceiverElements
$From
$CcElements
$BccElements
$ContentType
$UserAgent
$ReplyTo
$Subject
$BodyText
$ExtraHeaders
$TextCodec
$MessageID
$MIMEVersion
ezcMail $Mail Contains an object of type ezcMail, which is used to store the mail elements like subject, to, from, body etc, instead of using the existing class variables ($Subject, $From, $receiversElements, $BodyText etc).

Methods

eZMail()

receiverEmailText($convert = true)

receiverText($convert = true)

ccReceiverTextList($convert = true)

bccReceiverTextList($convert = true)

receiverTextList($convert = true)

receiverElements()

ccElements()

bccElements()

replyTo($convert = true)

sender($convert = true)

senderText($convert = true)

mimeVersion()

contentType()

contentCharset()

contentTransferEncoding()

contentDisposition()

userAgent($convert = true)

setMIMEVersion($version)

setContentType($type = false, $charset = false, $transferEncoding = false, $disposition = false, $boundary = false)

setUserAgent($agent)

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()

addExtraHeader($headerName, $headerValue)

setExtraHeader($headerName, $headerValue)

setExtraHeaders($headers)

messageID()

setMessageID($newMessageID)

references()

setReferences($newReference)

subject($convert = true)

setSubject($newSubject)

body($convert = true)

setBody($newBody)

composeEmailName($item, $key = false, $convert = true)

composeEmailItems($items, $join = true, $key = false, $convert = true)

headers($parameters = array())

headerTextList($parameters = array())

headerText($parameters = array())

convertHeaderText($text)

encodeMimeHeader($str)

convertText($text, $isHeader = false)

isAllowedCharset($charset)

allowedCharsets()

usedCharset()

outputCharset()

Details

at line 66
public eZMail()

at line 103
public receiverEmailText($convert = true)

Parameters

$convert

at line 121
public receiverText($convert = true)

Parameters

$convert

at line 132
public ccReceiverTextList($convert = true)

Parameters

$convert

at line 148
public bccReceiverTextList($convert = true)

Parameters

$convert

at line 166
public receiverTextList($convert = true)

Parameters

$convert

at line 184
public receiverElements()

at line 202
public ccElements()

at line 220
public bccElements()

at line 239
public replyTo($convert = true)

Parameters

$convert

at line 252
public sender($convert = true)

Parameters

$convert

at line 280
public senderText($convert = true)

Parameters

$convert

at line 295
public mimeVersion()

at line 306
public contentType()

at line 318
public contentCharset()

at line 328
public contentTransferEncoding()

at line 339
public contentDisposition()

at line 351
public userAgent($convert = true)

Parameters

$convert

at line 364
public setMIMEVersion($version)

Parameters

$version

at line 376
public setContentType($type = false, $charset = false, $transferEncoding = false, $disposition = false, $boundary = false)

Parameters

$type
$charset
$transferEncoding
$disposition
$boundary

at line 409
public setUserAgent($agent)

Parameters

$agent

at line 420
public setReceiverElements($toElements)

Parameters

$toElements

at line 438
public setReceiver($email, $name = false)

Parameters

$email
$name

at line 452
public setReceiverText($text)

Parameters

$text

at line 465
public addReceiver($email, $name = false)

Parameters

$email
$name

at line 477
public setReplyTo($email, $name = false)

Parameters

$email
$name

at line 489
public setSender($email, $name = false)

Parameters

$email
$name

at line 501
public setSenderText($text)

Parameters

$text

at line 514
public setCcElements($newCc)

Parameters

$newCc

at line 530
public addCc($email, $name = false)

Parameters

$email
$name

at line 542
public setBccElements($newBcc)

Parameters

$newBcc

at line 558
public addBcc($email, $name = false)

Parameters

$email
$name

at line 570
public extraHeaders()

at line 580
public addExtraHeader($headerName, $headerValue)

Parameters

$headerName
$headerValue

at line 592
public setExtraHeader($headerName, $headerValue)

Parameters

$headerName
$headerValue

at line 614
public setExtraHeaders($headers)

Parameters

$headers

at line 626
public messageID()

at line 637
public setMessageID($newMessageID)

Parameters

$newMessageID

at line 648
public references()

at line 658
public setReferences($newReference)

Parameters

$newReference

at line 668
public subject($convert = true)

Parameters

$convert

at line 681
public setSubject($newSubject)

Parameters

$newSubject

at line 693
public body($convert = true)

Parameters

$convert

at line 706
public setBody($newBody)

Parameters

$newBody

at line 824
public composeEmailName($item, $key = false, $convert = true)

Parameters

$item
$key
$convert

at line 846
public composeEmailItems($items, $join = true, $key = false, $convert = true)

Parameters

$items
$join
$key
$convert

at line 872
public headers($parameters = array())

Parameters

$parameters

at line 999
public headerTextList($parameters = array())

Parameters

$parameters

at line 1022
public headerText($parameters = array())

Parameters

$parameters

at line 1046
public convertHeaderText($text)

Parameters

$text

at line 1062
public encodeMimeHeader($str)

Parameters

$str

at line 1100
public convertText($text, $isHeader = false)

Parameters

$text
$isHeader

at line 1121
public isAllowedCharset($charset)

Parameters

$charset

at line 1139
public allowedCharsets()

at line 1151
public usedCharset()

at line 1164
public outputCharset()