Sun Java System Messaging Server 6.3 Administration Reference

SMS Fields

The SMS fields options control SMS-specific fields in generated SMS messages. These options are described in Table 4–31.

Table 4–31 SMS Channel Options: SMS Fields

Option  

Description  

DEFAULT_DESTINATION_NPI (Integer, 0-255)

Default NPI for SMS destination addresses. By default, destination addresses are assigned an NPI (Numeric Plan Indicator) value of zero. With this option, an integer value in the range 0 to 255 may be assigned. Typical NPI values include:

0—Unknown

1—ISDN (E.163, E.164)

3—Data (X.121)

4—Telex (F.69)

6—Land Mobile (E.212)

8—National

9—Private

10—ERMES

14—IP address (Internet)

18—WAP client ID

>=19— Undefined

Values for this option may be specified in one of three ways: 

  • A decimal value (for example, 10).

  • A hexadecimal value prefixed by 0x (for example, 0x0a).

  • One of the following case-insensitive text strings (the associated decimal value is shown in parentheses): data (3), default (0), e.163 (1), e.212 (6), ermes (10), f.69 (4), internet (14), ip (14), isdn (1), land-mobile (6), national (8), private (9), telex (4), unknown (0), wap (18), x.121 (3).

DEFAULT_DESTINATION_TON (Integer, 0-255)

Default TON for SMS destination addresses. By default, destination addresses are assigned a TON (Type of Number) designator value of zero. With this option, an alternate integer value in the range of 0 to 255 may be assigned. Typical TON values include:

0—Unknown

1—International

2—National

3—Network- specific

4—Subscriber number

5—Alphanumeric

6—Abbreviated

>=7—Undefined

Values for this option may be specified in one of three ways: 

  • A decimal value (for example, 10).

  • A hexadecimal value prefixed by 0x (for example, 0x0a).

  • One of the following case-insensitive text strings (the associated decimal value is shown in parentheses): abbreviated (6), alphanumeric (5), default (0), international (1), national (2), network-specific (3), subscriber (4), unknown (0).

DEFAULT_PRIORITY (Integer, 0-255)

Default priority setting for SMS messages. All SMS messages have a mandatory priority field. The interpretation of SMS priority values is described in Table 4–32.

With this option, the default priority to assign to SMS messages may be specified. When not specified, a default priority of 0 is used for PROFILE=GSM and CDMA, and a priority of 1 for PROFILE=TDMA.

Note that if USE_HEADER_PRIORITY=1 and an email message has an RFC822 Priority: header line, then the priority specified in that header line is instead used to set the priority of the resulting SMS message. Specifically, the results are as follows:

0—The SMS priority flag is always set in accord with the DEFAULT_PRIORITY option. The RFC822 Priority: header line is always ignored.

1 (default)—The originating email message’s RFC822 Priority: header line is used to set the SMS message’s priority flag. If that header line is not present, then the SMS priority flag is set using the DEFAULT_PRIORITY option.

In translating RFC822 Priority: header line values to SMS priority flags, the mappings used are described in Table 4–33.

DEFAULT_PRIVACY (Integer, -1, 0-255)

Default privacy value flag for SMS messages. Whether or not to set the privacy flag in an SMS message, and what value to use is controlled by the DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY options. By default, a value of -1 is used for DEFAULT_PRIVACY.

The results from the combination of DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY values are described in Table 4–34.

The SMS interpretation of privacy values is as follows: 

  • 0—Unrestricted

  • 1—Restricted

  • 2—Confidential

  • 3—Secret

  • >=4—Undefined

    To translate Sensitivity: header line values to SMS privacy values, the following mapping is used:

  • Personal—1 (Restricted

  • Private—2 (Confidential)

DEFAULT_SERVICE_TYPE (String, 055 bytes)

SMS application service associated with submitted SMS messages. By default, no service type is specified (that is, a zero length string). Some common service types are: CMT (cellular messaging), SPT (cellular paging), VMN (voice mail notification), VMA (voice mail alerting), WAP (wireless application protocol), and USSD (unstructured supplementary data services). 

DEFAULT_SOURCE_ADDRESS (String, 0-20 bytes)

Default SMS source address to use for SMS messages generated from email messages. Note that the value specified with this option is typically overridden by the email message’s originator address when SET_SMS_SOURCE_ADDRESS=1. The default is no source address is specified (0 length string).

DEFAULT_SOURCE_NPI (Integer, 0-255)

Default NPI for SMS source addresses. By default, source addresses are assigned an NPI value of zero. With this option, an alternate integer value in the range of 0 to 255 may be assigned. See the description of the DEFAULT_DESTINATION_NPI option for a list of typical NPI values.

DEFAULT_SOURCE_TON (Integer, 0-255)

Default TON for SMS source addresses. By default, source addresses are assigned a TON designator value of zero. With this option, an alternate integer value in the range of 0 to 255 may be assigned. See the description of the DEFAULT_DESTINATION_TON option for a list of typical TON values.

DEFAULT_VALIDITY_PERIOD (String, 0-252 bytes)

Default validity period for SMS messages. This option specifies a different relative validity period. By default, SMS messages are given no relative validity period, using the SMSC’s default value. Values may be specified in units of seconds, minutes, hours, or days: 

nnn—Implicit units of seconds; for example, 604800nnns—Units of seconds; for example, 604800snnnm—Units of minutes; for example, 10080mnnnh—Units of hours; for example, 168hnnnd—Units of days, for example, 7d

A specification of 0, 0s, 0m, 0h, or 0d may be used to select the SMSC’s default validity period. That is, when a specification of 0, 0s, 0m, 0h, or 0d is used, an empty string is specified for the validity period in generated SMS messages.

Note that this option does not accept values in UTC format. 

DEFAULT_ADDRESS_NUMERIC (0 or 1)

Reduce the destination SMS address to only the characters 0-9. This option strips all non-numeric characters from the SMS destination address extracted from the email envelope To: address. For instance, if the envelope To: address is: 

"(800) 555-1212"@sms.siroe.com

then it will be reduced to: 

8005551212@sms.siroe.com

To enable this stripping, specify a value of 1 for this option. By default, this stripping is disabled which corresponds to an option value of 0. Note that when enabled, the stripping is performed before any destination address prefix is added via the DESTINATION_ADDRESS_PREFIX option.

DESTINATION_ADDRESS_PREFIX (String)

Text string with which to prefix destinationSMS addresses. In some instances, it may be necessary to ensure that all SMS destination addresses are prefixed with a fixed text string; for example, “+”. This option may be used to specify just such a prefix. The prefix will then be added to any SMS destination address which lacks the specified prefix. To prevent being stripped by the DESTINATION_ADDRESS_NUMERIC option, this option is applied after the DESTINATION_ADDRESS_NUMERIC option.

PROFILE (String)

Specifies the SMS profile to use with the SMSC. Possible values are GSM, TDMA, and CDMA. When not specified, GSM is assumed. This option is only used to select defaults for other channel options such as DEFAULT_PRIORITY and DEFAULT_PRIVACY.

SET_SMS_SOURCE_ADDRESS (0 or 1)

Set the SMS source address to the originator address of the email message. Use of this option forces the SMS source address TON to be set to alphanumeric (0x05), and the SMS source address to be an originator address extracted from the email message. As email messages may have a number of originator addresses, the particular address chosen is the one most likely to be the address to which any replies should be directed. Consequently, the choice is made from one of the seven header lines described in Table 4–35, listed in order of decreasing preference:

The selected address is reduced to just its local and domain parts; that is, any source route, phrase, or comments are stripped from the address. Furthermore, if the length of the reduced address exceeds 20 bytes, it will be truncated to 20 bytes. 

When none of the seven listed header lines are suitable, the default source SMS address is instead used as specified with the DEFAULT_SOURCE_ADDRESS option. In that case, the TON is set as per the DEFAULT_SOURCE_TON.

To enable this option, specify SET_SMS_SOURCE_ADDRESS=1. By default, this option is enabled.

USE_SAR (0 or 1)

Sequence multiple SMS messages using the SMS sar_fields. Sufficiently large email messages may need to be broken into multiple SMS messages. When this occurs, the individual SMS messages can optionally have sequencing information added using the SMS sar_ fields. This produces a “segmented” SMS message which can be re-assembled into a single SMS message by the receiving terminal. Specify USE_SAR=1 to indicate that this sequencing information is to be added when applicable. The default is to not add sequencing information and corresponds to USE_SAR=0.

When USE_SAR=1 is specified, the REVERSE_ORDER option is ignored.

Table 4–32 describes the interpretation of the priority field for the DEFAULT_PRIORITY option.

Table 4–32 Priority Fields for DEFAULT_PRIORITY

Value  

GSM  

TDMA  

CDMA  

Non-priority 

Bulk 

Normal 

Priority 

Normal 

Interactive 

Priority 

Urgent 

Urgent 

Priority 

Urgent 

Emergency 

Table 4–33 describes the mappings used in translating Priority: header line values to SMS priority flags for the DEFAULT_PRIORITY option.

Table 4–33 Mappings for Priority Flags

RFC822  

SMS Priority Flag  

 

 

Priority: value  

GSM  

TDMA  

CDMA  

Third 

Non-priority (0) 

Bulk (0) 

Normal (0) 

Second 

Non-priority (0) 

Bulk (0) 

Normal (0) 

Non-urgent 

Non-priority (0) 

Bulk (0) 

Normal (0) 

Normal 

Non-priority (0) 

Normal (1) 

Normal (0) 

Urgent 

Priority (1) 

Urgent (2) 

Urgent (2) 

The results from the combination of DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY values are described in Table 4–34.

Table 4–34 Results from DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY Values

DEFAULT_PRIVACY  

USE_HEADER_SENSITIVITY  

Result  

The SMS privacy flag is never set in SMS messages. 

n >=0 

The SMS privacy flag is always set to the value n. RFC822 Sensitivity: header lines are always ignored. 

-1 (default 

1 (default) 

The SMS message’s privacy flag is only set when the originating email message has an RFC822 Sensitivity: header line. In that case, the SMS privacy flag is set to correspond to the Sensitivity: header line’s value. This is the default.

n >= 0 

The SMS message’s privacy flag is set to correspond to the originating email message’s RFC822 Sensitivity: header line. If the email message does not have a Sensitivity: header line, then the value of the SMS privacy flag is set to n.

Table 4–35 describes the seven header lines used with the SET_SMS_SOURCE_ADDRESS option, their restrictions and SMS source address TON (if applicable) in decreasing preference.

Table 4–35 SET_SMS_SOURCE_ADDRESS Header Restrictions

Email message field  

Restrictions  

TON  

1. Resent-reply-to: 

Requires USE_HEADER_RESENT=1 and USE_HEADER_REPLY_TO=1

 

2. Resent-from: 

Requires USE_HEADER_RESENT=1

 

3. Reply-to: 

Requires USE_HEADER_REPLY_TO=1

0x05 

4. From: 

   

5. Resent-sender: 

Requires USE_HEADER_RESENT=1

 

6. Sender: 

   

7.Envelope From: 

   

8. DEFAULT_SOURCE_ADDRESS

Used as a last resort (that is, when the envelope From: address is empty) 

As per DEFAULT_SOURCE_TON