Class Net_SMS_generic_smtp

Description

Generic e-mail based SMS driver

Copyright 2005-2007 WebSprockets, LLC

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

This driver interfaces with the email-to-sms gateways provided by many carriers, particularly those based in the U.S.

$Horde: framework/Net_SMS/SMS/generic_smtp.php,v 1.8.2.9 2008/05/14 21:39:40 jan Exp $

  • author: Ian Eure <ieure@php.net>
  • since: Horde 3.1
  • since: Net_SMS 0.0.2

Located in /Net_SMS/SMS/generic_smtp.php (line 21)

Net_SMS
   |
   --Net_SMS_generic_smtp
Variable Summary
Method Summary
 void addCarrier (string $name, string $addr)
 mixed getAddressTemplate (string $carrier)
 array getInfo ()
 array getParams ()
 string _getDest (string $phone, [ $carrier = null])
Variables
array $capabilities = array(
'auth' => false,
'batch' => false,
'multi' => false,
'receive' => false,
'credit' => false,
'addressbook' => false,
'lists' => false
)
(line 28)

Capabilities of this driver.

Inherited Variables

Inherited from Net_SMS

Net_SMS::$_auth
Methods
addCarrier (line 182)

Adds a carrier to the list.

Address templates need to be in the form of an email address, with a '%s' representing the place where the destination phone number goes.

void addCarrier (string $name, string $addr)
  • string $name: Carrier name.
  • string $addr: Address template.
getAddressTemplate (line 165)

Returns the address template for a carrier.

  • return: Address template or false.
mixed getAddressTemplate (string $carrier)
  • string $carrier: Carrier name.
getDefaultSendParams (line 192)

Returns a list of parameters specific for this driver.

  • return: Default sending parameters.
array getDefaultSendParams ()

Redefinition of:
Net_SMS::getDefaultSendParams()
Returns send parameters for a gateway from the driver subclass getDefaultSendParams()function. These are parameters which are available to the user during sending, such as setting a time for delivery, or type of SMS (normal text or flash), or source address, etc.
getInfo (line 88)

Identifies this driver.

  • return: Driver info.
array getInfo ()
getParams (line 101)

Returns required parameters.

  • return: Array of required parameters.
array getParams ()
_getDest (line 151)

Returns destination e-mail address.

  • return: Destination address.
string _getDest (string $phone, [ $carrier = null])
  • string $phone: Phone number to send to.
  • $carrier

Inherited Methods

Inherited From Net_SMS

 Net_SMS::Net_SMS()
 Net_SMS::authenticate()
 Net_SMS::factory()
 Net_SMS::getBalance()
 Net_SMS::getDefaultSendParams()
 Net_SMS::getDrivers()
 Net_SMS::getGatewayInfo()
 Net_SMS::getGatewayParams()
 Net_SMS::hasCapability()
 Net_SMS::send()
 Net_SMS::singleton()

Documentation generated on Sun, 30 Jan 2011 05:17:49 +0000 by phpDocumentor 1.4.3