GemsTracker library API » \Gems

package	Gems
subpackage	Mail
copyright	Copyright (c) 2012 Erasmus MC
license	New BSD License
since	Class available since version 1.5.3

Methods

__construct()

__construct($charset = null)

Parameters

$charset

Adds To-header and recipient, $email can be an array, or a single string address

addTo(string|array $email, string $name = '', boolean $bounce = null) : \Zend_Mail

Parameters

$email

stringarray

$name

string

$bounce

boolean

When true the e-mail is bounced to the from address, when omitted bounce is read from project settings

Returns

\Zend_MailProvides fluent interface

Returns true if the "email.bounce" setting exists in the project configuration and is true

bounceCheck() : boolean

Returns

boolean

Returns \Zend_Mail_Transport_Abstract when something else than the default mail protocol should be used.

checkTransport(\email $from) : \Zend_Mail_Transport_Abstract

staticvar	array $mailServers

Parameters

$from

\email

address $from

Returns

\Zend_Mail_Transport_Abstractor null

Returns the the current template

getHtmlTemplate() : string

Returns

string

send()

send($transport = null)

Parameters

$transport

Set the template using style as basis

setTemplateStyle(string $style = null) : \MUtil_Mail

Parameters

$style

string

Returns

\MUtil_Mail(continuation pattern)

Properties

$escort

$escort : \GemsEscort

Default

null

Mail character set

$_charset : string

Default

'utf-8'

For Gems we use utf-8 as default instead op iso-8859-1

$db

$db : \Zend_Db_Adapter_Abstract

Default

$mailServers

$mailServers

Default

array()

Static

$project

$project : \Gems_Project_ProjectSettings

Default

Constants

MAIL_NO_ENCRYPT

MAIL_NO_ENCRYPT = 0

MAIL_SSL

MAIL_SSL = 1

MAIL_TLS

MAIL_TLS = 2