Class lispa\amos\emailmanager\base\AmosEmailManager

All Classes | Properties | Methods | Constants
Inheritancelispa\amos\emailmanager\base\AmosEmailManager
Implementslispa\amos\emailmanager\interfaces\ManagerInterface

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$defaultLayout lispa\amos\emailmanager\base\AmosEmailManager
$defaultTemplate string The default layout to use for template emails. lispa\amos\emailmanager\base\AmosEmailManager
$defaultTransport string The default transport to use. lispa\amos\emailmanager\base\AmosEmailManager
$templateFields array List of template parts that will be rendered. lispa\amos\emailmanager\base\AmosEmailManager
$templatePath lispa\amos\emailmanager\base\AmosEmailManager
$templateType string Template type, can be "db" or "php". lispa\amos\emailmanager\base\AmosEmailManager
$transports lispa\amos\emailmanager\interfaces\TransportInterface[] lispa\amos\emailmanager\base\AmosEmailManager

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() lispa\amos\emailmanager\base\AmosEmailManager
buildTemplateMessage() lispa\amos\emailmanager\base\AmosEmailManager
getDefaultLayout() lispa\amos\emailmanager\base\AmosEmailManager
getDefaultTemplate() lispa\amos\emailmanager\base\AmosEmailManager
getTemplatePath() lispa\amos\emailmanager\base\AmosEmailManager
getTemplateType() lispa\amos\emailmanager\base\AmosEmailManager
queue() Sends email message queue using default transport lispa\amos\emailmanager\base\AmosEmailManager
send() Sends email message immediately using default transport lispa\amos\emailmanager\base\AmosEmailManager
setDefaultLayout() lispa\amos\emailmanager\base\AmosEmailManager
setDefaultTemplate() lispa\amos\emailmanager\base\AmosEmailManager
setTemplatePath() lispa\amos\emailmanager\base\AmosEmailManager
setTemplateType() lispa\amos\emailmanager\base\AmosEmailManager
spool() lispa\amos\emailmanager\base\AmosEmailManager

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
EMAILED 'emailed' lispa\amos\emailmanager\base\AmosEmailManager
ERROR 'error' lispa\amos\emailmanager\base\AmosEmailManager
PENDING 'pending' lispa\amos\emailmanager\base\AmosEmailManager
PROCESSING 'processing' lispa\amos\emailmanager\base\AmosEmailManager

Property Details

$defaultLayout public property
public $defaultLayout = "layout_fancy"
$defaultTemplate public property

The default layout to use for template emails.

public string $defaultTemplate = "layout_default"
$defaultTransport public property

The default transport to use.

public string $defaultTransport = 'mail'
$templateFields public property

List of template parts that will be rendered.

public array $templateFields = ['subject', 'heading', 'message']
$templatePath public property
public $templatePath = "/emails/"
$templateType public property

Template type, can be "db" or "php".

public string $templateType = "php"
$transports public property
public lispa\amos\emailmanager\interfaces\TransportInterface[] $transports = []

Method Details

__construct() public method

public void __construct ( )
buildTemplateMessage() public method

public \lispa\amos\emailmanager\base\type buildTemplateMessage ( $template, $viewParams = [], $layout = null )
$template \lispa\amos\emailmanager\base\type
$viewParams \lispa\amos\emailmanager\base\type
$layout \lispa\amos\emailmanager\base\type
getDefaultLayout() public method

public \lispa\amos\emailmanager\base\type getDefaultLayout ( )
getDefaultTemplate() public method

public \lispa\amos\emailmanager\base\type getDefaultTemplate ( )
getTemplatePath() public method

public \lispa\amos\emailmanager\base\type getTemplatePath ( )
getTemplateType() public method

public \lispa\amos\emailmanager\base\type getTemplateType ( )
queue() public method

Sends email message queue using default transport

public boolean queue ( $from, $to, $subject, $text, array $files = [], array $bcc = [], $params = [], $priority = 0 )
$from string

Format accepted:

1) 'example@example.com' 2) 'example@example.com alias' the method considers the email address up to the first space, everything that follows is considered alias.
$to string
$subject string
$text string
$files array
$bcc array
$params
$priority integer
send() public method

Sends email message immediately using default transport

public boolean send ( $from, $to, $subject, $text, array $files = [], array $bcc = [], $params = [], $save_in_queue = true )
$from string

Format accepted:

1) 'example@example.com' 2) 'example@example.com alias' the method considers the email address up to the first space, everything that follows is considered alias.
$to string|array
$subject string
$text string
$files array
$bcc array|string
$params
$save_in_queue
setDefaultLayout() public method

public void setDefaultLayout ( $layout )
$layout \lispa\amos\emailmanager\base\type
setDefaultTemplate() public method

public void setDefaultTemplate ( $tamplate )
$tamplate \lispa\amos\emailmanager\base\type
setTemplatePath() public method

public void setTemplatePath ( $path )
$path \lispa\amos\emailmanager\base\type
setTemplateType() public method

public void setTemplateType ( $templateType )
$templateType \lispa\amos\emailmanager\base\type
spool() public method

public integer spool ( $limit = 1000 )
$limit integer