Device::Gsm::Sms - SMS message internal class that represents a single text SMS message

- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS

- `decode()`
- `delete()`
- `new()`
- `index()`
- `recipient()`
- `sender()`
- `status()`
- `text()`
- `token()`
- `type()`

- REQUIRES
- EXPORTS
- TODO
- COPYRIGHT
- AUTHOR
- SEE ALSO

# NAME

Device::Gsm::Sms - SMS message internal class that represents a single text SMS message

# SYNOPSIS

        # A list of Device::Gsm::Sms messages is returned by
        # Device::Gsm messages() method.

        use Device::Gsm;
        ...
        @sms = $gsm->messages();

        if( @sms ) {
            foreach( @sms ) {
                print $msg->recipient() , "\n";
                print $msg->sender()    , "\n";
                print $msg->content()   , "\n";
                print $msg->time()      , "\n";
                print $msg->type()      , "\n";
            }
        }

        # Or you can instance a sms message from raw PDU data
        my $msg = new Device::Gsm::Sms(
            header => '+CMGL: ...',
            pdu    => `[encoded pdu data]'
        );

        if( defined $msg ) {
            print $msg->recipient() , "\n";
            print $msg->sender()    , "\n";
            print $msg->content()   , "\n";
            print $msg->time()      , "\n";
            print $msg->type()      , "\n";
        }

# DESCRIPTION

`Device::Gsm::Sms` class implements very basic SMS message object, that can be used to decode `+CMGL` GSM command response to build a more friendly high-level object.

# METHODS

The following is a list of methods applicable to `Device::Gsm::Sms` objects.

## `decode()`

Starts the decoding process of pdu binary data. If decoding process ends in success, return value is true and sms object is filled with all proper values.

If decoding process has errors or pdu data is not provided, return value is 0 (zero).

## `delete()`

Delete the current SMS message from sim card. Example:

        $gsm = Device::Gsm->new();
        ...
        my @msg = $gsm->messages();
        $msg[0] && $msg[0]->delete();

## `new()`

Basic constructor. You can build a new `Device::Gsm::Sms` object from the raw +CMGL header and PDU data. Those data is then decoded and a new sms object is instanced and all information filled, to be available for subsequent method calls.

The allowed parameters to `new()` method are:

header
  This is the raw +CMGL header string as modem outputs when you issue a +CMGL command

pdu
  Binary encoded sms data

## `index()`

Returns the sms message index number, that is the position of message in the internal device memory or sim card. This number is used for example to delete the message.

        my $gsm = Device::Gsm->new(port=>'/dev/ttyS0');
        ...
        my @messages = $gsm->messages();
        ...
        # Delete the first returned message
        my $msg = shift @messages;
        $gsm->delete_sms( $msg->index() );

## `recipient()`

Returns the sms recipient number (destination address = DA) as string (ex.: `+39012345678`).

## `sender()`

Returns the sms sender number (originating address = OA) as string.

## `status()`

Status of the message can be one value from the following list:

## `text()`

Returns the textual content of sms message

## `token()`

Returns the given PDU token of the decoded message (internal usage).

## `type()`

SMS messages can be of two types: SMS_SUBMIT and SMS_DELIVER, that are defined by two constants with those names. `type()` method returns one of these two values.

Example:

            if( $sms->type() == Device::Gsm::Sms::SMS_DELIVER ) {
                    # ...
            }
            elsif( $sms->type() == Device::Gsm::Sms::SMS_SUBMIT ) {
                    # ...
            }

# REQUIRES

Device::Gsm

# EXPORTS

None

# TODO

Complete and proof-read documentation and examples

# COPYRIGHT

Device::Gsm::Sms - SMS message simple class that represents a text SMS message

Copyright (C) 2002-2004 Cosimo Streppone, cosimo@cpan.org

This program is free software; you can redistribute it and/or modify it only under the terms of Perl itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Perl licensing terms for details.

# AUTHOR

Cosimo Streppone, cosimo@cpan.org

# SEE ALSO

the Device::Gsm manpage, `perl(1)`