Net_SMS
[ class tree: Net_SMS ] [ index: Net_SMS ] [ all elements ]

Class: Net_SMS_vodafoneitaly_smtp

Source Location: /Net_SMS-0.2.1/Net/SMS/vodafoneitaly_smtp.php

Class Overview

Net_SMS
   |
   --Net_SMS_vodafoneitaly_smtp

Net_SMS_vodafoneitaly_smtp Class implements the SMTP API for accessing the Vodafone Italy SMS gateway. Use of this gateway requires an email account with Vodafone Italy (www.190.it).


Author(s):

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 19]
Net_SMS_vodafoneitaly_smtp Class implements the SMTP API for accessing the Vodafone Italy SMS gateway. Use of this gateway requires an email account with Vodafone Italy (www.190.it).

Copyright 2003-2009 The Horde Project (http://www.horde.org/) Copyright 2003-2007 Matteo Zambelli <mmzambe@hotmail.com>

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

$Horde: framework/Net_SMS/SMS/vodafoneitaly_smtp.php,v 1.25 2008/01/02 11:12:11 jan Exp $



[ Top ]


Class Variables

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

[line 48]

An array of capabilities, so that the driver can report which operations

it supports and which it doesn't. Possible values are:

   auth        - The gateway require authentication before sending;
   batch       - Batch sending is supported;
   multi       - Sending of messages to multiple recipients is supported;
   receive     - Whether this driver is capable of receiving SMS;
   credit      - Is use of the gateway based on credits;
   addressbook - Are gateway addressbooks supported;
   lists       - Gateway support for distribution lists.


Type:   array


[ Top ]

$mail =

[line 21]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 28]

Net_SMS_vodafoneitaly_smtp __construct( array $params, Mail $mail)

Constructor.
  • Access: public

Overrides Net_SMS::__construct() (Constructor)

Parameters:

array   $params   —  Parameters.
Mail   $mail   — 

[ Top ]

getDefaultSendParams   [line 116]

array getDefaultSendParams( )

Returns the parameters that can be set as default for sending messages using this gateway driver and displayed when sending messages.
  • Return: Array of parameters that can be set as default.

[ Top ]

getInfo   [line 91]

array getInfo( )

Identifies this gateway driver and returns a brief description.
  • Return: Array of driver info.

[ Top ]

getParams   [line 104]

array getParams( )

Returns the required parameters for this gateway driver.
  • Return: Array of required parameters.

[ Top ]

getSendParams   [line 130]

array getSendParams( $params)

Returns the parameters for sending messages using this gateway driver, displayed when sending messages. These are filtered out using the default values set up when creating the gateway.
  • Return: Array of required parameters.
  • Todo: Would be nice to use a time/date setup rather than minutes from now for the delivery time. Upload field for ringtones/logos?

Parameters:

   $params   — 

[ Top ]

_send   [line 68]

array _send( array $message, string $to)

This function does the actual sending of the message.
  • Return: An array with the success status and additional information.
  • Access: protected

Overrides Net_SMS::_send() (This function does the actual sending of the message.)

Parameters:

array   $message   —  The array containing the message and its send parameters.
string   $to   —  The recipient.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:57:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.