PHP Class Pop\Mail\Message

Author: Nick Sagona, III ([email protected])
Mostra file Open project: nicksagona/PopPHP Class Usage Examples

Protected Properties

Property Type Description
$charset string Character set
$eol string EOL property
$html string HTML part of the message body
$mail Message Mail object
$message string Message body
$mimeBoundary string MIME boundary
$text string Text part of the message body

Public Methods

Method Description
__construct ( Mail $mail ) : Message Constructor
getBoundary ( ) : string Get MIME boundary
getCharset ( ) : string Get character set
getEol ( ) : string Get EOL
getHtml ( ) : string Get HTML part of the message.
getMessage ( ) : string Get the message.
getText ( ) : string Get text part of the message.
init ( ) : Message Initialize the email message.
setBoundary ( string $bnd = null ) : Message Set MIME boundary
setCharset ( string $chr ) : Message Set character set
setEol ( string $eol = Mail::CRLF ) : Mail Set EOL
setHtml ( string $html ) : Message Set HTML part of the message.
setText ( string $text ) : Message Set text part of the message.

Protected Methods

Method Description
getMessageType ( ) : string Get message type.

Method Details

__construct() public method

Instantiate the message object.
public __construct ( Mail $mail ) : Message
$mail Mail
return Message

getBoundary() public method

Get MIME boundary
public getBoundary ( ) : string
return string

getCharset() public method

Get character set
public getCharset ( ) : string
return string

getEol() public method

Get EOL
public getEol ( ) : string
return string

getHtml() public method

Get HTML part of the message.
public getHtml ( ) : string
return string

getMessage() public method

Get the message.
public getMessage ( ) : string
return string

getMessageType() protected method

Get message type.
protected getMessageType ( ) : string
return string

getText() public method

Get text part of the message.
public getText ( ) : string
return string

init() public method

Initialize the email message.
public init ( ) : Message
return Message

setBoundary() public method

Set MIME boundary
public setBoundary ( string $bnd = null ) : Message
$bnd string
return Message

setCharset() public method

Set character set
public setCharset ( string $chr ) : Message
$chr string
return Message

setEol() public method

Set EOL
public setEol ( string $eol = Mail::CRLF ) : Mail
$eol string
return Mail

setHtml() public method

Set HTML part of the message.
public setHtml ( string $html ) : Message
$html string
return Message

setText() public method

Set text part of the message.
public setText ( string $text ) : Message
$text string
return Message

Property Details

$charset protected_oe property

Character set
protected string $charset
return string

$eol protected_oe property

EOL property
protected string $eol
return string

$html protected_oe property

HTML part of the message body
protected string $html
return string

$mail protected_oe property

Mail object
protected Message,Pop\Mail $mail
return Message

$message protected_oe property

Message body
protected string $message
return string

$mimeBoundary protected_oe property

MIME boundary
protected string $mimeBoundary
return string

$text protected_oe property

Text part of the message body
protected string $text
return string