Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

SmsMessage

extends Object
java.lang.Object
   ↳ android.telephony.SmsMessage

Class Overview

A Short Message Service message.

See Also

Summary

Nested Classes
enum SmsMessage.MessageClass SMS Class enumeration. 
class SmsMessage.SubmitPdu  
Constants
int ENCODING_16BIT
int ENCODING_7BIT
int ENCODING_8BIT
int ENCODING_UNKNOWN User data text encoding code unit size
int MAX_USER_DATA_BYTES The maximum number of payload bytes per message
int MAX_USER_DATA_BYTES_WITH_HEADER The maximum number of payload bytes per message if a user data header is present.
int MAX_USER_DATA_SEPTETS The maximum number of payload septets per message
int MAX_USER_DATA_SEPTETS_WITH_HEADER The maximum number of payload septets per message if a user data header is present.
Public Methods
static int[] calculateLength ( CharSequence msgBody, boolean use7bitOnly)
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message.
static int[] calculateLength ( String messageBody, boolean use7bitOnly)
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message, given the current encoding.
static SmsMessage createFromPdu (byte[] pdu)
Create an SmsMessage from a raw PDU.
String getDisplayMessageBody ()
Returns the message body, or email message body if this message was from an email gateway.
String getDisplayOriginatingAddress ()
Returns the originating address, or email from address if this message was from an email gateway.
String getEmailBody ()
String getEmailFrom ()
int getIndexOnIcc ()
Returns the record index of the message on the ICC (1-based index).
int getIndexOnSim ()
This method was deprecated in API level 4. Use getIndexOnIcc instead.
String getMessageBody ()
Returns the message body as a String, if it exists and is text based.
SmsMessage.MessageClass getMessageClass ()
Returns the class of this message.
String getOriginatingAddress ()
Returns the originating address (sender) of this SMS message in String form or null if unavailable
byte[] getPdu ()
Returns the raw PDU for the message.
int getProtocolIdentifier ()
Get protocol identifier.
String getPseudoSubject ()
Unofficial convention of a subject line enclosed in parens empty string if not present
String getServiceCenterAddress ()
Returns the address of the SMS service center that relayed this message or null if there is none.
int getStatus ()
GSM: For an SMS-STATUS-REPORT message, this returns the status field from the status report.
int getStatusOnIcc ()
Returns the status of the message on the ICC (read, unread, sent, unsent).
int getStatusOnSim ()
This method was deprecated in API level 4. Use getStatusOnIcc instead.
static SmsMessage.SubmitPdu getSubmitPdu ( String scAddress, String destinationAddress, short destinationPort, byte[] data, boolean statusReportRequested)
Get an SMS-SUBMIT PDU for a data message to a destination address & port.
static SmsMessage.SubmitPdu getSubmitPdu ( String scAddress, String destinationAddress, String message, boolean statusReportRequested)
Get an SMS-SUBMIT PDU for a destination address and a message.
static int getTPLayerLengthForPDU ( String pdu)
Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header FIXME: This method is only used by a CTS test case that isn't run on CDMA devices.
long getTimestampMillis ()
Returns the service centre timestamp in currentTimeMillis() format
byte[] getUserData ()
returns the user data section minus the user data header if one was present.
boolean isCphsMwiMessage ()
Returns true for CPHS MWI toggle message.
boolean isEmail ()
Returns true if message is an email.
boolean isMWIClearMessage ()
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) clear message
boolean isMWISetMessage ()
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) set message
boolean isMwiDontStore ()
returns true if this message is a "Message Waiting Indication Group: Discard Message" notification and should not be stored.
boolean isReplace ()
See TS 23.040 9.2.3.9 returns true if this is a "replace short message" SMS
boolean isReplyPathPresent ()
Returns true iff the TP-Reply-Path bit is set in this message.
boolean isStatusReportMessage ()
Return true iff the message is a SMS-STATUS-REPORT message.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int ENCODING_16BIT

Added in API level 4

Constant Value: 3 (0x00000003)

public static final int ENCODING_7BIT

Added in API level 4

Constant Value: 1 (0x00000001)

public static final int ENCODING_8BIT

Added in API level 4

Constant Value: 2 (0x00000002)

public static final int ENCODING_UNKNOWN

Added in API level 4

User data text encoding code unit size

Constant Value: 0 (0x00000000)

public static final int MAX_USER_DATA_BYTES

Added in API level 4

The maximum number of payload bytes per message

Constant Value: 140 (0x0000008c)

public static final int MAX_USER_DATA_BYTES_WITH_HEADER

Added in API level 4

The maximum number of payload bytes per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element.

Constant Value: 134 (0x00000086)

public static final int MAX_USER_DATA_SEPTETS

Added in API level 4

The maximum number of payload septets per message

Constant Value: 160 (0x000000a0)

public static final int MAX_USER_DATA_SEPTETS_WITH_HEADER

Added in API level 4

The maximum number of payload septets per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element.

Constant Value: 153 (0x00000099)

Public Methods

public static int[] calculateLength ( CharSequence msgBody, boolean use7bitOnly)

Added in API level 4

Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message.

Parameters
msgBody the message to encode
use7bitOnly if true, characters that are not part of the radio-specific 7-bit encoding are counted as single space chars. If false, and if the messageBody contains non-7-bit encodable characters, length is calculated using a 16-bit encoding.
Returns
  • an int[4] with int[0] being the number of SMS's required, int[1] the number of code units used, and int[2] is the number of code units remaining until the next message. int[3] is an indicator of the encoding code unit size (see the ENCODING_* definitions in SmsConstants)

public static int[] calculateLength ( String messageBody, boolean use7bitOnly)

Added in API level 4

Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message, given the current encoding.

Parameters
messageBody the message to encode
use7bitOnly if true, characters that are not part of the radio specific (GSM / CDMA) alphabet encoding are converted to as a single space characters. If false, a messageBody containing non-GSM or non-CDMA alphabet characters are encoded using 16-bit encoding.
Returns
  • an int[4] with int[0] being the number of SMS's required, int[1] the number of code units used, and int[2] is the number of code units remaining until the next message. int[3] is the encoding type that should be used for the message.

public static SmsMessage createFromPdu (byte[] pdu)

Added in API level 4

Create an SmsMessage from a raw PDU.

This method will soon be deprecated and all applications which handle incoming SMS messages by processing the SMS_RECEIVED_ACTION broadcast intent must now pass the new format String extra from the intent into the new method createFromPdu(byte[], String) which takes an extra format parameter. This is required in order to correctly decode the PDU on devices that require support for both 3GPP and 3GPP2 formats at the same time, such as dual-mode GSM/CDMA and CDMA/LTE phones. Guess format based on Voice technology first, if it fails use other format.

public String getDisplayMessageBody ()

Added in API level 4

Returns the message body, or email message body if this message was from an email gateway. Returns null if message body unavailable.

public String getDisplayOriginatingAddress ()

Added in API level 4

Returns the originating address, or email from address if this message was from an email gateway. Returns null if originating address unavailable.

public String getEmailBody ()

Added in API level 4

Returns
  • if isEmail() is true, body of the email sent through the gateway. null otherwise

public String getEmailFrom ()

Added in API level 4

Returns
  • if isEmail() is true, email from address of email sent through the gateway. null otherwise

public int getIndexOnIcc ()

Added in API level 4

Returns the record index of the message on the ICC (1-based index).

Returns
  • the record index of the message on the ICC, or -1 if this SmsMessage was not created from a ICC SMS EF record.

public int getIndexOnSim ()

Added in API level 4

This method was deprecated in API level 4.
Use getIndexOnIcc instead.

Returns the record index of the message on the SIM (1-based index).

Returns
  • the record index of the message on the SIM, or -1 if this SmsMessage was not created from a SIM SMS EF record.

public String getMessageBody ()

Added in API level 4

Returns the message body as a String, if it exists and is text based.

Returns
  • message body is there is one, otherwise null

public SmsMessage.MessageClass getMessageClass ()

Added in API level 4

Returns the class of this message.

public String getOriginatingAddress ()

Added in API level 4

Returns the originating address (sender) of this SMS message in String form or null if unavailable

public byte[] getPdu ()

Added in API level 4

Returns the raw PDU for the message.

Returns
  • the raw PDU for the message.

public int getProtocolIdentifier ()

Added in API level 4

Get protocol identifier.

public String getPseudoSubject ()

Added in API level 4

Unofficial convention of a subject line enclosed in parens empty string if not present

public String getServiceCenterAddress ()

Added in API level 4

Returns the address of the SMS service center that relayed this message or null if there is none.

public int getStatus ()

Added in API level 4

GSM: For an SMS-STATUS-REPORT message, this returns the status field from the status report. This field indicates the status of a previously submitted SMS, if requested. See TS 23.040, 9.2.3.15 TP-Status for a description of values. CDMA: For not interfering with status codes from GSM, the value is shifted to the bits 31-16. The value is composed of an error class (bits 25-24) and a status code (bits 23-16). Possible codes are described in C.S0015-B, v2.0, 4.5.21.

Returns
  • 0 indicates the previously sent message was received. See TS 23.040, 9.9.2.3.15 and C.S0015-B, v2.0, 4.5.21 for a description of other possible values.

public int getStatusOnIcc ()

Added in API level 4

Returns the status of the message on the ICC (read, unread, sent, unsent).

Returns
  • the status of the message on the ICC. These are: SmsManager.STATUS_ON_ICC_FREE SmsManager.STATUS_ON_ICC_READ SmsManager.STATUS_ON_ICC_UNREAD SmsManager.STATUS_ON_ICC_SEND SmsManager.STATUS_ON_ICC_UNSENT

public int getStatusOnSim ()

Added in API level 4

This method was deprecated in API level 4.
Use getStatusOnIcc instead.

Returns the status of the message on the SIM (read, unread, sent, unsent).

Returns
  • the status of the message on the SIM. These are: SmsManager.STATUS_ON_SIM_FREE SmsManager.STATUS_ON_SIM_READ SmsManager.STATUS_ON_SIM_UNREAD SmsManager.STATUS_ON_SIM_SEND SmsManager.STATUS_ON_SIM_UNSENT

public static SmsMessage.SubmitPdu getSubmitPdu ( String scAddress, String destinationAddress, short destinationPort, byte[] data, boolean statusReportRequested)

Added in API level 4

Get an SMS-SUBMIT PDU for a data message to a destination address & port. This method will not attempt to use any GSM national language 7 bit encodings.

Parameters
scAddress Service Centre address. null == use default
destinationAddress the address of the destination for the message
destinationPort the port to deliver the message to at the destination
data the data for the message
Returns
  • a SubmitPdu containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.

public static SmsMessage.SubmitPdu getSubmitPdu ( String scAddress, String destinationAddress, String message, boolean statusReportRequested)

Added in API level 4

Get an SMS-SUBMIT PDU for a destination address and a message. This method will not attempt to use any GSM national language 7 bit encodings.

Parameters
scAddress Service Centre address. Null means use default.
Returns
  • a SubmitPdu containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.

public static int getTPLayerLengthForPDU ( String pdu)

Added in API level 4

Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header FIXME: This method is only used by a CTS test case that isn't run on CDMA devices. We should probably deprecate it and remove the obsolete test case.

public long getTimestampMillis ()

Added in API level 4

Returns the service centre timestamp in currentTimeMillis() format

public byte[] getUserData ()

Added in API level 4

returns the user data section minus the user data header if one was present.

public boolean isCphsMwiMessage ()

Added in API level 4

Returns true for CPHS MWI toggle message.

Returns
  • true if this is a CPHS MWI toggle message See CPHS 4.2 section B.4.2

public boolean isEmail ()

Added in API level 4

Returns true if message is an email.

Returns
  • true if this message came through an email gateway and email sender / subject / parsed body are available

public boolean isMWIClearMessage ()

Added in API level 4

returns true if this message is a CPHS voicemail / message waiting indicator (MWI) clear message

public boolean isMWISetMessage ()

Added in API level 4

returns true if this message is a CPHS voicemail / message waiting indicator (MWI) set message

public boolean isMwiDontStore ()

Added in API level 4

returns true if this message is a "Message Waiting Indication Group: Discard Message" notification and should not be stored.

public boolean isReplace ()

Added in API level 4

See TS 23.040 9.2.3.9 returns true if this is a "replace short message" SMS

public boolean isReplyPathPresent ()

Added in API level 4

Returns true iff the TP-Reply-Path bit is set in this message.

public boolean isStatusReportMessage ()

Added in API level 4

Return true iff the message is a SMS-STATUS-REPORT message.