SMPP Control

Properties   Methods   Events   Config Settings   Errors  

The SMPP Control implements a lightweight message transmission interface using the Short Message Peer-to-Peer protocol, most known for its use in cellular text messaging.

Syntax

SMPP

Remarks

The SMPP control supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The Smpp Control will bind as a transceiver, and thus it can send and receive messages from the server. Additionally, it can send single and multirecipient messages and also can upload data.

Using Smpp is quite easy. First, simply set the SMPPServer, SMPPPort, and, if needed, the SMPPVersion properties. Second, a single call to the Connect method with a specified user Id and password will connect the control.

Transmitting messages is just as easy. You can manipulate the Recipients properties directly, or just use AddRecipient method to add recipients one at a time to the recipient list. After all recipients have been added, a single call to the SendMessage method will transmit the specified message. If the send is successful, the method will set and return the value of the MessageId property. Otherwise, an Error event will fire for each unsuccessful message destination.

The Smpp Control supports message and data transmission, as well as auxiliary operations, such as CheckMessageStatus and ReplaceMessage. All nonimplemented features of the protocol are supported through the SendCommand method and PITrail event. Because of the nature of the protocol, all methods and operations are implemented synchronously.

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

Connected Property (SMPP Control)

This property indicates whether the control is connected.

Syntax

smppcontrol.Connected

Default Value

False

Remarks

This property indicates whether the control is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (SMPP Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

smppcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SMPP Control)

The type of firewall to connect through.

Syntax

smppcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SMPP Control)

The name or IP address of the firewall (optional).

Syntax

smppcontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (SMPP Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

smppcontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (SMPP Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

smppcontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SMPP Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

smppcontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (SMPP Control)

The current status of the control.

Syntax

smppcontrol.Idle

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (SMPP Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

smppcontrol.LocalHost[=string]

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageExpiration Property (SMPP Control)

This property denotes the validity period of the current message.

Syntax

smppcontrol.MessageExpiration[=string]

Default Value

""

Remarks

This property indicates the Message Center expiration time, after which the message should be discarded if not delivered to the destination. It can be set using absolute or relative time formats.

Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:

Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".

Data Type

String

MessageId Property (SMPP Control)

This property indicates the identifier of the most recently sent message.

Syntax

smppcontrol.MessageId

Default Value

""

Remarks

This property indicates the identifier of the most recently sent message. After a successful call to SendMessage, this property will be set to the server-assigned Id for that message.

This property is read-only and not available at design time.

Data Type

String

MessagePriority Property (SMPP Control)

This property indicates the priority level of the current message.

Syntax

smppcontrol.MessagePriority[=integer]

Possible Values

smppMessagePriorityLow(0), 
smppMessagePriorityNormal(1), 
smppMessagePriorityHigh(2), 
smppMessagePriorityUrgent(3)

Default Value

1

Remarks

When sending a message, this property will tell the server what type of priority to assign to the message. The effect of the message priority setting depends on the Message Center (MC) manufacturer and the network on which the target recipient lies. For example, some MCs may immediately forward "urgent" messages, some networks may use the priority setting as a visual indicator of the message's urgency (e.g., blinking icons), and some networks may entirely ignore the priority setting.

Data Type

Integer

Password Property (SMPP Control)

This property contains the user's password.

Syntax

smppcontrol.Password[=string]

Default Value

""

Remarks

This property contains the user's password. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.

The two ways to bind are (1) by calling Connect with a user identifier and password, which will set the UserId and this property before connecting; or (2) by setting those two properties and calling SendMessage while not connected.

Data Type

String

Protocol Property (SMPP Control)

This property defines the SMPP protocol to be used.

Syntax

smppcontrol.Protocol[=integer]

Possible Values

smppSMPP(0), 
smppCIMD2(1)

Default Value

0

Remarks

This property defines the protocol to be used when connecting to the server. Possible values are as follows:

Data Type

Integer

RecipientCount Property (SMPP Control)

The number of records in the Recipient arrays.

Syntax

smppcontrol.RecipientCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientAddress
• RecipientType

The array indices start at 0 and end at RecipientCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientAddress Property (SMPP Control)

This property contains the email address of a particular recipient.

Syntax

smppcontrol.RecipientAddress(RecipientIndex)[=string]

Default Value

""

Remarks

This property contains the email address of a particular recipient. This can be used to set single or multiple recipients. The RecipientType contains the corresponding type.

For a recipient type of normal, the value in the RecipientAddress should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCount property.

This property is not available at design time.

Data Type

String

RecipientType Property (SMPP Control)

This property contains the type of a particular recipient.

Syntax

smppcontrol.RecipientType(RecipientIndex)[=integer]

Possible Values

smppRecipientTypeNormal(0), 
smppRecipientTypeList(1)

Default Value

0

Remarks

This property contains the type of a particular recipient. This property is used only for multiple recipient messages. The RecipientAddress contains the corresponding recipient's address.

For a recipient type of normal, the value in RecipientAddress should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.

Valid values for RecipientType are as follows:

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCount property.

This property is not available at design time.

Data Type

Integer

ScheduledDelivery Property (SMPP Control)

This property tells the server when to deliver the current message.

Syntax

smppcontrol.ScheduledDelivery[=string]

Default Value

""

Remarks

This property is used by the control when sending a message to inform the Message Center to forward the message to the intended recipients at a specific time. It can be set using absolute or relative time formats.

Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:

Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".

Data Type

String

SenderAddress Property (SMPP Control)

This property contains the address of the External Short Messaging Entity (ESME).

Syntax

smppcontrol.SenderAddress[=string]

Default Value

""

Remarks

This property contains the address of the External Short Messaging Entity (ESME). The SMPP protocol allows an ESME to specify its address, whether it is a phone number or an IP address. If this property is not set, the control will default to the value in LocalHost.

Data Type

String

ServiceType Property (SMPP Control)

This property indicates the type of service for the current message.

Syntax

smppcontrol.ServiceType[=integer]

Possible Values

smppServiceDefault(0), 
smppServiceCMT(1), 
smppServiceCPT(2), 
smppServiceVMN(3), 
smppServiceVMA(4), 
smppServiceWAP(5), 
smppServiceUSSD(6), 
smppServiceCBS(7)

Default Value

0

Remarks

When sending messages, this property is used to define the SMS application service to be associated with the message. The Message Center (MC) will use the value to determine the availability of enhanced messaging services and to control the teleservice used on the air interface.

The values are defined in the SMPP 5.0 specification as follows:

Data Type

Integer

SMPPPort Property (SMPP Control)

This property contains the server port for secure SMPP (default 2775).

Syntax

smppcontrol.SMPPPort[=integer]

Default Value

2775

Remarks

For an implicit Secure Sockets Layer (SSL), use port 3551 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SMPPServer Property (SMPP Control)

This property is the SMPP entity to which the control will connect.

Syntax

smppcontrol.SMPPServer[=string]

Default Value

""

Remarks

This property is the instant messaging server to which the control will connect when the Connect method is called. This property must contain a valid SMPP service application address.

Data Type

String

SMPPVersion Property (SMPP Control)

This property indicates the SMPP version to be used throughout the connection.

Syntax

smppcontrol.SMPPVersion[=integer]

Possible Values

smppVersion50(0), 
smppVersion34(1), 
smppVersion33(2)

Default Value

1

Remarks

This property contains the SMPP version to be used throughout the connection.

The default value is version 3.4 because it is the most widely used version of the protocol.

Choosing the highest mutually supported version is generally recommended. Version 3.4 is the default value; however, if version 5.0 is supported, it is recommended.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (SMPP Control)

The date on which this certificate becomes valid.

Syntax

smppcontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (SMPP Control)

The date on which the certificate expires.

Syntax

smppcontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (SMPP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

smppcontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (SMPP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (SMPP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (SMPP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (SMPP Control)

The issuer of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (SMPP Control)

The private key of the certificate (if available).

Syntax

smppcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (SMPP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

smppcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (SMPP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

smppcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (SMPP Control)

The public key of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (SMPP Control)

The textual description of the certificate's public key algorithm.

Syntax

smppcontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (SMPP Control)

The length of the certificate's public key (in bits).

Syntax

smppcontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (SMPP Control)

The serial number of the certificate encoded as a string.

Syntax

smppcontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (SMPP Control)

The text description of the certificate's signature algorithm.

Syntax

smppcontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (SMPP Control)

The name of the certificate store for the client certificate.

Syntax

smppcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (SMPP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

smppcontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (SMPP Control)

The type of certificate store for this certificate.

Syntax

smppcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (SMPP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

smppcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (SMPP Control)

The MD5 hash of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (SMPP Control)

The SHA-1 hash of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (SMPP Control)

The SHA-256 hash of the certificate.

Syntax

smppcontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (SMPP Control)

The text description of UsageFlags .

Syntax

smppcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (SMPP Control)

The flags that show intended use for the certificate.

Syntax

smppcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (SMPP Control)

The certificate's version number.

Syntax

smppcontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (SMPP Control)

The subject of the certificate used for client authentication.

Syntax

smppcontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (SMPP Control)

The certificate (PEM/Base64 encoded).

Syntax

smppcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (SMPP Control)

The date on which this certificate becomes valid.

Syntax

smppcontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (SMPP Control)

The date on which the certificate expires.

Syntax

smppcontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (SMPP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

smppcontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (SMPP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

smppcontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (SMPP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

smppcontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (SMPP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

smppcontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (SMPP Control)

The issuer of the certificate.

Syntax

smppcontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (SMPP Control)

The private key of the certificate (if available).

Syntax

smppcontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (SMPP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

smppcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (SMPP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

smppcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (SMPP Control)

The public key of the certificate.

Syntax

smppcontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (SMPP Control)

The textual description of the certificate's public key algorithm.

Syntax

smppcontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (SMPP Control)

The length of the certificate's public key (in bits).

Syntax

smppcontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (SMPP Control)

The serial number of the certificate encoded as a string.

Syntax

smppcontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (SMPP Control)

The text description of the certificate's signature algorithm.

Syntax

smppcontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (SMPP Control)

The name of the certificate store for the client certificate.

Syntax

smppcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (SMPP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

smppcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SMPP Control)

The type of certificate store for this certificate.

Syntax

smppcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (SMPP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

smppcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (SMPP Control)

The MD5 hash of the certificate.

Syntax

smppcontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (SMPP Control)

The SHA-1 hash of the certificate.

Syntax

smppcontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (SMPP Control)

The SHA-256 hash of the certificate.

Syntax

smppcontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (SMPP Control)

The text description of UsageFlags .

Syntax

smppcontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (SMPP Control)

The flags that show intended use for the certificate.

Syntax

smppcontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (SMPP Control)

The certificate's version number.

Syntax

smppcontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (SMPP Control)

The subject of the certificate used for client authentication.

Syntax

smppcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (SMPP Control)

The certificate (PEM/Base64 encoded).

Syntax

smppcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (SMPP Control)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

smppcontrol.SSLEnabled[=boolean]

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the control. When False (default), the control operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (SMPP Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

smppcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (SMPP Control)

The date on which this certificate becomes valid.

Syntax

smppcontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (SMPP Control)

The date on which the certificate expires.

Syntax

smppcontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (SMPP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

smppcontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (SMPP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

smppcontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (SMPP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

smppcontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (SMPP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

smppcontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (SMPP Control)

The issuer of the certificate.

Syntax

smppcontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (SMPP Control)

The private key of the certificate (if available).

Syntax

smppcontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (SMPP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

smppcontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (SMPP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

smppcontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (SMPP Control)

The public key of the certificate.

Syntax

smppcontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (SMPP Control)

The textual description of the certificate's public key algorithm.

Syntax

smppcontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (SMPP Control)

The length of the certificate's public key (in bits).

Syntax

smppcontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (SMPP Control)

The serial number of the certificate encoded as a string.

Syntax

smppcontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (SMPP Control)

The text description of the certificate's signature algorithm.

Syntax

smppcontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (SMPP Control)

The name of the certificate store for the client certificate.

Syntax

smppcontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (SMPP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

smppcontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (SMPP Control)

The type of certificate store for this certificate.

Syntax

smppcontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (SMPP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

smppcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (SMPP Control)

The MD5 hash of the certificate.

Syntax

smppcontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (SMPP Control)

The SHA-1 hash of the certificate.

Syntax

smppcontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (SMPP Control)

The SHA-256 hash of the certificate.

Syntax

smppcontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (SMPP Control)

The text description of UsageFlags .

Syntax

smppcontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (SMPP Control)

The flags that show intended use for the certificate.

Syntax

smppcontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (SMPP Control)

The certificate's version number.

Syntax

smppcontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (SMPP Control)

The subject of the certificate used for client authentication.

Syntax

smppcontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (SMPP Control)

The certificate (PEM/Base64 encoded).

Syntax

smppcontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

SSLStartMode Property (SMPP Control)

This property determines how the control starts the Secure Sockets Layer (SSL) negotiation.

Syntax

smppcontrol.SSLStartMode[=integer]

Possible Values

sslAutomatic(0), 
sslImplicit(1), 
sslExplicit(2), 
sslNone(3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

SystemType Property (SMPP Control)

This property contains a string representing the type of system during a connection.

Syntax

smppcontrol.SystemType[=string]

Default Value

""

Remarks

This property contains a string representing the type of system during a connection. Some SMS servers require that a system type be supplied during connection. The system type is a string representation, usually as an abbreviation, of a particular kind of system. The string cannot exceed 12 bytes.

Data Type

String

Timeout Property (SMPP Control)

The timeout for the control.

Syntax

smppcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (SMPP Control)

This property is used for identification with the SMPP service.

Syntax

smppcontrol.UserId[=string]

Default Value

""

Remarks

This property is used for identification with the SMPP service. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.

The two ways to bind are (1) by calling Connect with a user Id and password, which will set the UserId and Password properties before connecting; or (2) by setting those two properties and calling SendMessage while not connected.

Data Type

String

AddRecipient Method (SMPP Control)

This method will add a recipient of the specified type to the recipient list.

Syntax

smppcontrol.AddRecipient RecipientType, RecipientAddress

Remarks

This method will add a recipient of the specified type to the recipient list. For normal-type recipients, the addresses should be either a dotted IPv4 address (for sending messages to other SMS-enabled applications) or the directory number of a mobile phone. To send messages to distributed lists, the name of the list should be used.

Valid values for RecipientType are as follows:

CancelMessage Method (SMPP Control)

This method will cancel the specified message.

Syntax

smppcontrol.CancelMessage MessageId

Remarks

This method will cancel the message stored on the SMPPServer under the value in MessageId.

CheckLink Method (SMPP Control)

This method will check the connection to the server.

Syntax

smppcontrol.CheckLink 

Remarks

This method will check the connection to the server. This method is used to ensure that the host on the other end of the connection is still active, or that it is still available. Although a socket connection may still be available between the client and server, the SMS application on the server may have been taken offline without releasing the socket or the CPU may be bogged down. This method will send a PDU to the server and wait the length of Timeout for a response.

CheckMessageStatus Method (SMPP Control)

This method will retrieve the status of the specified message.

Syntax

smppcontrol.CheckMessageStatus MessageId

Remarks

This method will retrieve the last known status of the message stored on the server under MessageId. The control will fire a MessageStatus containing the parsed response from the server.

Config Method (SMPP Control)

Sets or retrieves a configuration setting.

Syntax

smppcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SMPP Control)

This method will bind as a transceiver to the SMPP service.

Syntax

smppcontrol.Connect 

Remarks

This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has been completed, a Connected event will be fired containing the status of the connection.

ConnectTo Method (SMPP Control)

This method will bind as a transceiver to the SMPP service.

Syntax

smppcontrol.ConnectTo UserId, Password

Remarks

This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has completed, a Connected event will be fired containing the status of the connection.

Disconnect Method (SMPP Control)

This method will disconnect from the SMPP service.

Syntax

smppcontrol.Disconnect 

Remarks

This method will send an unbind command and close the socket connection to the SMPPServer. After an unbind operation and socket closing, a Disconnected event will be fired containing the status of the unbind operation.

DoEvents Method (SMPP Control)

This method processes events from the internal message queue.

Syntax

smppcontrol.DoEvents 

Remarks

When this method is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (SMPP Control)

This method interrupts the current method.

Syntax

smppcontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ReplaceMessage Method (SMPP Control)

This method replaces a previously sent message with a new one.

Syntax

smppcontrol.ReplaceMessage MessageId, NewMessage

Remarks

Assuming that a message on the SMPPServer is being stored under the value in MessageId, this method will replace that message with the value in NewMessage.

If no message corresponds to MessageId, the SMS service will respond with an error message.

Reset Method (SMPP Control)

This method will reset the control.

Syntax

smppcontrol.Reset 

Remarks

This method will reset the control's properties to their default values.

SendCommand Method (SMPP Control)

This method will format and send a protocol data unit (PDU) using the specified command identifier and payload.

Syntax

smppcontrol.SendCommand CommandId, Payload

Remarks

This method offers a way to do more with the control than is directly supported. This method takes a command identifier and a payload, which includes every required and optional field after the header, and creates the 16-byte header for it before sending it to the server. The response PDU is returned both in the PITrail and by this method.

SendData Method (SMPP Control)

This method sends raw data to Recipients .

Syntax

smppcontrol.SendData Data

Remarks

This method sends raw data to Recipients. Up to 64 KB of additional data can be supplied at a time for transmission to the SMPPServer. Unlike the SendMessage method, this method can send to only one destination at a time. The target is whatever value is in the Recipients properties.

SendMessage Method (SMPP Control)

This method sends a message to all recipients in the recipient list.

Syntax

smppcontrol.SendMessage Message

Remarks

This method sends a message to all recipients in the recipient list. The return value of this method is the server-assigned identifier of the message. The maximum size of the message sent is 256 bytes.

Connected Event (SMPP Control)

This event is fired after a successful bind operation.

Syntax

Sub smppcontrol_Connected(StatusCode As Integer, Description As String)

Remarks

After establishing a socket connection to the SMPPServer, the control will attempt to send a bind as a transmitter command. Upon completion of this operation, the server will respond with either a success or failure state, which will be reflected in the Connected event's parameters.

StatusCode will contain the command status (error code) returned by the server. For a StatusCode of 0, Description will be OK. Otherwise, it will contain a standard interpretation of the error.

ConnectionStatus Event (SMPP Control)

Fired to indicate changes in the connection state.

Syntax

Sub smppcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (SMPP Control)

This event is fired when connection to the SMS service is lost.

Syntax

Sub smppcontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

After sending an unbind operation to the server, this event will be fired containing the results of that operation. This event may also be fired if the socket connection to the service is lost.

If the event was fired because of an unbind operation, StatusCode will contain the command status set by the server. Otherwise, it will contain the socket code for the type of disconnection. For a status code value of 0, Description will contain OK. Otherwise, it will contain a standard interpretation of the value in StatusCode.

Error Event (SMPP Control)

This event is fired when the server detects an error.

Syntax

Sub smppcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

If the server sends an error not related to a command sent from the control, the control will fire an Error event containing information related to the error.

ErrorCode will contain the code sent by the server, and Description will contain a standard interpretation of that code.

MessageIn Event (SMPP Control)

This event is fired upon receipt of a message.

Syntax

Sub smppcontrol_MessageIn(SourceAddress As String, ScheduleDeliveryTime As String, ValidityPeriod As String, Message As String, MessagePart As Integer, MessagePartCount As Integer, MessagePartReference As Integer, DestinationAddress As String, ResponseErrorCode As Integer)

Remarks

When a message is received, the SMPP control will parse the sender's message into the SourceAddress, ScheduleDeliveryTime, ValidityPeriod, and Message fields.

The SourceAddress parameter is the address of the originator of the message.

The DestinationAddress parameter holds the address of the recipient.

The ScheduleDeliveryTime parameter is the delivery time at which the short message is scheduled to be forwarded to another Message Center (MC). This will be an empty string if it is not scheduled.

The ValidityPeriod parameter is applicable only if this short message is being forwarded to another MC. When this occurs, it specifies how long the receiving MC should retain the Short Message (SM) and continue trying to deliver it. This will be an empty string if the current validity period is unavailable.

The Message parameter is the plaintext portion of the message body.

If the incoming message is a part of a larger message (the message was split up into several parts), the MessagePartCount, MessagePart, and MessagePartReference parameters will be set. MessagePartCount will hold the total number of parts for the message. MessagePart will indicate the current part's location in the message to determine the order when reassembling the message. This will be a value from 1 to MessagePartCount. MessagePartReference holds a reference value that will be the same across all parts for the message.

The ResponseErrorCode parameter may be set to return an error condition to the server. This corresponds to the command_status protocol-level field of the response.

MessageStatus Event (SMPP Control)

This event is fired upon receipt of a message.

Syntax

Sub smppcontrol_MessageStatus(MessageId As String, MessageState As Integer, MessageError As Integer, FinalDate As String)

Remarks

When a CheckMessageStatus is called, the SMPP control will retrieve the status of the message represented by MessageId from the server, parse the response, and fire MessageStatus.

MessageState represents the last known state the message was left in on the SMPPServer. This code is version specific. For v3.4:

MessageError will contain an error code representing any failure encountered during message delivery. This code may be vendor-specific.

FinalDate contains a human-readable string representing the date on which the message was delivered. If the message was not delivered, this parameter will be empty.

PITrail Event (SMPP Control)

This event is fired once for each protocol data unit (PDU) sent between the client and server.

Syntax

Sub smppcontrol_PITrail(Direction As Integer, PDU As String, CommandLength As Integer, CommandId As Integer, CommandDescription As String, CommandStatus As String, SequenceNumber As Integer)

Remarks

Whenever either the control or the SMPPServer sends any data across the connection, the control will fire a PITrail event containing that data. It will usually be in SMPP-PDU format.

A PDU will contain at least the SMPP header, which is always 16 bytes long. The first four bytes represent the total length of the PDU, including the 16-byte header. The next four bytes are the command Id associated with the PDU. The command Id of a response PDU is always the command Id to which it is responding plus 0x80000000.

The control parses the values contained in the PDU header into the appropriate fields. The CommandLength, CommandId, CommandStatus, and SequenceNumber parameters contain these parsed values.

The third set of four bytes are the command status (status code) of the command. All originating commands will have a status code of 0x00000000, which will be ignored by the receiver. The field is only set in response PDUs to indicate the status of the originating command. The final four bytes represent the sequence number of the command. All response PDUs will contain the same sequence number as the originating command.

ReadyToSend Event (SMPP Control)

This event is fired when the control is ready to send data.

Syntax

Sub smppcontrol_ReadyToSend()

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (SMPP Control)

Fired after the server presents its certificate to the client.

Syntax

Sub smppcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SMPP Control)

Fired when secure connection progress messages are available.

Syntax

Sub smppcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (SMPP Control)

SMPP Config Settings

[UDH1],[MessagePart1];[UDH2],[MessagePart2];[UDH3],[MessagePart3]

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (SMPP Control)

SMPP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors