genie(3)
NAME
Net::SMS::Genie - a module to send SMS messages using the
Genie web2sms gateway (<http://www.genie.co.uk/>).
SYNOPSIS
my $sms = Net::SMS::Genie->new(
autotruncate => 1,
username => 'yourname',
password => 'yourpassword',
recipient => 07713123456,
subject => 'a test',
message => 'a test message',
);
$sms->verbose( 1 );
$sms->message( 'a different message' );
print "sending message to mobile number ", $sms->recipient();
$sms->send_sms();
my $quota = $sms->quota();
DESCRIPTION
A perl module to send SMS messages, using the Genie
web2sms gateway. This module will only work with mobile
phone numbers that have been registered with Genie
(<http://www.genie.co.uk/>) and uses form submission to a
URL that may be subject to change. The Genie service is
currently only available to UK mobile phone users.
There is a maximum length for SMS subject + message (115
for Genie). If the sum of subject and message lengths
exceed this, the behaviour of the Net::SMS::Genie objects
depends on the value of the 'autotruncate' argument to the
constructor. If this is a true value, then the subject /
message will be truncated to 115 characters. If false, the
object will throw an exception (die). If you set notrun
cate to 1, then the module won't check the message length,
and you are on your own!
CONSTRUCTOR
The constructor for Net::SMS::Genie takes the following
arguments as hash values (see SYNOPSIS):
autotruncate (OPTIONAL)
Genie has a upper limit on the length of the subject +
message (115). If autotruncate is true, subject and mes
sage are truncated to 115 if the sum of their lengths
exceeds 115. The heuristic for this is simply to treat
subject and message as a string and truncate it (i.e. if
length(subject) >= 115 then message is truncated to 0.
Thanks to Mark Zealey <mark@itsolve.co.uk> for this sug
gestion. The default for this is false.
notruncate (OPTIONAL)
Of course, if you don't believe the Genie web interface
about maximum character length, then you can set this
option.
username (REQUIRED)
The Genie username for the user (assuming that the user is
already registered at <http://www.genie.co.uk/>.
password (REQUIRED)
The Genie password for the user (assuming that the user is
already registered at <http://www.genie.co.uk/>.
recipient (REQUIRED)
Mobile number for the intended SMS recipient.
subject (REQUIRED)
SMS message subject.
message (REQUIRED)
SMS message body.
verbose (OPTIONAL)
If true, various soothing messages are sent to STDERR.
Defaults to false.
AUTOLOAD
- All of the constructor arguments can be got / set using
accessor methods. E.g.: - $old_message = $self->message;
$self->message( $new_message );
METHODS
send_sms
This method is invoked to actually send the SMS message
that corresponds to the constructor arguments.
quota
This method returns the number of messages remaining in
your months quota. Only works after send_sms has be called
successfully.
AUTHOR
Ave Wrigley <Ave.Wrigley@itn.co.uk>
COPYRIGHT
- Copyright (c) 2001 Ave Wrigley. All rights reserved. This
program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.