Docs For Class SGL_Emailer

Description

Email builder.

author: Julien Casanova
author: Dmitri Lakachauskis <lakiboy83@gmail.com>

Located in /SGL/Emailer/Builder.php (line 13)

Class Constant Summary

MODE_HTML_AND_TEXT = 3

MODE_HTML_ONLY = 2

MODE_TEXT_ONLY = 1

Variable Summary

array $aHeaders

array $body

Method Summary

static array getMimeData (array $aOpts, array $aHeaders, [string $bodyTxt = ''], [string $bodyHtml = ''], [array $aAttachments = array()])

static array prepareHeaders (array $aOpts)

static string prepareHtmlBody (array $aOpts, [boolean $skipOutputVars = false])

static string prepareTxtBody (array $aOpts)

SGL_Emailer_Builder __construct (array $aDeliveryOpts, array $aTplOpts)

Variables

array $aHeaders = array() (line 27)

Headers suitable for PEAR::Mail.

access: public

array $body = '' (line 34)

Mail body suitable for PEAR::Mail.

access: public

Methods

static getMimeData (line 268)

Returns headers and body suitable for PEAR::Mail.

access: public

array getMimeData (array $aOpts, array $aHeaders, [string $bodyTxt = ''], [string $bodyHtml = ''], [array $aAttachments = array()])

array $aOpts
array $aHeaders
string $bodyTxt
string $bodyHtml
array $aAttachments

static prepareHeaders (line 151)

Returns proper mail headers from SGL options.

todo: it would be wise to standardize SGL options, to make possible array iteration
access: public

array prepareHeaders (array $aOpts)

array $aOpts

static prepareHtmlBody (line 233)

Loads HTML template.

access: public

string prepareHtmlBody (array $aOpts, [boolean $skipOutputVars = false])

array $aOpts
boolean $skipOutputVars

static prepareTxtBody (line 194)

Loads text template.

todo: replace PHP's Exception with SGL_Exception
throws: Exception
access: public

string prepareTxtBody (array $aOpts)

array $aOpts

Constructor __construct (line 47)

Creates proper headers and body to send with PEAR::Mail.

todo: remove outgoing email hack
todo: replace PHP's Exception with SGL_Exception
throws: Exception
access: public

SGL_Emailer_Builder __construct (array $aDeliveryOpts, array $aTplOpts)

array $aDeliveryOpts
array $aTplOpts

Class Constants

MODE_HTML_AND_TEXT = 3 (line 20)

MODE_HTML_ONLY = 2 (line 19)

MODE_TEXT_ONLY = 1 (line 18)

Available modes.