Communication Class Reference
[General]

Sends SMS and Email messages. More...

List of all members.

Public Member Functions
	Communication (iLock $sendLock_)
	Constructor.
	sendEmail ($from_, $toArr_, $subject_, $text_, $html_=NULL)
	Send an email.
	sendSms ($fromEmail_, $fromName_, $toArr_, $message_, $repeatTime_=60)
	Sends an SMS message to a mobile phone.
Private Attributes
	$_sendLock
	A lock object that will handle how often an SMS can be sent.

---

Detailed Description

Sends SMS and Email messages.

This class uses Rmail written by Richard Heyes at www.phpguru.org. The documentation can be found here. http://www.phpguru.org/downloads/Rmail/Rmail%20for%20PHP/docs.html

An installation of the Rmail package are included in fareofficelib, to minimize any hazzle getting fareofficelib up and working. But the copyright for Rmail is still owned by Richard Heyes.

Example: $sendLock = new FileLock('/tmp/locks/'); $communication = new Communication($sendLock); $communication->sendSms('monitor.fareoffice.com', '0731234567', 'Hello world);

Author:

Daniel Lindh <[email protected]>

Definition at line 24 of file Communication.class.php.

---

Member Function Documentation

Communication::Communication

(

iLock $

sendLock_

)

Constructor.

Parameters:

$sendLock_

- iLock - A lock object that will handle how often an SMS can be sent.

Definition at line 32 of file Communication.class.php.

  {
    $this->_sendLock = $sendLock_;
  }

Communication::sendEmail	(	$	from_,
		$	toArr_,
		$	subject_,
		$	text_,
		$	html_ = NULL
	)

Send an email.

Supports both plain text and html messages.

Parameters:

	$from_	- string - The from email address. Ie. info(at)example.com
	$toArr_	- array - The to email addresses, can be many. $toArr_[] = 'daniel(at)example.com'; $toArr_[] = 'support(at)example.com';
	$subject_	- string - The email subject.
	$text_	- string - The text part of the email.

An email can have both a text and an html part, the html part will be read if the email client supports html, or else the text part will be used.

This argument and/or $html needs to be used, if this argument is empty the $html_ will be used for the text part of the message but with striped html tags.

Parameters:

$html_

- string - The HTML part of the email.

Returns:

- string - errorMessage If sendEmail fails, an error message will be returned. If sendEmail succededs, false will be returned.

Definition at line 72 of file Communication.class.php.

Referenced by sendSms().

  {
    if (!empty($from_) && !empty($toArr_) && !empty($subject_) && (!empty($text_) || !empty($html_)))
    {
      $mail = new Rmail();

      if (!empty($html_))
      {
        if (empty($text_))
        {
          $text_ = strip_tags($html_);
        }

        $mail->setHTML($html_, $text_);
      }
      else
      {
        $mail->setText($text_);
      }

      $mail->setReturnPath($from_);
      $mail->setFrom($from_);
      $mail->setSubject($subject_);

      if (!is_array($toArr_))
      {
        $toArr_ = array($toArr_);
      }

      $mailResult = $mail->send($toArr_);

      if (!$mailResult)
      {
        return 'Failed to send mail';
      }
      else
      {
        return false;
      }
    }
    else
    {
      return 'Failed to send mail, one or more parameters wasn\'t entered.';
    }
  }

Communication::sendSms	(	$	fromEmail_,
		$	fromName_,
		$	toArr_,
		$	message_,
		$	repeatTime_ = 60
	)

Sends an SMS message to a mobile phone.

The function uses the (at)esms.nu service.

Parameters:

	$fromEmail_	- string - esms requires all sms-emails to be sent from a registered email-address. Ie. sms(at)example.com
	$fromName_	- string - The from name that will be displayed in the SMS Ie. Daniel 0731234567
	$toArr_	- string - A list of cell phone numbers that will recieve the message. Ie. 0731234567
	$message_	- string - The text that will be sent on the sms. The message will be truncated to 160 chars.
	$repeatTime_	- integer The number of seconds to wait until next sms can be sent. To prevent sms flooding.

Returns:

$errorMessage - string - If sendEmail fails, an error message will be returned. If sendEmail succededs, false will be returned.

Definition at line 149 of file Communication.class.php.

References sendEmail().

  {
    if (!empty($message_))
    {
      $message_ = substr($message_, 0, 160);
      if (!empty($this->_sendLock) || $this->_sendLock->isLockExpired('SMS', $repeatTime_, false))
      {
        $cellPhoneArr = array();
        if (!is_array($toArr_))
        {
          $toArr_ = array($toArr_);
        }
        foreach ($toArr_ as $cellPhone)
        {
          $cellPhoneArr[] = $cellPhone . '@esms.nu';
        }
        return $this->sendEmail($fromEmail_, $cellPhoneArr, $fromName_, $message_);
      }
      else
      {
        return 'Failed to send sms, to many at to short time.';
      }
    }
  }

---

Member Data Documentation

Communication::$_sendLock [private]

A lock object that will handle how often an SMS can be sent.

$_sendLock - ILock -

Definition at line 180 of file Communication.class.php.

---

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

• Static/PhpInclude/FareOfficeLib/General/Communication.class.php