Sponsorenverwaltung - Team StarCraft e.V.
 All Data Structures Files Functions Variables
UserCakeMail Class Reference

This class provides methods to load, parse and send prepared email-templates. More...

Public Member Functions

 newTemplateMsg ($templateName, $additionalHooks)
 
 sendMail ($emailAddress, $subject, $msg=NULL)
 

Data Fields

 $contents = NULL
 The content of the message. More...
 

Detailed Description

This class provides methods to load, parse and send prepared email-templates.

This class provides methods to load, parse and send prepared email-templates. It uses phps mail-function. The current version is configured to send emails in ISO-8859-1 encoding.

This class is largely based on the class UserCakeMail from Usercake (Version 2.0.2)

Version
1.0.0
Author
UserCake (http://www.usercake.com)
Date
02.07.2013

Definition at line 38 of file class.mail.php.

Member Function Documentation

newTemplateMsg (   $templateName,
  $additionalHooks 
)

Function used for replacing hooks in our templates

Parameters
string$templateName
array$additionalHooks
Returns
boolean
  • TRUE if loading and parsing the email-template worked properly
  • FALSE if errors occured while loading the template
Author
Usercake (http://www.usercake.com)

Definition at line 52 of file class.mail.php.

References $mail_templates_dir, ABS_PATH, and replaceDefaultHook().

+ Here is the call graph for this function:

sendMail (   $emailAddress,
  $subject,
  $msg = NULL 
)

Function for sending previously prepared message

Parameters
string$emailAddressthe email-address of the receiver
string$subjectthe subject of the message
string$msg[optional] the content of the message
  • Default: NULL, if unchanged the $contents variable of the corresponding UserCakeMail-object will be used.
Returns
boolean
  • TRUE if the mail was successfully accepted for delivery
  • FALSE otherwise.
Author
Usercake (http://www.usercake.com)

Definition at line 87 of file class.mail.php.

References $contents, $emailAddress, and $websiteName.

Field Documentation

$contents = NULL

The content of the message.

Definition at line 41 of file class.mail.php.

Referenced by sendMail().


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