[[TOC]]
= Messaging Module =
This is the userguide for the current version of the Messaging module

NB The Cron task(s) needs to be enabled in {{{cron/crontab}}}. This doesn't currently work for Win32 service. For mod_wsgi, need to [wiki:InstallationGuidelinesApacheModWSGI#Cron add support to the system crontab].
== Email ==
=== How do I use Gmail to send outbound mail? ===
Edit {{{models/000_config.py}}}
Uncomment these lines & put in the username/password that you wish to use:
{{{
#deployment_settings.mail.server = "smtp.gmail.com:587"
#deployment_settings.mail.login = "username:password"
}}}

== SMS ==
=== What Hardware do I need? ===
If using an online gateway, then you don't need any hardware other than the network card :)

If you wish to be able to send messages without an Internet connection then you need a comaptible device such as one from the following.

Hardware compatibility databases:
 * http://wiki.gnokii.org/index.php/Config
 * http://cihar.com/gammu/phonedb/
 * http://www.frontlinesms.com/resources/requirements/

=== How do I use it? ===
1st you need to decide whether you will be using a local modem or an online gateway (e.g. Clickatell or Tropo).

This is configured by the Administrator in the Global message Settings:
 * http://127.0.0.1:8000/eden/msg/setting/1/update

The Gateway or Modem details are configured via their own panels.

==== Clickatell ====
Global provider - average price globally:
 * http://clickatell.com
{{{
https://api.clickatell.com/http/sendmsg
user=myusername&password=mypassword&api_id=myapi_id
text
to
}}}

==== Mvaayoo ====
Indian provider - cheap for local calls
{{{
http://api.mvaayoo.com/mvaayooapi/MessageCompose
user=my@email.address:mypassword&senderID=TEST SMS&state=4
msgtxt
receipientno
}}}

==== Tropo ====
Provide an automated-attendant (IVR) service which supports Voice, XMPP (GTalk) & Twitter as well as SMS.
 * http://tropo.im
 * The Twitter/GTalk 'bots' are great for testing the system out without incurring call charges

US Inbound number is free for development use so this is great for demos.
 * no other local numbers available for SMS (UK numbers may be available as special service)

They have helpful support forums.

Configure your Tropo token into:
 * http://127.0.0.1:8000/eden/msg/tropo_settings/1/update

Inbound messages are collected in {{{controllers/msg.py}}} by the tropo() function, so configure this URL into your Application on the Tropo site:L
 * http://host.domain.com/eden/msg/tropo?tropo-engine=json

The incoming message is parsed by the parserdooth() function which uses difflib to allow users to mis-spell the keywords.

=== How does it work? ===
Compose a new message. The autocomplete will find either Persons or Groups.

Contact numbers from Persons have non-numeric characters stripped & then a '+' is prefixed when using a local modem.

For gateway usage, a default Country Code is added to numbers which start with 0.

== More ==
 * [wiki:BluePrintMessagingModule BluePrint]

----
UserGuidelines