Documentation

Mailer extends Sand
in package

Build & Send email Sestaví a odešle mail.

Tags
author

Vitex vitex@hippy.cz

Table of Contents

$crLf  : string
Line divider
$data  : array|null
Common object data holder.
$debug  : bool
Flag debugovacího režimu.
$easeShared  : Shared
Sdílený objekt frameworku.
$emailAddress  : string
Adresa odesilatele zprávy.
$emailSubject  : string
Email subject holder
$finalized  : bool
$frameworkVersion  : string
Version of EasePHP Framework
$fromEmailAddress  : string
Emailová adresa odesilatele.
$langCode  : string
Default Language Code.
$logger  : Regent
Objekt pro logování.
$mailBody  : array
$mailer  : Mail
Objekt pro odesílání pošty.
$mailHeaders  : array
Mail Headers
$mailHeadersDone  : array
Processed Headers
$mimer  : Mail_mime
MIME Helper
$notify  : bool
Zobrazovat uživateli informaci o odeslání zprávy ?
$objectName  : string
Object name place
$parameters  : array
Parametry odchozí pošty.
$parentObject  : Sand|mixed
Odkaz na vlastnící objekt.
$sendResult  : bool
Byla již zpráva odeslána ?
$textBody  : string
__construct()  : mixed
Ease Mail - sestaví a odešle.
__toString()  : string
Magická funkce pro všechny potomky.
addFile()  : bool|PEAR_Error
Připojí k mailu přílohu ze souboru.
addStatusMessage()  : bool
Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.
cleanSatatusMessages()  : bool
Erase all status messages
dataReset()  : mixed
Vynuluje všechny pole vlastností objektu.
draw()  : string
Default Draw method.
getData()  : array
Obtain data holded by object
getDataCount()  : int
Vrací počet položek dat objektu.
getDataValue()  : mixed
Vrací hodnotu z pole dat pro MySQL.
getLogger()  : Regent
Provide logger object
getMailHeader()  : string|null
Obtain mail header content
getObjectName()  : string
Vrací jméno objektu.
getStatusMessages()  : array
Obtain global status messages
logBanner()  : mixed
Add Info about used PHP and EasePHP Library
send()  : mixed
Send mail.
setData()  : int
Načte $data do polí objektu.
setDataValue()  : bool
Set data filed value
setMailBody()  : bool|Pear_Err
Set mail text body
setMailHeaders()  : bool
Nastaví hlavičky mailu.
setObjectName()  : string
Set object name
setupProperty()  : mixed
Set up one of properties by 1) array 2) ENV 3) Constant
setUserNotification()  : mixed
Nastaví návěští uživatelské notifikace.
takeData()  : int
Převezme data do aktuálního pole dat.
unsetDataValue()  : bool
Odstrani polozku z pole dat pro MySQL.

Properties

$crLf

Line divider

public string $crLf = " "

$data

Common object data holder.

public array|null $data = null

$debug

Flag debugovacího režimu.

public bool $debug = false

$easeShared

Sdílený objekt frameworku.

public Shared $easeShared = null

$emailAddress

Adresa odesilatele zprávy.

public string $emailAddress = 'postmaster@localhost'

$emailSubject

Email subject holder

public string $emailSubject = null

$finalized

public bool $finalized = false

$frameworkVersion

Version of EasePHP Framework

public static string $frameworkVersion = '0.5'

$fromEmailAddress

Emailová adresa odesilatele.

public string $fromEmailAddress = null

$langCode

Default Language Code.

public string $langCode = null

$mailBody

public array $mailBody = null

$mailer

Objekt pro odesílání pošty.

public Mail $mailer = null

$mailHeaders

Mail Headers

public array $mailHeaders = []

$mailHeadersDone

Processed Headers

public array $mailHeadersDone = []

$mimer

MIME Helper

public Mail_mime $mimer = null

$notify

Zobrazovat uživateli informaci o odeslání zprávy ?

public bool $notify = true

$objectName

Object name place

public string $objectName = 'Molecule'

$parameters

Parametry odchozí pošty.

public array $parameters = []

$parentObject

Odkaz na vlastnící objekt.

public Sand|mixed $parentObject = null

$sendResult

Byla již zpráva odeslána ?

public bool $sendResult = false

$textBody

public string $textBody = null

Methods

__construct()

Ease Mail - sestaví a odešle.

public __construct(string $emailAddress, string $mailSubject[, mixed $emailContents = null ]) : mixed
Parameters
$emailAddress : string

adresa

$mailSubject : string

předmět

$emailContents : mixed = null

tělo - libovolný mix textu a EaseObjektů

Return values
mixed

__toString()

Magická funkce pro všechny potomky.

public __toString() : string
Return values
string

addFile()

Připojí k mailu přílohu ze souboru.

public addFile(string $filename[, string $mimeType = 'text/plain' ]) : bool|PEAR_Error
Parameters
$filename : string

cesta/název souboru k přiložení

$mimeType : string = 'text/plain'

MIME typ přílohy

Return values
bool|PEAR_Error

addStatusMessage()

Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.

public addStatusMessage(string $message[, string $type = 'info' ][, string $caller = null ]) : bool
Parameters
$message : string

text zpravy

$type : string = 'info'

fronta

$caller : string = null

Message source name

Return values
bool

message added

cleanSatatusMessages()

Erase all status messages

public cleanSatatusMessages() : bool
Return values
bool

dataReset()

Vynuluje všechny pole vlastností objektu.

public dataReset() : mixed
Return values
mixed

draw()

Default Draw method.

public draw() : string
Return values
string

getData()

Obtain data holded by object

public getData() : array
Return values
array

getDataCount()

Vrací počet položek dat objektu.

public getDataCount() : int
Return values
int

getDataValue()

Vrací hodnotu z pole dat pro MySQL.

public getDataValue(string $columnName) : mixed
Parameters
$columnName : string

název hodnoty/sloupečku

Return values
mixed

getLogger()

Provide logger object

public getLogger([string|array $options = null ]) : Regent
Parameters
$options : string|array = null
Return values
Regent

getMailHeader()

Obtain mail header content

public getMailHeader(string $headername) : string|null
Parameters
$headername : string

requested header name

Return values
string|null

requested header value

getObjectName()

Vrací jméno objektu.

public getObjectName() : string
Return values
string

getStatusMessages()

Obtain global status messages

public getStatusMessages() : array
Return values
array

logBanner()

Add Info about used PHP and EasePHP Library

public logBanner([string $prefix = null ][, string $suffix = null ]) : mixed
Parameters
$prefix : string = null

banner prefix text

$suffix : string = null

banner suffix text

Return values
mixed

send()

Send mail.

public send() : mixed
Return values
mixed

setData()

Načte $data do polí objektu.

public setData(array $data[, bool $reset = false ]) : int
Parameters
$data : array

asociativní pole dat

$reset : bool = false

vyprazdnit pole před naplněním ?

Return values
int

počet načtených položek

setDataValue()

Set data filed value

public setDataValue(string $columnName, mixed $value) : bool
Parameters
$columnName : string

název datové kolonky

$value : mixed

hodnota dat

Return values
bool

Success

setMailBody()

Set mail text body

public setMailBody(string $text) : bool|Pear_Err
Parameters
$text : string
Return values
bool|Pear_Err

setMailHeaders()

Nastaví hlavičky mailu.

public setMailHeaders(mixed $mailHeaders) : bool
Parameters
$mailHeaders : mixed

asociativní pole hlaviček

Return values
bool

true pokud byly hlavičky nastaveny

setObjectName()

Set object name

public setObjectName([string $objectName = null ]) : string
Parameters
$objectName : string = null
Return values
string

Jméno objektu

setupProperty()

Set up one of properties by 1) array 2) ENV 3) Constant

public setupProperty(array $options, string $name[, string $constant = false ]) : mixed
Parameters
$options : array

array of given availble properties

$name : string

name of property to set up

$constant : string = false

load default property value from constant / ENV

Return values
mixed

setUserNotification()

Nastaví návěští uživatelské notifikace.

public setUserNotification(bool $notify) : mixed
Parameters
$notify : bool

požadovaný stav notifikace

Return values
mixed

takeData()

Převezme data do aktuálního pole dat.

public takeData(array $data) : int
Parameters
$data : array

asociativní pole dat

Return values
int

unsetDataValue()

Odstrani polozku z pole dat pro MySQL.

public unsetDataValue(string $columnName) : bool
Parameters
$columnName : string

název klíče k vymazání

Return values
bool

success

Search results