SMPP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworks.smpp()

Remarks

The Smpp class supports both plaintext and SSL/TLS connections. When connecting over 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 via the Config method.

The Smpp Class will bind as a transceiver, and thus can send and receive messages from the server. Additionally, it can send single and multi-recipient messages, and 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 class.

Transmitting messages is just as easy. You can manipulate the Recipients properties directly, or just use AddRecipient method to add recipients one-by-one 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 Class supports message and data transmission, as well as auxiliary operations such as CheckMessageStatus and ReplaceMessage. All non-implemented features of the protocol are supported through the SendCommand method and PITrail event. Due to 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 class with short descriptions. Click on the links for further details.

Connected	Indicates whether or not the class is bound.
Firewall	A set of properties related to firewall access.
Idle	The current status of the class.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageExpiration	Denotes the validity period of the current message.
MessageId	The identifier of the most recently sent message.
MessagePriority	The priority level of the current message.
Password	Contains the user's password.
Protocol	The SMPP protocol to be used.
Recipients	A list of message recipients.
ScheduledDelivery	Tells the server when to deliver the current message.
SenderAddress	The address of the ESME.
ServiceType	Indicates the type of service for the current message.
SMPPPort	This property contains the server port for secure SMPP (default 2775).
SMPPServer	The SMPP entity to which the class will connect.
SMPPVersion	The SMPP version to be used throughout the connection.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLEnabled	Whether TLS/SSL is enabled.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCert	The server certificate for the last established connection.
SSLStartMode	Determines how the class starts the SSL negotiation.
SystemType	A string representing the type of system during a connection.
Timeout	A timeout for the class.
UserId	Used for identification with the SMPP service.

Method List

---

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

AddRecipient	Will add a recipient of the specified type to the recipient list.
CancelMessage	Will cancel the specified message.
CheckLink	Will check the connection to the server.
CheckMessageStatus	Will retrieve the status of the specified message.
Config	Sets or retrieves a configuration setting.
Connect	Will bind as a transceiver to the SMPP service.
ConnectTo	Will bind as a transceiver to the SMPP service.
Disconnect	Will disconnect from the SMPP service.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ReplaceMessage	Replaces a previously sent message with a new one.
Reset	Reset the class.
SendCommand	Will format and send a PDU using the specified command identifier and payload.
SendData	Sends raw data to Recipients .
SendMessage	Sends a message to all recipients in the recipient list.

Event List

---

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

Connected	This event is fired after a successful bind operation.
ConnectionStatus	This event is fired to indicate changes in the connection state.
Disconnected	This event is fired when connection to the SMS service is lost.
Error	This event is fired when the server detects an error.
MessageIn	This event is fired upon receipt of a message.
MessageStatus	This event is fired upon receipt of a message.
PITrail	This event is fired once for each PDU sent between the client and server.
ReadyToSend	This event is fired when the class is ready to send data.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Config Settings

---

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

AddressRange	Specifies the addr_range parameter when binding.
BinaryDataCoding	Whether or not to binary encode the message when DataCoding is set.
BindAsReceiver	Causes the class to bind as a receiver.
BindAsTransmitter	Causes the class to bind as a transmitter.
CustomTLV	Optional TLV parameters added after the mandatory parameters and before the payload.
DataCoding	The data encoding mechanism to be used for the current message.
DecodeHexStrings	Will decode an ascii hex-representation of binary data prior to transmission.
DestinationNPI	The Number Planning Indicator for the destination ESME.
DestinationTON	The Type of Number for the destination ESME.
DoSplitLargeMessages	Splits long messages and returns the UDH and Message Parts.
HexString	A hex-encoded binary string to be sent to the current recipient.
IncomingDestinationAddress	Returns the dest_addr field inside the received message.
IntermediateNotification	Causes the class to request intermediate notification.
MaxCIMDSMSLength	Indicates the maximum SMS message length for the CIMD protocol.
MaxSMSLength	Indicates the maximum SMS message length.
MCReceipt	The Type of MC Delivery Receipt requested.
MessageInReceiptedMessageId	The receipted_message_id field of an incoming deliver_sm PDU.
MessageMode	The Type of Messaging Mode requested.
MessageType	The Type of Message.
ProtocolId	The protocol identifier.
SMEAcknowledgement	The Type of SME originated acknowledgement requested.
SourceNPI	The Number Planning Indicator for the ESME.
SourceTON	The Type of Number for the ESME.
SplitLargeMessages	Determines whether large messages are split into multiple parts.
SplitMessageMethod	Determines how large messages are split into multiple parts.
StatusReportRequest	Defines in what cases a status report is created by the server.
SubAddr	Defines a unique index for application instance.
SynchronousSendCommand	Controls whether SendCommand behaves synchronously or asynchronously.
SynchronousSendMessage	Controls whether SendMessage behaves synchronously or asynchronously.
UseGSM7BitEncoding	Whether or not to use GSM 7-bit encoding.
UseGSM7bitEncodingCompression	Whether to compress GSM 7-bit encoded characters.
WaitForBanner	Specifies the CIMD2 banner the class will wait for when connecting.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLAcceptAnyServerCert	Whether to trust any certificate presented by the server.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

SMPP.Connected Property

Indicates whether or not the class is bound.

Syntax

 isConnected(): boolean;

Default Value

FALSE

Remarks

The value of this property indicates whether or not the class has successfully bound to the SMPPServer. It will not be true until a successful Connected event has fired.

There are two ways to bind: by calling Connect with a user identifier and password which will set the UserId and Password properties before connecting; or by setting those two properties and calling SendMessage while not connected.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

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

SMPP.Firewall Property

A set of properties related to firewall access.

Syntax

 getFirewall(): Firewall;


 setFirewall(firewall: Firewall): void;

Default Value

Remarks

This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.

SMPP.Idle Property

The current status of the class.

Syntax

 isIdle(): boolean;

Default Value

TRUE

Remarks

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

This property is read-only.

SMPP.LocalHost Property

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

Syntax

 getLocalHost(): string;


 setLocalHost(localHost: string): void;

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multi-homed 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.

SMPP.MessageExpiration Property

Denotes the validity period of the current message.

Syntax

 getMessageExpiration(): string;


 setMessageExpiration(messageExpiration: string): void;

Default Value

""

Remarks

This property indicates the MC 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:

YY	the last two digits of the year (00-99)
MM	month (01-12)
DD	day (01-31)
hh	hour (00-23)
mm	minute (00-59)
ss	second (00-59)
t	tenths of a second (0-9)
nn	quarter-hour time difference between local time and UTC time (00-48)
p	"+" or "-" indicating the direction of the time offset in nn

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".

SMPP.MessageId Property

The identifier of the most recently sent message.

Syntax

 getMessageId(): string;

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 of that message.

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

SMPP.MessagePriority Property

The priority level of the current message.

Syntax

 getMessagePriority(): SmppMessagePriorities;


 setMessagePriority(messagePriority: SmppMessagePriorities): void;


enum SmppMessagePriorities {
  smppMessagePriorityLow,
  smppMessagePriorityNormal,
  smppMessagePriorityHigh,
  smppMessagePriorityUrgent
}

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 is dependent upon the Message Center 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, etc.), and some networks may entirely ignore the priority setting.

SMPP.Password Property

Contains the user's password.

Syntax

 getPassword(): string;


 setPassword(password: string): void;

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.

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

SMPP.Protocol Property

The SMPP protocol to be used.

Syntax

 getProtocol(): SmppProtocols;


 setProtocol(protocol: SmppProtocols): void;


enum SmppProtocols {
  smppSMPP,
  smppCIMD2
}

Default Value

0

Remarks

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

0 (smppSMPP - default)	SMPP for traditional SMPP servers
1 (smppCIMD2)	CIMD2 for Nokia Short Message Service Center servers

SMPP.Recipients Property

A list of message recipients.

Syntax

 getRecipients(): SMPPRecipientList;


 setRecipients(recipients: SMPPRecipientList): void;

Default Value

Remarks

This property is used to specify the recipient(s) of the message. Each recipient is represented by an SMPPRecipient type, which contains fields for the address and type of address for the recipient.

There is an AddRecipient method which also may be used to add recipients to this collection property.

SMPP.ScheduledDelivery Property

Tells the server when to deliver the current message.

Syntax

 getScheduledDelivery(): string;


 setScheduledDelivery(scheduledDelivery: string): void;

Default Value

""

Remarks

This property is used by the class when sending a message to inform the Message Center (MC) 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:

YY	the last two digits of the year (00-99)
MM	month (01-12)
DD	day (01-31)
hh	hour (00-23)
mm	minute (00-59)
ss	second (00-59)
t	tenths of a second (0-9)
nn	quarter-hour time difference between local time and UTC time (00-48)
p	"+" or "-" indicating the direction of the time offset in nn

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".

SMPP.SenderAddress Property

The address of the ESME.

Syntax

 getSenderAddress(): string;


 setSenderAddress(senderAddress: string): void;

Default Value

""

Remarks

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

SMPP.ServiceType Property

Indicates the type of service for the current message.

Syntax

 getServiceType(): SmppServiceTypes;


 setServiceType(serviceType: SmppServiceTypes): void;


enum SmppServiceTypes {
  smppServiceDefault,
  smppServiceCMT,
  smppServiceCPT,
  smppServiceVMN,
  smppServiceVMA,
  smppServiceWAP,
  smppServiceUSSD,
  smppServiceCBS
}

Default Value

0

Remarks

When sending messages, this property is used define the SMS application service to be associated with the message. The 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 the following:

"" (NULL)	the MC default
CMT	Cellular Messaging
CPT	Cellular Paging
VMN	Voice Mail Notification
VMA	Voice Mail Alerting
WAP	Wireless Application Protocol
USSD	Unstructured Supplementary Services Data
CBS	Cell Broadcast Service

SMPP.SMPPPort Property

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

Syntax

 getSMPPPort(): number;


 setSMPPPort(SMPPPort: number): void;

Default Value

2775

Remarks

For implicit 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.

SMPP.SMPPServer Property

The SMPP entity to which the class will connect.

Syntax

 getSMPPServer(): string;


 setSMPPServer(SMPPServer: string): void;

Default Value

""

Remarks

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

SMPP.SMPPVersion Property

The SMPP version to be used throughout the connection.

Syntax

 getSMPPVersion(): SmppSMPPVersions;


 setSMPPVersion(SMPPVersion: SmppSMPPVersions): void;


enum SmppSMPPVersions {
  smppVersion50,
  smppVersion34,
  smppVersion33
}

Default Value

1

Remarks

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

The default value is version 3.4 as 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.

SMPP.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

 getSSLAcceptServerCert(): Certificate;


 setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SMPP.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

 getSSLCert(): Certificate;


 setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SMPP.SSLEnabled Property

Whether TLS/SSL is enabled.

Syntax

 isSSLEnabled(): boolean;


 setSSLEnabled(SSLEnabled: boolean): void;

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class 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.

SMPP.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

 getSSLProvider(): SmppSSLProviders;


 setSSLProvider(SSLProvider: SmppSSLProviders): void;


enum SmppSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

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 class 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:

0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

SMPP.SSLServerCert Property

The server certificate for the last established connection.

Syntax

 getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SMPP.SSLStartMode Property

Determines how the class starts the SSL negotiation.

Syntax

 getSSLStartMode(): SmppSSLStartModes;


 setSSLStartMode(SSLStartMode: SmppSSLStartModes): void;


enum SmppSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

SMPP.SystemType Property

A string representing the type of system during a connection.

Syntax

 getSystemType(): string;


 setSystemType(systemType: string): void;

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.

SMPP.Timeout Property

A timeout for the class.

Syntax

 getTimeout(): number;


 setTimeout(timeout: number): void;

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 class will wait for the operation to complete before returning control.

The class 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 class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

SMPP.UserId Property

Used for identification with the SMPP service.

Syntax

 getUserId(): string;


 setUserId(userId: string): void;

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.

There are two ways to bind: by calling Connect with a user id and password and will set the UserId and Password properties before connecting; or by setting those two properties and calling SendMessage while not connected.

SMPP.addRecipient Method

Will add a recipient of the specified type to the recipient list.

Syntax

async smpp.addRecipient(recipientType : number, recipientAddress : string): Promise<void>

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. For sending messages to distributed lists, the name of the list should be used.

Valid values for RecipientType are:

0 (smppRecipientTypeNormal)	Normal SME (Short Message Entity) Address
1 (smppRecipientTypeList)	Distribution List

SMPP.cancelMessage Method

Will cancel the specified message.

Syntax

async smpp.cancelMessage(messageId : string): Promise<void>

Remarks

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

SMPP.checkLink Method

Will check the connection to the server.

Syntax

async smpp.checkLink(): Promise<void>

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. While 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, etc. This method will send a PDU to the server and wait the length of Timeout for a response.

SMPP.checkMessageStatus Method

Will retrieve the status of the specified message.

Syntax

async smpp.checkMessageStatus(messageId : string): Promise<void>

Remarks

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

SMPP.config Method

Sets or retrieves a configuration setting.

Syntax

async smpp.config(configurationString : string): Promise<string>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

SMPP.connect Method

Will bind as a transceiver to the SMPP service.

Syntax

async smpp.connect(): Promise<void>

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.

SMPP.connectTo Method

Will bind as a transceiver to the SMPP service.

Syntax

async smpp.connectTo(userId : string, password : string): Promise<void>

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.

SMPP.disconnect Method

Will disconnect from the SMPP service.

Syntax

async smpp.disconnect(): Promise<void>

Remarks

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

SMPP.doEvents Method

Processes events from the internal message queue.

Syntax

async smpp.doEvents(): Promise<void>

Remarks

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

SMPP.interrupt Method

Interrupt the current method.

Syntax

async smpp.interrupt(): Promise<void>

Remarks

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

SMPP.replaceMessage Method

Replaces a previously sent message with a new one.

Syntax

async smpp.replaceMessage(messageId : string, newMessage : string): Promise<void>

Remarks

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

If there is no message corresponding to MessageId, the SMS service will respond with an error message.

SMPP.reset Method

Reset the class.

Syntax

async smpp.reset(): Promise<void>

Remarks

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

SMPP.sendCommand Method

Will format and send a PDU using the specified command identifier and payload.

Syntax

async smpp.sendCommand(commandId : number, payload : Uint8Array): Promise<Uint8Array>

Remarks

This method offers a way to do more with the class than is directly supported. This method takes a command identifier and a payload, which includes every required and optional field after the header, and will create 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.

SMPP.sendData Method

Sends raw data to Recipients .

Syntax

async smpp.sendData(data : Uint8Array): Promise<string>

Remarks

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

SMPP.sendMessage Method

Sends a message to all recipients in the recipient list.

Syntax

async smpp.sendMessage(message : string): Promise<string>

Remarks

The methods 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 max size of the message sent is 256 bytes.

SMPP.Connected Event

This event is fired after a successful bind operation.

Syntax

smpp.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

After establishing a socket connection to the SMPPServer, the class will attempt to send a bind as transmitter command. Upon completion of this operation, the server will respond with either a success or failure state, 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.

SMPP.ConnectionStatus Event

This event is fired to indicate changes in the connection state.

Syntax

smpp.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

The ConnectionStatus 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:

	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

SMPP.Disconnected Event

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

Syntax

smpp.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

SMPP.Error Event

This event is fired when the server detects an error.

Syntax

smpp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

If the server sends an error not related to a command sent from the class, the class 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.

SMPP.MessageIn Event

This event is fired upon receipt of a message.

Syntax

smpp.on('MessageIn', listener: (e: {readonly sourceAddress: string, readonly scheduleDeliveryTime: string, readonly validityPeriod: string, readonly message: string, readonly messagePart: number, readonly messagePartCount: number, readonly messagePartReference: number, readonly destinationAddress: string, responseErrorCode: number}) => void )

Remarks

When a message is received, the SMPP class 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 which the short message is scheduled to be forwarded to another MC. This will be an empty string if not scheduled.

The ValidityPeriod parameter is only applicable if this short message is being forwarded to another MC. When this occurs, it specifies how long the receiving MC should retain the 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 re-assembling 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.

SMPP.MessageStatus Event

This event is fired upon receipt of a message.

Syntax

smpp.on('MessageStatus', listener: (e: {readonly messageId: string, readonly messageState: number, readonly messageError: number, readonly finalDate: string}) => void )

Remarks

When a CheckMessageStatus is called, the SMPP class will fetch 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:

1	ENROUTE, the message is in enroute state.
2	DELIVERED, the message is delivered.
3	EXPIRED, the message validity period expired.
4	DELETED, the message has been deleted.
5	UNDELIVERABLE, the message is undeliverable.
6	ACCEPTED, the message has been read on behalf of subscriber by customer service.
7	UNKNOWN, the message is in invalid state.
8	REJECTED, the message is in a rejected state.

For v5.0:

0	SCHEDULED, the message is in scheduled for delivery, but has not yet been delivered.
1	ENROUTE, the message is in enroute state.
2	DELIVERED, the message is delivered.
3	EXPIRED, the message validity period expired.
4	DELETED, the message has been deleted.
5	UNDELIVERABLE, the message is undeliverable.
6	ACCEPTED, the message has been read on behalf of subscriber by customer service.
7	UNKNOWN, the message is in invalid state.
8	REJECTED, the message is in a rejected state.
9	SKIPPED, the message was accepted by not delivered.

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.

SMPP.PITrail Event

This event is fired once for each PDU sent between the client and server.

Syntax

smpp.on('PITrail', listener: (e: {readonly direction: number, readonly PDU: string, readonly PDUB: Uint8Array, readonly commandLength: number, readonly commandId: number, readonly commandDescription: string, readonly commandStatus: string, readonly sequenceNumber: number}) => void )

Remarks

Whenever either the class or the SMPPServer sends any data across the connection, the class 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 class 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 by 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.

SMPP.ReadyToSend Event

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

Syntax

smpp.on('ReadyToSend', listener: (e: {}) => void )

Remarks

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

SMPP.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

smpp.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string "OK"). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before intiating the connection.

SMPP.SSLStatus Event

Shows the progress of the secure connection.

Syntax

smpp.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate string	This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.
Encoded Uint8Array	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB byte[]	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
ExpirationDate string	This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00.
ExtendedKeyUsage string	This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint string	This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1 string	This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. 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
FingerprintSHA256 string	This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. 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
Issuer string	This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword string	This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys. Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey string	This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable boolean	This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer string	This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey string	This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm string	This property contains 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.
PublicKeyLength number	This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber string	This is 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.
SignatureAlgorithm string	The property contains 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.
Store Uint8Array	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StoreB byte[]	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StorePassword string	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType CertStoreTypes	This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values: 0 (cstUser - default) For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. 1 (cstMachine) For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. 2 (cstPFXFile) The certificate store is the name of a PFX (PKCS12) file containing certificates. 3 (cstPFXBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. 4 (cstJKSFile) The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. 5 (cstJKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. 6 (cstPEMKeyFile) The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. 7 (cstPEMKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. 8 (cstPublicKeyFile) The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. 9 (cstPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. 10 (cstSSHPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. 11 (cstP7BFile) The certificate store is the name of a PKCS7 file containing certificates. 12 (cstP7BBlob) The certificate store is a string (binary) representing a certificate store in PKCS7 format. 13 (cstSSHPublicKeyFile) The certificate store is the name of a file that contains an SSH-style public key. 14 (cstPPKFile) The certificate store is the name of a file that contains a PPK (PuTTY Private Key). 15 (cstPPKBlob) The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). 16 (cstXMLFile) The certificate store is the name of a file that contains a certificate in XML format. 17 (cstXMLBlob) The certificate store is a string that contains a certificate in XML format. 18 (cstJWKFile) The certificate store is the name of a file that contains a JWK (JSON Web Key). 19 (cstJWKBlob) The certificate store is a string that contains a JWK (JSON Web Key). 21 (cstBCFKSFile) The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. 22 (cstBCFKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. 23 (cstPKCS11) The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); 99 (cstAuto) The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.
Subject string	This is the subject of the certificate used for client authentication. This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below. Field Meaning CN Common Name. This is commonly a host name like www.server.com. O Organization OU Organizational Unit L Locality S State C Country E Email Address If a field value contains a comma it must be quoted.
SubjectAltNames string	This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5 string	This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA1 string	This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA256 string	This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.
Usage string	This property contains the text description of . This value will be of one or more of the following strings and will be separated by commas: Digital Signatures Key Authentication Key Encryption Data Encryption Key Agreement Certificate Signing Key Signing If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags number	This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags: 0x80 Digital Signatures 0x40 Key Authentication 0x20 Key Encryption 0x10 Data Encryption 0x08 Key Agreement 0x04 Certificate Signing 0x02 Key Signing Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL.
Version string	This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is the firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

AutoDetect boolean	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType FirewallTypes	This property determines the type of firewall to connect through. The applicable values are as follows: fwNone (0) No firewall (default setting). fwTunnel (1) Connect through a tunneling proxy. is set to 80. fwSOCKS4 (2) Connect through a SOCKS4 Proxy. is set to 1080. fwSOCKS5 (3) Connect through a SOCKS5 Proxy. is set to 1080. fwSOCKS4A (10) Connect through a SOCKS4A Proxy. is set to 1080.
Host string	This property contains the name or IP address of firewall (optional). If a 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 class .
Password string	This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
Port number	This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details. Note: This property is set automatically when is set to a valid value. See the description of the property for details.
User string	This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

Constructors

public Firewall();

SMPPRecipient Type

A recipient of the SMPP message.

Remarks

This type describes a recipient of the SMPP message that is being sent. The fields describe the of recipient and the of the recipient of the message.

Fields

Address string	This property contains the email address of a particular recipient. This can be used for setting single or multiple recipients. The contains the corresponding type. For a recipient type of normal, the value in the 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.
RecipientType SMPPRecipientTypes	This property contains the type of a particular recipient. This property is used only for multiple recipient messages. The contains the corresponding recipient's address. For a recipient type of normal, the value in 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: 0 (smppRecipientTypeNormal) Normal SME (Short Message Entity) Address 1 (smppRecipientTypeList) Distribution List

Constructors

public SMPPRecipient();

public SMPPRecipient(String address);

public SMPPRecipient(String address, int recipientType);

Config Settings (class ipworks.smpp)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SMPP Config Settings

AddressRange:   Specifies the addr_range parameter when binding. The addr_range parameter is used when binding as a receiver or transceiver to specify a set of SME addresses serviced by the ESME client. A single SME address may also be specified in the address_range parameter. UNIX Regular Expression notation should be used to specify a range of addresses. Messages addressed to any destination in this range shall be routed to the ESME. Note 1: For IP addresses, it is only possible to specify a single IP address. A range of IP addresses are not allowed. IP version 6.0 is not currently supported in this version of the protocol. Note 2: It is likely that the addr_range field is not supported or deliberately ignored on most Message Centres. The reason for this is that most carriers will not allow an ESME control the message routing as this can carry the risk of mis-routing messages. In such circumstances, the ESME will be requested to set the field to NULL.

BinaryDataCoding:   Whether or not to binary encode the message when DataCoding is set. By default, when the DataCoding configuration setting is used, the component will treat the message as binary. This config can be set to false to send text user data instead.

BindAsReceiver:   Causes the component to bind as a receiver. Setting this will instruct the component to bind to the SMPP service as a receiver instead of a transceiver.

BindAsTransmitter:   Causes the component to bind as a transmitter. Setting this will instruct the component to bind to the SMPP service as a transmitter instead of a transceiver.

CustomTLV:   Optional TLV parameters added after the mandatory parameters and before the payload. The format of a TLV parameter is: One two-byte integer containing the parameter type (tag). One two-byte integer indicating the length of the data contained in this parameter. The variable-length parameter data itself. All of this must then be hex-encoded before setting the CustomTLV configuration setting. For instance, to add a gn_lookup_userdata parameter, the type/tag is decimal 5633 (that's 0x1601 in hex), and the data in this example is "Hello World", which is 11 characters in length. So the TLV is: 5633 + 11 + "Hello World", or 0x16 0x01 0x00 0x0b and then the ASCII text "Hello World". When hex-encoded, this yields the string "1601000b48656c6c6f20576f726c64". This is the value you would then use to set the CustomTLV configuration setting. You are not restricted to only one optional parameter. Multiple TLV parameters may be concatenated together. Note that this is advanced functionality, and the class does not verify the data in this configuration setting prior to transmission. After the class internally decodes the string back into binary, it is passed on inside the PDU as-is without validation or modification. This setting is only applicable when using the SendMessage or SendData methods.

DataCoding:   The data encoding mechanism to be used for the current message. This value informs the message recipient about how the data was encoded. The possible values are as follows: 0 MC Specific encoding 1 IA5 (CCITT T.50)/ASCII (ANSI X3.4) 2 Octet unspecified (8-bit binary) 3 Latin 1 (ISO-8859-1) 4 Octet unspecified (8-bit binary) 5 JIS (X 0208-1990) 6 Cyrillic (ISO-8859-5) 7 Latin/Hebrew (ISO-8859-8) 8 UCS2 (ISO/IEC-10646) 9 Pictogram Encoding 10 ISO-2022-JP (Music Codes) 11 Reserved 12 Reserved 2 13 Extended Kanji JIS (X 0212-1990) 14 KS C 5601

DecodeHexStrings:   Will decode an ascii hex-representation of binary data prior to transmission. When this setting is True, data sent in the SendCommand method's Payload parameter, SendData method's Data parameter, or SendMessage method's Message parameter will be treated as an ASCII hex-representation of binary data, and will be decoded into raw binary before transmission. For instance, the string "48656C6C6F20576F726C64" will be decoded to "Hello World" when this configuration setting is True. If the string passed to the method parameter is not correctly hex-encoded the class will transmit unexpected results. This setting is False by default.

DestinationNPI:   The Number Planning Indicator for the destination ESME. When sending messages, this value is used to indicate the numbering plan the destination ESME. For a list of possible values, please see SourceNPI.

DestinationTON:   The Type of Number for the destination ESME. When sending messages, this value is used to indicate the Type of Number for the destination ESME. For a list of possible values, please see SourceTON.

DoSplitLargeMessages:   Splits long messages and returns the UDH and Message Parts. This configuration setting accepts a string which will be the long message to be split into parts. The UDH and Message Parts will be returned in hex, in the format below: [UDH1],[MessagePart1];[UDH2],[MessagePart2];[UDH3],[MessagePart3] Note: When this setting is specified the class immediately performs an action. Use the ConfigAsync method in order to avoid blocking execution.

HexString:   A hex-encoded binary string to be sent to the current recipient. When set, this configuration setting will cause the component to internally call SendMessage with the binary contents of the hex-encoded string. The return value when setting this property is the server-assigned id of the message. Querying this property will result in an empty string. Note that when using HexString, DataCoding must be set to 8, and the value provided to this configuration setting should be the UTF-16 hex encoded message. Note: When this setting is specified the class immediately performs an action. Use the ConfigAsync method in order to avoid blocking execution.

IncomingDestinationAddress:   Returns the dest_addr field inside the received message. This configuration setting is read-only, and is only valid inside the MessageIn event.

IntermediateNotification:   Causes the component to request intermediate notification. Setting this will request intermediate notification. By default, intermediate notification is not requested.

MaxCIMDSMSLength:   Indicates the maximum SMS message length for the CIMD protocol. This setting is only applicable when SplitLargeMessages is true and Protocol is set to CIMD2. The setting controls the maximum size of SMS messages before they are split and has a default value of 160.

MaxSMSLength:   Indicates the maximum SMS message length. This setting is only applicable when SplitLargeMessages is true. The setting controls the maximum size of SMS messages before they are split and has a default value of 140.

MCReceipt:   The Type of MC Delivery Receipt requested. When sending a message, this value is used to determine whether or not an MC delivery receipt is requested. This value is 0 by default, and no receipt is requested. The possible values are: 0 No MC Delivery Receipt requested (default). 1 MC Delivery Receipt is requested after final delivery (success or failure). 2 MC Delivery Receipt is requested after a failed delivery. 3 MC Delivery Receipt is requested after a successful delivery.

MessageInReceiptedMessageId:   The receipted_message_id field of an incoming deliver_sm PDU. This value indicates the ID of the message being receipted in a MC Delivery Receipt. Note that this is only applicable within the MessageIn event.

MessageMode:   The Type of Messaging Mode requested. When sending a message, this value is used to specify the Messaging Mode in the outgoing request. For incoming messages this value can be queried from within the MessageIn event. The possible values are: 0 Default SMSC Mode (e.g. Store and Forward). 1 Datagram mode. 2 Forward (i.e. Transaction) mode. 3 Store and Forward mode.

MessageType:   The Type of Message. When sending a message, this value is used to specify the Message Type in the outgoing request. For incoming messages this value can be queried from within the MessageIn event. The possible values are: 0 Default message Type (i.e. normal message). 1 Short Message contains MC Delivery Receipt. 2 Short Message contains Intermediate Delivery Notification.

ProtocolId:   The protocol identifier. This config property allows control of the protocol identifier field value used in the outgoing messages.

SMEAcknowledgement:   The Type of SME originated acknowledgement requested. When sending a message, this value is used to determine whether or not an SME acknowledgement is requested. This value is 0 by default, and no acknowledgement is requested. The possible values are: 0 No SME acknowledgement requested (default). 1 SME delivery acknowledgement is requested. 2 SME manual/user acknowledgement is requested. 3 Both delivery and manual/user acknowledgement is requested.

SourceNPI:   The Number Planning Indicator for the ESME. When binding, this value is used to specify the numbering plan of the ESME. Mobiles tend to set this value to 1. Since most ESMEs are mobiles, the default value for SourceNPI is 1. The possible value are: Unknown (0) ISDN (1) Data (3) Telex (4) LandMobile (6) National (8) Private (9) ERMES (10) Internet (14) WAP (18)

SourceTON:   The Type of Number for the ESME. When binding, this value is used to indicate the Type of Number for the ESME address. The possible values are: Unknown (0) The number type is unknown International (1) The number includes the international trunk prefix National (2) The number includes the national trunk prefix NetworkSpecific (3) The number exists on a network that uses a specific delivery protocol SubscriberNumber (4) The number is just the subscriber number, without prefixes Alphanumeric (5) The address is human-readable (contains letters and digits) Abbreviated (6) The number is abbreviated

SplitLargeMessages:   Determines whether large messages are split into multiple parts. The default value is false. If set to true and the message is larger than MaxSMSLength (or MaxCIMDSMSLength) the message will automatically be split into parts when SendMessage is called. Note that this is only valid for GSM networks. When receiving a message that has been split, the MessageIn event provides parameters to re-assemble the message.

SplitMessageMethod:   Determines how large messages are split into multiple parts. The component can split large messages using either the UDH or SAR method. The mode used is determined by this configuration option. The possible values are: 0 UDH (Default) 1 SAR

StatusReportRequest:   Defines in what cases a status report is created by the server. This is only applicable when Protocol is set to smppCIMD2. This may be set to request that the server create a status report for the given conditions. The assigned value should be the sum of all desired conditions. For instance a value of 62 means that a report should be created for all events except for a temporary error. Possible flags are: 1 Temporary Error 2 Validity Period Expired 4 Delivery Failed 8 Delivery Successful 16 Message Cancelled 32 Message Deleted By The Operator

SubAddr:   Defines a unique index for application instance. This is useful for correct delivery of status reports when multiple instances of the same application are connected. This setting is only applicable when Protocol is set to smppCIMD2.

SynchronousSendCommand:   Controls whether SendCommand behaves synchronously or asynchronously. The default value is true which means SendCommand will not return until a response has been received. If set to false the class returns and does not wait for a response from the server.

SynchronousSendMessage:   Controls whether SendMessage behaves synchronously or asynchronously. The default value is true which means SendMessage will not return until a response has been received. If set to false the class returns the sequence number used and does not wait for a response from the server. You may then monitor the PITrail event to match the response from the server to the sent message.

UseGSM7BitEncoding:   Whether or not to use GSM 7-bit encoding. When set to true (false by default), this will instruct the component to use 7-bit GSM encoding.

UseGSM7bitEncodingCompression:   Whether to compress GSM 7-bit encoded characters. When set to true (true by default), the component will compress GSM 7-bit encoded characters. Some devices do not support compression. Setting this to false may allow them to be displayed. This setting only applies when UseGSM7BitEncoding is true.

WaitForBanner:   Specifies the CIMD2 banner the class will wait for when connecting. This is only applicable when Protocol is set to smppCIMD2. If set, the class will wait for a banner containing this string to be returned by the server before proceeding with the connection.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection. When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available. This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting. If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;. The FirewallPort is set automatically when FirewallType is set to a valid value. Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through. The appropriate values are as follows: 0 No firewall (default setting). 1 Connect through a tunneling proxy. FirewallPort is set to 80. 2 Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. 3 Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. 10 Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent. When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully. This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted. The LocalHost setting 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds. This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found. MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second. This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy. This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled. If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets. Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets. When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this config is set to false.

UseIPv6:   Whether to use IPv6. When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are: 0 IPv4 Only 1 IPv6 Only 2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API. When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes. When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates. This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application. This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL. This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG). This functionality is available only when the provider is OpenSSL. By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused. If set to true, the class will reuse the context if and only if the following criteria are met: The target host name is the same. The system cache entry has not expired (default timeout is 10 hours). The application process that calls the function is the same. The logon session is the same. The instance of the class is the same.

SSLAcceptAnyServerCert:   Whether to trust any certificate presented by the server. This setting disables all certificate verification when set to True. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication. This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption. This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation. The enabled cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include: CALG_3DES CALG_3DES_112 CALG_AES CALG_AES_128 CALG_AES_192 CALG_AES_256 CALG_AGREEDKEY_ANY CALG_CYLINK_MEK CALG_DES CALG_DESX CALG_DH_EPHEM CALG_DH_SF CALG_DSS_SIGN CALG_ECDH CALG_ECDH_EPHEM CALG_ECDSA CALG_ECMQV CALG_HASH_REPLACE_OWF CALG_HUGHES_MD5 CALG_HMAC CALG_KEA_KEYX CALG_MAC CALG_MD2 CALG_MD4 CALG_MD5 CALG_NO_SIGN CALG_OID_INFO_CNG_ONLY CALG_OID_INFO_PARAMETERS CALG_PCT1_MASTER CALG_RC2 CALG_RC4 CALG_RC5 CALG_RSA_KEYX CALG_RSA_SIGN CALG_SCHANNEL_ENC_KEY CALG_SCHANNEL_MAC_KEY CALG_SCHANNEL_MASTER_HASH CALG_SEAL CALG_SHA CALG_SHA1 CALG_SHA_256 CALG_SHA_384 CALG_SHA_512 CALG_SKIPJACK CALG_SSL2_MASTER CALG_SSL3_MASTER CALG_SSL3_SHAMD5 CALG_TEK CALG_TLS1_MASTER CALG_TLS1PRF Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_RSA_WITH_AES_256_CBC_SHA TLS_DHE_DSS_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_DES_CBC_SHA TLS_DHE_RSA_WITH_DES_CBC_SHA TLS_DHE_DSS_WITH_DES_CBC_SHA TLS_RSA_WITH_RC4_128_MD5 TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols. Used to enable/disable the supported security protocols. Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values: TLS1.3 12288 (Hex 3000) TLS1.2 3072 (Hex C00) (Default) TLS1.1 768 (Hex 300) (Default) TLS1 192 (Hex C0) (Default) SSL3 48 (Hex 30) SSL2 12 (Hex 0C) SSLEnabledProtocols - TLS 1.3 Notes In the JavaScript edition the platform implementation is used when TLS 1.3 is enabled and SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported. This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension. This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event. This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes. This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake represented as a single string. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm. Returns the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength. Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version. Returns the protocol version negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions: 0x00000001 Ignore time validity status of certificate. 0x00000002 Ignore time validity status of CTL. 0x00000004 Ignore non-nested certificate times. 0x00000010 Allow unknown Certificate Authority. 0x00000020 Ignore wrong certificate usage. 0x00000100 Ignore unknown certificate revocation status. 0x00000200 Ignore unknown CTL signer revocation status. 0x00000400 Ignore unknown Certificate Authority revocation status. 0x00000800 Ignore unknown Root revocation status. 0x00008000 Allow test Root certificate. 0x00004000 Trust test Root certificate. 0x80000000 Ignore non-matching CN (certificate CN not-matching server name). This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation. This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class . The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa. In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC. This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC. The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported: "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" "ffdhe_6144" "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms. This setting holds a comma separated list of allowed signature algorithms. Possible values are: "ed25519" (default) "ed448" (default) "ecdsa_secp256r1_sha256" (default) "ecdsa_secp384r1_sha384" (default) "ecdsa_secp521r1_sha512" (default) "rsa_pkcs1_sha256" (default) "rsa_pkcs1_sha384" (default) "rsa_pkcs1_sha512" (default) "rsa_pss_sha256" (default) "rsa_pss_sha384" (default) "rsa_pss_sha512" (default) The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" (default) "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default) "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" (default) "ffdhe_6144" (default) "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts. If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall. When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build. When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: Identifier Name 037 IBM EBCDIC - U.S./Canada 437 OEM - United States 500 IBM EBCDIC - International 708 Arabic - ASMO 708 709 Arabic - ASMO 449+, BCON V4 710 Arabic - Transparent Arabic 720 Arabic - Transparent ASMO 737 OEM - Greek (formerly 437G) 775 OEM - Baltic 850 OEM - Multilingual Latin I 852 OEM - Latin II 855 OEM - Cyrillic (primarily Russian) 857 OEM - Turkish 858 OEM - Multilingual Latin I + Euro symbol 860 OEM - Portuguese 861 OEM - Icelandic 862 OEM - Hebrew 863 OEM - Canadian-French 864 OEM - Arabic 865 OEM - Nordic 866 OEM - Russian 869 OEM - Modern Greek 870 IBM EBCDIC - Multilingual/ROECE (Latin-2) 874 ANSI/OEM - Thai (same as 28605, ISO 8859-15) 875 IBM EBCDIC - Modern Greek 932 ANSI/OEM - Japanese, Shift-JIS 936 ANSI/OEM - Simplified Chinese (PRC, Singapore) 949 ANSI/OEM - Korean (Unified Hangul Code) 950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) 1026 IBM EBCDIC - Turkish (Latin-5) 1047 IBM EBCDIC - Latin 1/Open System 1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol) 1141 IBM EBCDIC - Germany (20273 + Euro symbol) 1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) 1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) 1144 IBM EBCDIC - Italy (20280 + Euro symbol) 1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) 1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol) 1147 IBM EBCDIC - France (20297 + Euro symbol) 1148 IBM EBCDIC - International (500 + Euro symbol) 1149 IBM EBCDIC - Icelandic (20871 + Euro symbol) 1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646) 1201 Unicode UCS-2 Big-Endian 1250 ANSI - Central European 1251 ANSI - Cyrillic 1252 ANSI - Latin I 1253 ANSI - Greek 1254 ANSI - Turkish 1255 ANSI - Hebrew 1256 ANSI - Arabic 1257 ANSI - Baltic 1258 ANSI/OEM - Vietnamese 1361 Korean (Johab) 10000 MAC - Roman 10001 MAC - Japanese 10002 MAC - Traditional Chinese (Big5) 10003 MAC - Korean 10004 MAC - Arabic 10005 MAC - Hebrew 10006 MAC - Greek I 10007 MAC - Cyrillic 10008 MAC - Simplified Chinese (GB 2312) 10010 MAC - Romania 10017 MAC - Ukraine 10021 MAC - Thai 10029 MAC - Latin II 10079 MAC - Icelandic 10081 MAC - Turkish 10082 MAC - Croatia 12000 Unicode UCS-4 Little-Endian 12001 Unicode UCS-4 Big-Endian 20000 CNS - Taiwan 20001 TCA - Taiwan 20002 Eten - Taiwan 20003 IBM5550 - Taiwan 20004 TeleText - Taiwan 20005 Wang - Taiwan 20105 IA5 IRV International Alphabet No. 5 (7-bit) 20106 IA5 German (7-bit) 20107 IA5 Swedish (7-bit) 20108 IA5 Norwegian (7-bit) 20127 US-ASCII (7-bit) 20261 T.61 20269 ISO 6937 Non-Spacing Accent 20273 IBM EBCDIC - Germany 20277 IBM EBCDIC - Denmark/Norway 20278 IBM EBCDIC - Finland/Sweden 20280 IBM EBCDIC - Italy 20284 IBM EBCDIC - Latin America/Spain 20285 IBM EBCDIC - United Kingdom 20290 IBM EBCDIC - Japanese Katakana Extended 20297 IBM EBCDIC - France 20420 IBM EBCDIC - Arabic 20423 IBM EBCDIC - Greek 20424 IBM EBCDIC - Hebrew 20833 IBM EBCDIC - Korean Extended 20838 IBM EBCDIC - Thai 20866 Russian - KOI8-R 20871 IBM EBCDIC - Icelandic 20880 IBM EBCDIC - Cyrillic (Russian) 20905 IBM EBCDIC - Turkish 20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) 20932 JIS X 0208-1990 & 0121-1990 20936 Simplified Chinese (GB2312) 21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian) 21027 Extended Alpha Lowercase 21866 Ukrainian (KOI8-U) 28591 ISO 8859-1 Latin I 28592 ISO 8859-2 Central Europe 28593 ISO 8859-3 Latin 3 28594 ISO 8859-4 Baltic 28595 ISO 8859-5 Cyrillic 28596 ISO 8859-6 Arabic 28597 ISO 8859-7 Greek 28598 ISO 8859-8 Hebrew 28599 ISO 8859-9 Latin 5 28605 ISO 8859-15 Latin 9 29001 Europa 3 38598 ISO 8859-8 Hebrew 50220 ISO 2022 Japanese with no halfwidth Katakana 50221 ISO 2022 Japanese with halfwidth Katakana 50222 ISO 2022 Japanese JIS X 0201-1989 50225 ISO 2022 Korean 50227 ISO 2022 Simplified Chinese 50229 ISO 2022 Traditional Chinese 50930 Japanese (Katakana) Extended 50931 US/Canada and Japanese 50933 Korean Extended and Korean 50935 Simplified Chinese Extended and Simplified Chinese 50936 Simplified Chinese 50937 US/Canada and Traditional Chinese 50939 Japanese (Latin) Extended and Japanese 51932 EUC - Japanese 51936 EUC - Simplified Chinese 51949 EUC - Korean 51950 EUC - Traditional Chinese 52936 HZ-GB2312 Simplified Chinese 54936 Windows XP: GB18030 Simplified Chinese (4 Byte) 57002 ISCII Devanagari 57003 ISCII Bengali 57004 ISCII Tamil 57005 ISCII Telugu 57006 ISCII Assamese 57007 ISCII Oriya 57008 ISCII Kannada 57009 ISCII Malayalam 57010 ISCII Gujarati 57011 ISCII Punjabi 65000 Unicode UTF-7 65001 Unicode UTF-8 The following is a list of valid code page identifiers for Mac OS only: Identifier Name 1 ASCII 2 NEXTSTEP 3 JapaneseEUC 4 UTF8 5 ISOLatin1 6 Symbol 7 NonLossyASCII 8 ShiftJIS 9 ISOLatin2 10 Unicode 11 WindowsCP1251 12 WindowsCP1252 13 WindowsCP1253 14 WindowsCP1254 15 WindowsCP1250 21 ISO2022JP 30 MacOSRoman 10 UTF16String 0x90000100 UTF16BigEndian 0x94000100 UTF16LittleEndian 0x8c000100 UTF32String 0x98000100 UTF32BigEndian 0x9c000100 UTF32LittleEndian 65536 Proprietary

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server). Last Valid Build: The last valid build number for which the license will work.

MaskSensitive:   Whether sensitive data is masked in log messages. In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false. This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms.

Trappable Errors (class ipworks.smpp)

SMPP Errors

	620   SMPP protocol error
	621   You cannot change this property while connected
	622   Server disconnected before responding
	623   Field value out of range
	624   Unsupported SMPP Version
	625   Message parameter too long

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).