\Pop\MailMessage

__construct()

__construct(string  $subject = null) 

Constructor

Instantiate the message object

Parameters

addHeader()

addHeader(string  $header, string  $value) : \Pop\Mail\Message\AbstractMessage

Add message part header

Parameters

Returns

addHeaders()

addHeaders(array  $headers) : \Pop\Mail\Message\AbstractMessage

Add message part headers

Parameters

Returns

hasHeader()

hasHeader(string  $header) : boolean

Determine if message part has header

Parameters

Returns

getHeader()

getHeader(string  $header) : string

Get message part header

Parameters

Returns

getHeaders()

getHeaders() : array

Get all message part headers

Returns

getContentType()

getContentType() : string

Get message part content type

Returns

getCharSet()

getCharSet() : string

Get message part character set

Returns

setContentType()

setContentType(string  $contentType) : \Pop\Mail\Message\AbstractMessage

Set message part content type

Parameters

Returns

setCharSet()

setCharSet(string  $charSet = null) : \Pop\Mail\Message\AbstractMessage

Set message part character set

Parameters

Returns

getHeaderAsString()

getHeaderAsString(string  $header) : string

Get header as string

Parameters

Returns

getHeadersAsString()

getHeadersAsString(array  $omitHeaders = array()) : string

Get all message headers as string

Parameters

Returns

setIdHeader()

setIdHeader(string  $header) : \Pop\Mail\Message\AbstractMessage

Set the ID header name

Parameters

Returns

getIdHeader()

getIdHeader() : string

Get the ID

Returns

setId()

setId(string  $id) : \Pop\Mail\Message\AbstractMessage

Set the ID

Parameters

Returns

getId()

getId() : string

Get the ID

Returns

generateId()

generateId() : string

Generate a new ID

Returns

getBody()

getBody() : string

Get message body

Returns

render()

render(array  $omitHeaders = array()) : string

Render message

Parameters

Returns

renderAsLines()

renderAsLines(array  $omitHeaders = array()) : array

Render as an array of lines

Parameters

Returns

__toString()

__toString() : string

Render message to string

Returns

load()

load(string  $message) : \Pop\Mail\Message

Load a message from a string source or file on disk

Parameters

Throws

\Pop\Mail\Exception

Returns

setSubject()

setSubject(string  $subject) : \Pop\Mail\Message\AbstractMessage

Set Subject

Parameters

Returns

setTo()

setTo(string  $to) : \Pop\Mail\Message\AbstractMessage

Set To

Parameters

Returns

setCc()

setCc(string  $cc) : \Pop\Mail\Message\AbstractMessage

Set CC

Parameters

Returns

setBcc()

setBcc(string  $bcc) : \Pop\Mail\Message\AbstractMessage

Set BCC

Parameters

Returns

setFrom()

setFrom(string  $from) : \Pop\Mail\Message\AbstractMessage

Set From

Parameters

Returns

setReplyTo()

setReplyTo(string  $replyTo) : \Pop\Mail\Message\AbstractMessage

Set Reply-To

Parameters

Returns

setSender()

setSender(mixed  $sender) : \Pop\Mail\Message\AbstractMessage

Set Sender

Parameters

Returns

setReturnPath()

setReturnPath(mixed  $returnPath) : \Pop\Mail\Message\AbstractMessage

Set Return-Path

Parameters

Returns

setBody()

setBody(mixed  $body) : \Pop\Mail\Message

Set body

Parameters

Returns

addText()

addText(mixed  $text) : \Pop\Mail\Message

Add text message part

Parameters

Returns

addHtml()

addHtml(mixed  $html) : \Pop\Mail\Message

Add HTML message part

Parameters

Returns

attachFile()

attachFile(string  $file, string  $encoding = \Pop\Mail\Message\AbstractPart::BASE64) : \Pop\Mail\Message

Attach file message part

Parameters

Returns

attachFileFromStream()

attachFileFromStream(string  $stream, string  $basename = 'file.tmp', string  $encoding = \Pop\Mail\Message\AbstractPart::BASE64) : \Pop\Mail\Message

Attach file message part from stream

Parameters

Returns

addPart()

addPart(\Pop\Mail\Message\PartInterface  $part) : \Pop\Mail\Message

Add message part

Parameters

Returns

removeHeader()

removeHeader(string  $header) : \Pop\Mail\Message

Remove header

Parameters

Returns

getSubject()

getSubject() : string

Get subject

Returns

getTo()

getTo() : array

Get To

Returns

getCc()

getCc() : array

Get CC

Returns

getBcc()

getBcc() : array

Get BCC

Returns

getFrom()

getFrom() : array

Get From

Returns

getReplyTo()

getReplyTo() : array

Get Reply-To

Returns

getSender()

getSender() : array

Get Sender

Returns

getReturnPath()

getReturnPath() : array

Get Return-Path

Returns

getBoundary()

getBoundary() : string

Get message MIME boundary

Returns

getPart()

getPart(integer  $i) : \Pop\Mail\Message\PartInterface

Get message part

Parameters

Returns

getParts()

getParts() : array

Get message parts

Returns

setBoundary()

setBoundary(string  $boundary) : \Pop\Mail\Message

Set message MIME boundary

Parameters

Returns

generateBoundary()

generateBoundary() : \Pop\Mail\Message

Generate message MIME boundary

Returns

save()

save(string  $to, array  $omitHeaders = array()) : void

Save message to file on disk

Parameters

toByteStream()

toByteStream(\Pop\Mail\Transport\Smtp\Stream\BufferInterface  $is, array  $omitHeaders = array()) 

Write this entire entity to a buffer

Parameters

parseFromFile()

parseFromFile(string  $file) : \Pop\Mail\Message

Parse message from file

Parameters

Throws

\Pop\Mail\Exception

Returns

parse()

parse(string  $stream) : \Pop\Mail\Message

Parse message from string

Parameters

Throws

\Pop\Mail\Exception

Returns

decodeText()

decodeText(string  $text) : string

Decode text

Parameters

Returns

parseAddresses()

parseAddresses(mixed  $addresses, boolean  $asArray = false) : string

Parse addresses

Parameters

Returns

parseNameAndEmail()

parseNameAndEmail(string  $address) : array

Parse a name and email from an address string

Parameters

Returns

__clone()

__clone() : void

Perform a "deep" clone of a message object

getRandomId()

getRandomId() : string

Returns a random ID

Returns

validateContentType()

validateContentType() : void

Validate content type based on message parts added to the message