Class: Net_SMS_generic_smtp

Source Location: /Net_SMS-0.0.2/SMS/generic_smtp.php

Class Overview

Net_SMS
   |
   --Net_SMS_generic_smtp

Generic e-mail based SMS driver

Author(s):

Ian Eure <ieure at php.net>

Variables

$capabilities

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Net_SMS::Net_SMS(): Constructor
Net_SMS::authenticate(): Authenticates against the gateway if required.
Net_SMS::factory(): Attempts to return a concrete Gateway instance based on $driver.
Net_SMS::getBalance(): If the current driver has a credit capability, queries the gateway for a credit balance and returns the value.
Net_SMS::getDefaultSendParams(): Returns send parameters for a gateway from the driver subclass
Net_SMS::getDrivers(): Returns a list of available gateway drivers.
Net_SMS::getGatewayInfo(): Returns information on a gateway, such as name and a brief description, from the driver subclass getInfo() function.
Net_SMS::getGatewayParams(): Returns parameters for a gateway from the driver subclass getParams() function.
Net_SMS::hasCapability(): Query the current Gateway object to find out if it supports the given capability.
Net_SMS::send(): Sends a message to one or more recipients. Hands off the actual sending to the gateway driver.
Net_SMS::singleton(): Attempts to return a reference to a concrete Net_SMS instance based on $driver. It wil only create a new instance if no Net_SMS instance with the same parameters currently exists.

Class Details

[line 19]
Generic e-mail based SMS driver

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.

Author: Ian Eure <ieure@php.net>
Since: Horde 3.1
Since: Net_SMS 0.0.2

[ Top ]

Class Variables

$capabilities = array(
        'auth'        => false,
        'batch'       => false,
        'multi'       => false,
        'receive'     => false,
        'credit'      => false,
        'addressbook' => false,
        'lists'       => false
    )

[line 26]

Capabilities of this driver.

Type:

array

[ Top ]

Method Detail

addCarrier [line 182]

void addCarrier(
string
$name, string
$addr)

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.

Parameters:

string	`$name`	—	Carrier name.
string	`$addr`	—	Address template.

[ Top ]

getAddressTemplate [line 165]

mixed getAddressTemplate(
string
$carrier)

Returns the address template for a carrier.

Return: Address template or false.

Parameters:

string $carrier — Carrier name.

[ Top ]

getInfo [line 86]

array getInfo(
)

Identifies this driver.

Return: Driver info.

[ Top ]

getParams [line 99]

array getParams(
)

Returns required parameters.

Return: Array of required parameters.

[ Top ]

Class: Net_SMS_generic_smtp

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Class Details

Class Variables

$capabilities = array( 'auth' => false, 'batch' => false, 'multi' => false, 'receive' => false, 'credit' => false, 'addressbook' => false, 'lists' => false )

Method Detail

addCarrier [line 182]

Parameters:

getAddressTemplate [line 165]

Parameters:

getInfo [line 86]

getParams [line 99]

$capabilities = array(
'auth' => false,
'batch' => false,
'multi' => false,
'receive' => false,
'credit' => false,
'addressbook' => false,
'lists' => false
)