= PloneSMS bundle =

Bundle provides the tool and sample content type. Solution allows Plone sites to send SMSes via [http://www.xiam.com XIAM] gateways of Cellular operators directly to cellphones. Product is tested to work with XIAM gatway of O2 cellphone provider.

== Download ==

get it [source:ShortMessage/tags/0.1.3 from] [source:PloneSMSCommunicator/tags/0.1.3 SVN] at http://svn.quintagroup.com/products

== Installation ==

 1. Unpack into /Products folder of your Zope instance.
 2. Install PloneSMSCommunicator ans !ShortMessage with Quick Installer.

== Usage ==

 1. Negotiate with cellphone provider the access details (XIAM server).
 2. Setup PloneSMSCommunicator
 3. Send SMSes

== Architecture ==

Solution contains two Plone products:
 [wiki:PloneSMS/PloneSMSCommunicator PloneSMSCommunicator]::
   the tool that talks to XIAM gateway at cellphone operator via XIAM-XML protocol. 
   You'd have to set XIAM gateway properties in the tool' configlet before you 
   are able to send SMSes.
 [wiki:PloneSMS/ShortMessage ShortMessage]::
   the sample content type that allows sending Short Messages to cellphones. It 
   employs Workflow to plug in the sendout procedure.

== Developer reference ==

Products:

 * [wiki:PloneSMS/ShortMessage ShortMessage] 
 * [wiki:PloneSMS/PloneSMSCommunicator PloneSMSCommunicator]

The most important API function is [source:PloneSMSCommunicator/trunk/PloneSMSCommunicator.py PloneSMSCommunicator.send_Request()]. It is sending SMS via cellphone provider.

The example use of the function can be found in [source:ShortMessage/trunk/Extensions/Sm_Workflow.py send_publishedMessage()].