Added in API level 1
Deprecated in API level 4

SmsMessage

Kotlin |Java

open class SmsMessage

kotlin.Any
↳	android.telephony.gsm.SmsMessage

A Short Message Service message.

Summary

Nested classes
	`MessageClass` SMS Class enumeration.
open	`SubmitPdu`

Constants
static Int	`ENCODING_16BIT` 16-bit encoding scheme (see TS 23.038)
static Int	`ENCODING_7BIT` 7-bit encoding scheme (see TS 23.038)
static Int	`ENCODING_8BIT` 8-bit encoding scheme (see TS 23.038)
static Int	`ENCODING_UNKNOWN` Unknown encoding scheme (see TS 23.038)
static Int	`MAX_USER_DATA_BYTES` The maximum number of payload bytes per message
static Int	`MAX_USER_DATA_SEPTETS` The maximum number of payload septets per message
static Int	`MAX_USER_DATA_SEPTETS_WITH_HEADER` The maximum number of payload septets per message if a user data header is present.

Public constructors
`SmsMessage()`

Public methods
open static IntArray!	`calculateLength(messageBody: CharSequence!, use7bitOnly: Boolean)` 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.
open static IntArray!	`calculateLength(messageBody: String!, use7bitOnly: Boolean)` 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.
open static SmsMessage!	`createFromPdu(pdu: ByteArray!)` Create an SmsMessage from a raw PDU.
open String!	`getDisplayMessageBody()` Returns the message body, or email message body if this message was from an email gateway.
open String!	`getDisplayOriginatingAddress()` Returns the originating address, or email from address if this message was from an email gateway.
open String!	`getEmailBody()`
open String!	`getEmailFrom()`
open Int	`getIndexOnSim()` Returns the record index of the message on the SIM (1-based index).
open String!	`getMessageBody()` Returns the message body as a String, if it exists and is text based.
open SmsMessage.MessageClass!	`getMessageClass()` Returns the class of this message.
open String!	`getOriginatingAddress()` Returns the originating address (sender) of this SMS message in String form or null if unavailable
open ByteArray!	`getPdu()` Returns the raw PDU for the message.
open Int	`getProtocolIdentifier()` Get protocol identifier.
open String!	`getPseudoSubject()` Unofficial convention of a subject line enclosed in parens empty string if not present
open String!	`getServiceCenterAddress()` Returns the address of the SMS service center that relayed this message or null if there is none.
open Int	`getStatus()` GSM: For an SMS-STATUS-REPORT message, this returns the status field from the status report.
open Int	`getStatusOnSim()` Returns the status of the message on the SIM (read, unread, sent, unsent).
open static SmsMessage.SubmitPdu!	`getSubmitPdu(scAddress: String!, destinationAddress: String!, message: String!, statusReportRequested: Boolean)` Get an SMS-SUBMIT PDU for a destination address and a message
open static SmsMessage.SubmitPdu!	`getSubmitPdu(scAddress: String!, destinationAddress: String!, destinationPort: Short, data: ByteArray!, statusReportRequested: Boolean)` Get an SMS-SUBMIT PDU for a data message to a destination address & port
open static Int	`getTPLayerLengthForPDU(pdu: String!)` Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header
open Long	`getTimestampMillis()` Returns the service centre timestamp in currentTimeMillis() format
open ByteArray!	`getUserData()` returns the user data section minus the user data header if one was present.
open Boolean	`isCphsMwiMessage()` Returns true for CPHS MWI toggle message.
open Boolean	`isEmail()` Returns true if message is an email.
open Boolean	`isMWIClearMessage()` returns true if this message is a CPHS voicemail / message waiting indicator (MWI) clear message
open Boolean	`isMWISetMessage()` returns true if this message is a CPHS voicemail / message waiting indicator (MWI) set message
open Boolean	`isMwiDontStore()` returns true if this message is a "Message Waiting Indication Group: Discard Message" notification and should not be stored.
open Boolean	`isReplace()` See TS 23.
open Boolean	`isReplyPathPresent()` Returns true iff the `TP-Reply-Path` bit is set in this message.
open Boolean	`isStatusReportMessage()` Return true iff the message is a SMS-STATUS-REPORT message.

Constants

ENCODING_16BIT

Added in API level 1

static val ENCODING_16BIT: Int

Deprecated: Use android.telephony.SmsMessage.

16-bit encoding scheme (see TS 23.038)

Value: 3

ENCODING_7BIT

Added in API level 1

static val ENCODING_7BIT: Int

Deprecated: Use android.telephony.SmsMessage.

7-bit encoding scheme (see TS 23.038)

Value: 1

ENCODING_8BIT

Added in API level 1

static val ENCODING_8BIT: Int

Deprecated: Use android.telephony.SmsMessage.

8-bit encoding scheme (see TS 23.038)

Value: 2

ENCODING_UNKNOWN

Added in API level 1

static val ENCODING_UNKNOWN: Int

Deprecated: Use android.telephony.SmsMessage.

Unknown encoding scheme (see TS 23.038)

Value: 0

MAX_USER_DATA_BYTES

Added in API level 1

static val MAX_USER_DATA_BYTES: Int

Deprecated: Use android.telephony.SmsMessage.

The maximum number of payload bytes per message

Value: 140

MAX_USER_DATA_SEPTETS

Added in API level 1

static val MAX_USER_DATA_SEPTETS: Int

Deprecated: Use android.telephony.SmsMessage.

The maximum number of payload septets per message

Value: 160

MAX_USER_DATA_SEPTETS_WITH_HEADER

Added in API level 1

static val MAX_USER_DATA_SEPTETS_WITH_HEADER: Int

Deprecated: Use android.telephony.SmsMessage.

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.

Value: 153

Public constructors

SmsMessage

Added in API level 1

SmsMessage()

Deprecated: Use android.telephony.SmsMessage.

Public methods

calculateLength

Added in API level 3
Deprecated in API level 4

open static fun calculateLength(
    messageBody: CharSequence!, 
    use7bitOnly: Boolean
): IntArray!

Deprecated: Use android.telephony.SmsMessage.

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`	CharSequence!: the message to encode
`use7bitOnly`	Boolean: if true, characters that are not part of the GSM alphabet are counted as a single space char. If false, a messageBody containing non-GSM alphabet characters is calculated for 16-bit encoding.

Return
`IntArray!`	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.

calculateLength

Added in API level 1

open static fun calculateLength(
    messageBody: String!, 
    use7bitOnly: Boolean
): IntArray!

Deprecated: Use android.telephony.SmsMessage.

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`	String!: the message to encode
`use7bitOnly`	Boolean: if true, characters that are not part of the GSM alphabet are counted as a single space char. If false, a messageBody containing non-GSM alphabet characters is calculated for 16-bit encoding.

Return
`IntArray!`	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.

createFromPdu

Added in API level 1

open static fun createFromPdu(pdu: ByteArray!): SmsMessage!

Deprecated: Use android.telephony.SmsMessage.

Create an SmsMessage from a raw PDU.

getDisplayMessageBody

Added in API level 1

open fun getDisplayMessageBody(): String!

Deprecated: Use android.telephony.SmsMessage.

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

getDisplayOriginatingAddress

Added in API level 1

open fun getDisplayOriginatingAddress(): String!

Deprecated: Use android.telephony.SmsMessage.

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

getEmailBody

Added in API level 1

open fun getEmailBody(): String!

Deprecated: Use android.telephony.SmsMessage.

Return
`String!`	if isEmail() is true, body of the email sent through the gateway. null otherwise

getEmailFrom

Added in API level 1

open fun getEmailFrom(): String!

Deprecated: Use android.telephony.SmsMessage.

Return
`String!`	if isEmail() is true, email from address of email sent through the gateway. null otherwise

getIndexOnSim

Added in API level 1

open fun getIndexOnSim(): Int

Deprecated: Use android.telephony.SmsMessage and getIndexOnIcc instead.

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

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

getMessageBody

Added in API level 1

open fun getMessageBody(): String!

Deprecated: Use android.telephony.SmsMessage.

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

Return
`String!`	message body is there is one, otherwise null

getMessageClass

Added in API level 1

open fun getMessageClass(): SmsMessage.MessageClass!

Deprecated: Use android.telephony.SmsMessage.

Returns the class of this message.

getOriginatingAddress

Added in API level 1

open fun getOriginatingAddress(): String!

Deprecated: Use android.telephony.SmsMessage.

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

getPdu

Added in API level 1

open fun getPdu(): ByteArray!

Deprecated: Use android.telephony.SmsMessage.

Returns the raw PDU for the message.

Return
`ByteArray!`	the raw PDU for the message.

getProtocolIdentifier

Added in API level 1

open fun getProtocolIdentifier(): Int

Deprecated: Use android.telephony.SmsMessage.

Get protocol identifier.

getPseudoSubject

Added in API level 1

open fun getPseudoSubject(): String!

Deprecated: Use android.telephony.SmsMessage.

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

getServiceCenterAddress

Added in API level 1

open fun getServiceCenterAddress(): String!

Deprecated: Use android.telephony.SmsMessage.

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

getStatus

Added in API level 1

open fun getStatus(): Int

Deprecated: Use android.telephony.SmsMessage.

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.

Return
`Int`	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.

getStatusOnSim

Added in API level 1

open fun getStatusOnSim(): Int

Deprecated: Use android.telephony.SmsMessage and getStatusOnIcc instead.

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

Return
`Int`	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

getSubmitPdu

Added in API level 1

open static fun getSubmitPdu(
    scAddress: String!, 
    destinationAddress: String!, 
    message: String!, 
    statusReportRequested: Boolean
): SmsMessage.SubmitPdu!

Deprecated: Use android.telephony.SmsMessage.

Get an SMS-SUBMIT PDU for a destination address and a message

Parameters
`scAddress`	String!: Service Centre address. Null means use default.

Return
`SmsMessage.SubmitPdu!`	a `SubmitPdu` containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.

getSubmitPdu

Added in API level 1

open static fun getSubmitPdu(
    scAddress: String!, 
    destinationAddress: String!, 
    destinationPort: Short, 
    data: ByteArray!, 
    statusReportRequested: Boolean
): SmsMessage.SubmitPdu!

Deprecated: Use android.telephony.SmsMessage.

Get an SMS-SUBMIT PDU for a data message to a destination address & port

Parameters
`scAddress`	String!: Service Centre address. null == use default
`destinationAddress`	String!: the address of the destination for the message
`destinationPort`	Short: the port to deliver the message to at the destination
`data`	ByteArray!: the dat for the message

Return
`SmsMessage.SubmitPdu!`	a `SubmitPdu` containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.

getTPLayerLengthForPDU

Added in API level 1

open static fun getTPLayerLengthForPDU(pdu: String!): Int

Deprecated: Use android.telephony.SmsMessage.

Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header

getTimestampMillis

Added in API level 1

open fun getTimestampMillis(): Long

Deprecated: Use android.telephony.SmsMessage.

Returns the service centre timestamp in currentTimeMillis() format

getUserData

Added in API level 1

open fun getUserData(): ByteArray!

Deprecated: Use android.telephony.SmsMessage.

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

isCphsMwiMessage

Added in API level 1

open fun isCphsMwiMessage(): Boolean

Deprecated: Use android.telephony.SmsMessage.

Returns true for CPHS MWI toggle message.

Return
`Boolean`	true if this is a CPHS MWI toggle message See CPHS 4.2 section B.4.2

isEmail

Added in API level 1

open fun isEmail(): Boolean

Deprecated: Use android.telephony.SmsMessage.

Returns true if message is an email.

Return
`Boolean`	true if this message came through an email gateway and email sender / subject / parsed body are available

isMWIClearMessage

Added in API level 1

open fun isMWIClearMessage(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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

isMWISetMessage

Added in API level 1

open fun isMWISetMessage(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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

isMwiDontStore

Added in API level 1

open fun isMwiDontStore(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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

isReplace

Added in API level 1

open fun isReplace(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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

isReplyPathPresent

Added in API level 1

open fun isReplyPathPresent(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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

isStatusReportMessage

Added in API level 1

open fun isStatusReportMessage(): Boolean

Deprecated: Use android.telephony.SmsMessage.

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