brendanlim-sms-fu

= SMS Fu

Want to send an SMS from your Rails application? SMS Fu allows you to do just that.
It allows you to send a text-message in the form of an e-mail to a cell phone on any of the supported carriers.

== Supported Carriers (US & International):

Alltel, Ameritech, AT&T, Bell Atlantic, BellSouth Mobility, Beeline(UA), BlueSkyFrog, Boost Mobile, BPL Mobile, Cellular South, Claro (Brazil, Nicaragua), Comcast, Du, E-Plus, Etisalat, Fido, kajeet, Mobinil, Mobitel, Movistar, Metro PCS, O2, Orange, Powertel, PSC Wireless, Qwest, Rogers, Southern Link, Sprint, Suncom, T-Mobile (US/UK/Germany), Telefonica, Tracfone, Virgin Mobile, Verizon Wireless, Vodafone (UK, Egypt, Italy, Japan, Spain), and many more ...

== Opt-In Warning for Some International Carriers

Some International carriers require that their users subscribe to an Email to SMS feature before they are able to receive SMS messages this way. If one your users mentions that they are not receiving their messages, chances are it is due to this limitation.

Some carriers that need this include, Mobitel, Etisalat, T-Mobile (Netherlands), etc.

== Setup Instructions

Add this this one line to the controller you want to be able to use SMS Fu in.

class ExampleController < ApplicationController
  has_sms_fu
end

Modify sms_fu.yml in your config folder with your reply-to e-mail address.

That's it! Now you're good to go.

== Example Usage

• You have to send in the phone number, without any non-numeric characters. The phone numbers must be 10 digits in length.

• The two required parameters are the phone number and the phone carrier.

• Here are some of the default carrier values:

  Alltel Wireless => "alltel" AT&T/Cingular => "at&t" Boost Mobile => "boost" Sprint Wireless => "sprint" T-Mobile US => "t-mobile" T-Mobile UK => "t-mobile-uk" Virgin Mobile => "virgin" Verizon Wireless => "verizon" Vodafone Tokyo => "vodafone-jp-tokyo"

• Check sms_fu.yml for a complete list of supported carriers, including international carriers as well.

  deliver_sms("5558675309","at&t","message")

• If you want to set a custom from e-mail per SMS message, you can do so by doing the following.

  deliver_sms("5558675309","at&t","message", :from => "[e-mail]")

• You can set the maximum length of the SMS message, which is not set by default. Most phones can only accept 128 characters. To do this just specify the limit option.

  deliver_sms("5558675309","at&t","message", :limit => 128)

• You can retrieve just the formatted address to use in your own mailer.

  get_sms_address("5558675309","at&t") # => "[e-mail]"

== View Helpers

• Retrieve a collection of all carriers

  <%= carrier_collection %>

• Display a select box with mobile carriers

  <%= carrier_select %>

• Display a custom select box with mobile carriers

  <%= carrier_select('user[carrier_name]', "Please choose a carrier") %>

Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license