[ Index ]
 

Code source de Horde 3.1.3

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/Net/SMS/ -> sms2email_http.php (sommaire)

(pas de description)

Poids: 683 lignes (26 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Net_SMS_sms2email_http:: (18 méthodes):
  _send()
  _getBalance()
  addContact()
  updateContact()
  deleteContact()
  getAddressBook()
  listCreate()
  listDelete()
  listUpdate()
  listRename()
  getLists()
  getList()
  getInfo()
  getParams()
  getDefaultSendParams()
  getSendParams()
  getError()
  _callURL()


Classe: Net_SMS_sms2email_http  - X-Ref

Net_SMS_sms2email_http Class implements the HTTP API for accessing the
sms2email (www.sms2email.com) SMS gateway.

Copyright 2003-2006 Marko Djukic <marko@oblo.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/sms2email_http.php,v 1.23.10.10 2006/01/01 21:28:29 jan Exp $

_send(&$message, $to)   X-Ref
This function does the actual sending of the message.

param: array $message  The array containing the message and its send
param: string $to      The destination string.
return: array  An array with the success status and additional

_getBalance()   X-Ref
Returns the current credit balance on the gateway.

return: integer  The credit balance available on the gateway.

addContact($name, $number)   X-Ref
Adds a contact to the gateway's addressbook.

param: string $name     The name for this contact
param: integer $number  The contact's phone number.
return: mixed  The remote contact ID on success or PEAR Error on

updateContact($id, $name, $number)   X-Ref
Updates a contact in the gateway's addressbook.

param: integer $id      The contact's ID on the gateway.
param: string $name     The name for this contact
param: integer $number  The contact's phone number.
return: mixed  True on success or PEAR Error on failure.

deleteContact($id)   X-Ref
Deletes a contact in the gateway's addressbook.

param: integer $id  The contact's ID on the gateway.
return: mixed  True on success or PEAR Error on failure.

getAddressBook()   X-Ref
Fetches the entire address book from the gateway.

return: mixed  Array of contacts on success or PEAR Error on failure.

listCreate($name, $numbers)   X-Ref
Creates a new distribution list on the gateway.

param: string $name    An arbitrary name for the new list.
param: array $numbers  A simple array of numbers to add to the list.
return: mixed  Gateway ID for the created list on success or PEAR Error

listDelete($id)   X-Ref
Deletes a distribution list from the gateway.

param: string $id  The gateway ID for the list to delete.
return: mixed  True on success or PEAR Error on failure.

listUpdate($id, $name, $numbers = array()   X-Ref
Updates a distribution list on the gateway.

param: string $id       The gateway ID for the list to update.
param: string $name     The arbitrary name of the list. If different
param: string $numbers  The new list of numbers in the list. If left
return: mixed  True on success or PEAR Error on failure.

listRename($id, $name)   X-Ref
Renames a distribution list on the gateway. Does nothing other than
calling the listUpdate() function with just the $id and $name
variables.

param: string $id    The gateway ID for the list to update.
param: string $name  The new arbitrary name for the list.
return: mixed  True on success or PEAR Error on failure.

getLists()   X-Ref
Fetches a listing of available distribution lists on the server.

return: mixed  An array of lists on success or PEAR Error on failure.

getList($id)   X-Ref
Fetches a specific distribution list from the gateway.

param: string  The ID of the distribution list to fetch.
return: mixed  An array of numbers in the list on success or PEAR Error

getInfo()   X-Ref
Identifies this gateway driver and returns a brief description.

return: array  Array of driver info.

getParams()   X-Ref
Returns the required parameters for this gateway driver. The settable
parameters for this gateway are:<pre>
- user            - The username for authentication on the gateway;
- password        - The password for authentication on the gateway;
- ssl             - Whether or not to use SSL for communication with
the gateway.
- delivery_report - A URL for a script which would accept delivery
report from the gateway.
</pre>

return: array  Array of required parameters.

getDefaultSendParams()   X-Ref
Returns the parameters that can be set as default for sending messages
using this gateway driver and displayed when sending messages.

return: array  Array of parameters that can be set as default.

getSendParams($params)   X-Ref
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  Array of required parameters.

getError($error, $error_text = '')   X-Ref
Returns a string representation of an error code.

param: integer $error  The error code to look up.
param: string $text    An existing error text to use to raise a
return: mixed  A textual message corresponding to the error code or a

_callURL($url)   X-Ref
Do the http call using a url passed to the function.

param: string $url  The url to call.
return: mixed  The response on success or PEAR Error on failure.



Généré le : Sun Feb 25 18:01:28 2007 par Balluche grâce à PHPXref 0.7