FileAccess Orion

MailSender
in

Define mail sender method

Tags
category

Interface function

author

Tobias Teichner webmaster@teichner.biz

since

File available since v0.104

Table of Contents

AddAttachment()  : bool
Add an attachment Add attachment to mail
AddEmbeddedImage()  : string|bool
Add an image Add internal embedded image to this mail
GetDefaultSettings()  : Result
load defaults load the default settings for this delivery method
GetFormPreset()  : Result
preset load the common pickup settings preset for generation a form
GetSettings()  : Result
get load the common pickup settings object
SendInterface()  : Result
Get the mailer Get the mailer instance and handle further operations
StoreSettings()  : Result
Save the common pickup settings object
Subject()  : void
Override the subject before sending

Methods

AddAttachment()

Add an attachment Add attachment to mail

public AddAttachment(string $path, string $name) : bool
Parameters
$path : string

Absolute path to file

$name : string

Speaking name

Return values
bool —

The add result

AddEmbeddedImage()

Add an image Add internal embedded image to this mail

public AddEmbeddedImage(string $path, string $id) : string|bool
Parameters
$path : string

Absolute path to file

$id : string

Reference id

Return values
string|bool —

The add result

GetDefaultSettings()

load defaults load the default settings for this delivery method

public GetDefaultSettings() : Result
Return values
Result —

$result A system result object

GetFormPreset()

preset load the common pickup settings preset for generation a form

public GetFormPreset() : Result
Return values
Result —

$result A system result object

GetSettings()

get load the common pickup settings object

public GetSettings() : Result
Return values
Result —

$result A system result object

SendInterface()

Get the mailer Get the mailer instance and handle further operations

public SendInterface(Email $mail) : Result
Parameters
$mail : Email

The mail to send

Return values
Result —

StoreSettings()

Save the common pickup settings object

public StoreSettings(object $values) : Result
Parameters
$values : object

The configuration values

Return values
Result —

$result A system result object

Subject()

Override the subject before sending

public Subject(string $subject) : void
Parameters
$subject : string
Return values
void —

Search results