Class: Net_SMS_generic_smtp

Source Location: /Net_SMS-0.2.1/Net/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

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Net_SMS::__construct(): Constructor
Net_SMS::authenticate(): Authenticates against the gateway if required.
Net_SMS::getBalance(): If the current driver has a credit capability, queries the gateway for a credit balance and returns the value.
Net_SMS::getError(): Returns a string representation of an error code.
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::_send(): This function does the actual sending of the message.

Class Details

[line 21]
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.

$Horde: framework/Net_SMS/SMS/generic_smtp.php,v 1.15 2007/06/27 17:22:58 jan Exp $

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 41]

Capabilities of this driver.

Type:

array

[ Top ]

$mail =

[line 23]

Access: protected

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 30]

Net_SMS_generic_smtp __construct(
array
$params, Mail
$mail)

Constructor.

Access: public

Overrides Net_SMS::__construct() (Constructor)

Parameters:

array	`$params`	—	Parameters.
Mail	`$mail`	—

[ Top ]

addCarrier [line 198]

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 181]

mixed getAddressTemplate(
string
$carrier)

Returns the address template for a carrier.

Return: Address template or false.

Parameters:

string $carrier — Carrier name.

[ Top ]

getDefaultSendParams [line 208]

array getDefaultSendParams(
)

Returns a list of parameters specific for this driver.

Return: Default sending parameters.

[ Top ]

getInfo [line 101]

array getInfo(
)

Identifies this driver.

Return: Driver info.

[ Top ]

getParams [line 114]

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 )

$mail =

Method Detail

__construct (Constructor) [line 30]

Parameters:

addCarrier [line 198]

Parameters:

getAddressTemplate [line 181]

Parameters:

getDefaultSendParams [line 208]

getInfo [line 101]

getParams [line 114]

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