Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
Elgg\EmailService Class Reference

WARNING: API IN FLUX. More...

Public Member Functions

 __construct (Config $config, PluginHooksService $hooks, TransportInterface $mailer, LoggerInterface $logger)
 Constructor. More...
 
 send (Email $email)
 Sends an email. More...
 
 transport (Email $email)
 Transports an email. More...
 

Protected Member Functions

 buildMessageBody (Email $email)
 Build the body part of the e-mail message. More...
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Use the elgg_* versions instead.

Definition at line 23 of file EmailService.php.

Constructor & Destructor Documentation

Elgg\EmailService::__construct ( Config  $config,
PluginHooksService  $hooks,
TransportInterface  $mailer,
LoggerInterface  $logger 
)

Constructor.

Parameters
Config$configConfig
PluginHooksService$hooksHook registration service
TransportInterface$mailerMailer
LoggerInterface$loggerLogger

Definition at line 50 of file EmailService.php.

Member Function Documentation

Elgg\EmailService::buildMessageBody ( Email  $email)
protected

Build the body part of the e-mail message.

Parameters
Email$emailEmail
Returns
Exceptions

Definition at line 175 of file EmailService.php.

Elgg\EmailService::send ( Email  $email)

Sends an email.

Parameters
Email$emailEmail
Returns
bool
Exceptions
RuntimeException

Definition at line 65 of file EmailService.php.

Elgg\EmailService::transport ( Email  $email)

Transports an email.

Parameters
Email$emailEmail
Returns
bool
Exceptions
RuntimeException

Definition at line 92 of file EmailService.php.


The documentation for this class was generated from the following file: