Tina4Stack  v1.0.1
The Tina4 Stack
Emma Class Reference

Public Member Functions

 __construct ($bulkSMSUsername="", $bulkSMSPassword="")
 
 sendMail ($recipient, $subject, $message, $fromName, $fromAddress, $attachments=null)
 
 prepareHtmlMail ($html, $eol, $boundary_rel, $boundary_alt)
 
 sendText ($mobileno, $message="", $countryPrefix="01")
 
 sendSMS ($mobileno, $message="", $countryPrefix="27")
 
 formatMobile ($celno, $countryPrefix="27")
 

Detailed Description

Emma is part of the Tina4 stack which allows you to easily send emails from your system without crazy configuration, emma can also read emails from an inbox you may have

Todo:
Add the ability to parse email addresses

Constructor & Destructor Documentation

Emma::__construct (   $bulkSMSUsername = "",
  $bulkSMSPassword = "" 
)

Constructor for Emma

Todo:
Add the ability to talk to a specific email server

Member Function Documentation

Emma::formatMobile (   $celno,
  $countryPrefix = "27" 
)

Format the Mobile Number

Parameters
String$celnoMobile number to send with
String$countryPrefix1 - america, 27 - south africa
Returns
string
Emma::prepareHtmlMail (   $html,
  $eol,
  $boundary_rel,
  $boundary_alt 
)
Emma::sendMail (   $recipient,
  $subject,
  $message,
  $fromName,
  $fromAddress,
  $attachments = null 
)

A function that will send a confirmation email to the user.

The sendMail function takes on a number of params and sends and email to a receipient.

Parameters
String$recipientThis can be a String or Array, the Array should be ; delimited
String$subjectThe subject for the email
String$messageThe message to send to the Receipient
String$fromNameThe name of the person sending the message
String$fromAddressThe address of the person sending the message
String$attachmentsAn Array of file paths to be attached in the form array ( array( "filename", "path" ) )
Returns
String OK or Failed
Emma::sendSMS (   $mobileno,
  $message = "",
  $countryPrefix = "27" 
)

Send SMS

Parameters
String$mobileno
String$message
String$countryPrefix
Returns
String Result of SMS send
Emma::sendText (   $mobileno,
  $message = "",
  $countryPrefix = "01" 
)

Alias of send SMS

Parameters
$mobileno
string$message
string$countryPrefix

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