Documentation

Mailer extends Sand
in package

Build & Send email Builds and sends the email.

Tags
author

Vitex vitex@hippy.cz

Table of Contents

$crLf  : string
Line divider
$data  : array<string|int, mixed>|null
Common object data holder.
$debug  : bool
Debug mode flag.
$easeShared  : Shared
Sdílený objekt frameworku.
$emailAddress  : string
The sender's address.
$emailSubject  : string
Email subject holder
$finalized  : bool
$fromEmailAddress  : string
The sender's email address.
$langCode  : string
Default Language Code.
$logger  : Regent|null
Objekt pro logování.
$mailBody  : array<string|int, mixed>
$mailer  : Mail
Object for mail sending.
$mailHeaders  : array<string|int, mixed>
Mail Headers
$mailHeadersDone  : array<string|int, mixed>
Processed Headers
$mimer  : Mail_mime
MIME Helper
$notify  : bool
Show information about sending the message to the user?
$objectName  : string
Object name
$parameters  : array<string|int, mixed>
Outgoing mail parameters.
$parentObject  : Sand|mixed
Odkaz na vlastnící objekt.
$sendResult  : bool
Has the message already been sent?
$textBody  : string
__construct()  : mixed
Ease Mail - builds and sends.
__toString()  : string
Magical function for all descendants (childern).
addFile()  : bool|PEAR_Error
Attaches file to mail
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.
addText()  : mixed
Add Text to mail
cleanSatatusMessages()  : bool
Erase all status messages
dataReset()  : mixed
Vynuluje všechny pole vlastností objektu.
draw()  : string
Default draw method.
getData()  : array<string|int, mixed>
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
Obtains mail header's content
getObjectName()  : string
Returns object name
getStatusMessages()  : array<string|int, mixed>
Obtain global status messages
logBanner()  : mixed
Add Info about used PHP and EasePHP Library
send()  : mixed
Sends mail.
setData()  : int
Načte $data do polí objektu.
setDataValue()  : bool
Set data filed value
setMailBody()  : bool|Pear_Err
Sets mail's text body
setMailHeaders()  : bool
Sets mail headers.
setObjectName()  : string
Set object name
setupProperty()  : mixed
Set up one of the properties by 1) array 2) ENV 3) Constant
setUserNotification()  : mixed
Sets the user notification label.
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 = "\n"

$data

Common object data holder.

public array<string|int, mixed>|null $data = null

$debug

Debug mode flag.

public bool $debug = false

$easeShared

Sdílený objekt frameworku.

public Shared $easeShared = null

$emailAddress

The sender's address.

public string $emailAddress = 'postmaster@localhost'

$emailSubject

Email subject holder

public string $emailSubject = null

$finalized

public bool $finalized = false

$fromEmailAddress

The sender's email address.

public string $fromEmailAddress = null

$langCode

Default Language Code.

public string $langCode = null

$mailBody

public array<string|int, mixed> $mailBody = ''

$mailer

Object for mail sending.

public Mail $mailer = null

$mailHeaders

Mail Headers

public array<string|int, mixed> $mailHeaders = []

$mailHeadersDone

Processed Headers

public array<string|int, mixed> $mailHeadersDone = []

$mimer

MIME Helper

public Mail_mime $mimer = null

$notify

Show information about sending the message to the user?

public bool $notify = true

$objectName

Object name

public string $objectName = 'Molecule'

$parameters

Outgoing mail parameters.

public array<string|int, mixed> $parameters = []

$parentObject

Odkaz na vlastnící objekt.

public Sand|mixed $parentObject = null

object

$sendResult

Has the message already been sent?

public bool $sendResult = false

$textBody

public string $textBody = null

Methods

__construct()

Ease Mail - builds and sends.

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

address

$mailSubject : string

subject

$emailContents : mixed = null

body - any text mix and EaseObjects

Return values
mixed —

__toString()

Magical function for all descendants (childern).

public __toString() : string
Return values
string —

addFile()

Attaches file to mail

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

path / file name to attach

$mimeType : string = 'text/plain'

MIME attachment type

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' ][, object $caller = null ]) : bool
Parameters
$message : string

text zpravy

$type : string = 'info'

fronta

$caller : object = null

Message source name

Return values
bool —

message added

addText()

Add Text to mail

public addText(string $text) : mixed
Parameters
$text : string
Return values
mixed —

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<string|int, mixed>
Return values
array<string|int, mixed> —

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<string|int, mixed> $options = null ]) : Regent
Parameters
$options : string|array<string|int, mixed> = null
Return values
Regent —

getMailHeader()

Obtains mail header's content

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

requested header name

Return values
string|null —

requested header value

getObjectName()

Returns object name

public getObjectName() : string
Return values
string —

getStatusMessages()

Obtain global status messages

public getStatusMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —

logBanner()

Add Info about used PHP and EasePHP Library

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

banner prefix text (default is APPName)

$suffix : string = ''

banner suffix text

Return values
mixed —

send()

Sends mail.

public send() : mixed
Return values
mixed —

setData()

Načte $data do polí objektu.

public setData(array<string|int, mixed> $data[, bool $reset = false ]) : int
Parameters
$data : array<string|int, mixed>

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

Sets mail's text body

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

setMailHeaders()

Sets mail headers.

public setMailHeaders(array<string|int, mixed> $mailHeaders) : bool
Parameters
$mailHeaders : array<string|int, mixed>

associative header array

Return values
bool —

true if the headers have been set

setObjectName()

Set object name

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

Object name

setupProperty()

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

public setupProperty(array<string|int, mixed> $options, string $name[, string $constant = '' ]) : mixed
Parameters
$options : array<string|int, mixed>

array of given availble properties

$name : string

name of property to set up

$constant : string = ''

load default property value from constant / ENV

Return values
mixed —

setUserNotification()

Sets the user notification label.

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

required notification status

Return values
mixed —

takeData()

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

public takeData(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>

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