/ 
WebService-HashBlue-0.01
/ WebService::HashBlue

NAME

WebService::HashBlue - Interact with Telefonica/o2's #blue service

VERSION

Version 0.01

SYNOPSIS

use WebService::HashBlue;

my $blue = WebService::HashBlue->new(api_key => 'asdfm12312p' email => 'squeek@cpan.org');
my $messages = $blue->get_messages;
my $response = $blue->search_messages('#perl');

METHODS

new(email => $email, api_key => $api_key)

Creates a new WebService::HashBlue object. Both email address and API key are mandatory.

Messaging

get_messages

Returns an array containing all messages.

search_nessages($query)

Search through all messages.

send_message(contact => $number, message => $message)

Send an SMS to a specified number. Numbers need to be formatted with country code and no prefixing zeros or plus sign, for example +44 07700 900492 should be called as 447700900492. Messages should contain up to 160 characters, anything longer is truncated.

delete_message

Marks a specific message for deletion. Messages aren't actually delete, just marked. Message ID is mandatory.

deleted_messages

Returns an arrayref containing all the messages that were marked as deleted.

Favourites

get_favourites

Returns an arrayref containing all the favourites added by the user.

add_favourite($message_id)

Add a message as a favourite. Message ID must be supplied.

remove_favourite($message_id)

Unmark a message as favourite. Message ID must be supplied.

Contacts

get_contacts

Returns an arrayref of all the contacts kept by the user.

contact_messages($contact_id)

Retrieves all messages for a given contact.

delete_contact_messages($contact_id)

Deletes all messages by a specified contact ID.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WebService::HashBlue

You can also look for information at:

ACKNOWLEDGEMENTS

Richard Spence for providing further information and documentation.

LICENSE AND COPYRIGHT

Copyright 2010 Squeeks.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.