The addr_range parameter is used when binding as a receiver or transceiver to specify a set of short message entity (SME) addresses serviced by the external SME (ESME) client. A single SME address may 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 is 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 Centers (MCs). Most carriers will not allow an ESME to control the message routing because this can carry the risk of incorrectly routing messages. In such circumstances, the ESME will be requested to set the field to NULL.

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

This configuration setting will instruct the component to bind to the SMPP service as a receiver instead of a transceiver.

This configuration setting will instruct the component to bind to the SMPP service as a transmitter instead of a transceiver.

The format of the tag length value (TLV) parameter is as follows:

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

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 as follows: 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: This is advanced functionality, and the cmdlet does not verify the data in this configuration setting before transmission. After the cmdlet internally decodes the string back into binary, it is passed on inside the protocol data unit (PDU) as-is without validation or modification.

This configuration setting is applicable only when using the SendMessage or SendData methods.

This configuration setting informs the message recipient about how data were encoded. The possible values are as follows:

When this configuration 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 cmdlet will transmit unexpected results. This setting is False by default.

When sending messages, this configuration setting is used to indicate the numbering plan the destination ESME. For a list of possible values, please see SourceNPI.

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

This configuration setting accepts a string that will be the long message to be split into parts. The user data header (UDH) and Message Parts will be returned in hex, in the following format:

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

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

This configuration setting is read-only, and it is valid only inside the MessageIn event.

This configuration setting will request intermediate notification. By default, intermediate notification is not requested.

This configuration setting is applicable only when SplitLargeMessages is True and Protocol is set to CIMD2. The configuration setting controls the maximum size of SMS messages before they are split and has a default value of 160.

This configuration setting is applicable only when SplitLargeMessages is True. The setting controls the maximum size of SMS messages before they are split and has a default value of 140.

When sending a message, this configuration setting 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 as follows:

This configuration setting indicates the Id of the message being receipted in an MC delivery receipt.

Note: This is applicable only within the MessageIn event.

When sending a message, this configuration setting 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 as follows:

When sending a message, this configuration setting 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 as follows:

Decides the format of the PDU parameter when decoding a PDU for the PITrail event. When set to Hex (1), the PDU will be encoded as a hex string. When set to Verbose (2) the PDU will be a longer hex dump.

This configuration setting allows control of the protocol identifier field value used in the outgoing messages.

When sending a message, this configuration setting is used to determine whether or not an SME acknowledgment is requested. This value is 0 by default, and no acknowledgment is requested. The possible values are as follows:

When binding, this configuration setting is used to specify the numbering plan of the ESME. Mobiles tend to set this value to 1. Because most ESMEs are mobiles, the default value for SourceNPI is 1. The possible value are as follows:

When binding, this configuration setting is used to indicate the Type of Number for the ESME address. The possible values are as follows:

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: This is valid only for GSM networks.

When receiving a message that has been split, the MessageIn event provides parameters to reassemble the message.

The component can split large messages using either the UDH or segmentation and reassembly (SAR) method. The mode used is determined by this configuration setting. The possible values are as follows:

This configuration setting is applicable only 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 as follows:

This configuration setting is useful for correct delivery of status reports when multiple instances of the same application are connected.

This configuration setting is applicable only when Protocol is set to smppCIMD2.

The default value is True, which means SendCommand will not return until a response has been received. If set to False, the cmdlet returns and does not wait for a response from the server.

The default value is True, which means SendMessage will not return until a response has been received. If set to False, the cmdlet 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.

When set to True (False by default), this will instruct the component to use 7-bit GSM encoding.

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 configuration setting applies only when UseGSM7BitEncoding is True.

This configuration setting is applicable only when Protocol is set to smppCIMD2. If set, the cmdlet will wait for a banner containing this string to be returned by the server before proceeding with the connection.

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

This configuration setting is provided for use by cmdlets that do not directly expose Firewall properties.

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 cmdlets that do not directly expose Firewall properties.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the cmdlet throws an exception.

Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by cmdlets that do not directly expose Firewall properties.

The appropriate values are as follows:

Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the cmdlet throws an exception.

Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.

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.

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.

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

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 cmdlet initiate connections (or accept in the case of server cmdlets) only through that interface.

If the cmdlet 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).

This must be set before a connection is attempted. It instructs the cmdlet 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 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.

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.

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

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.

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.

When set to 0 (default), the cmdlet will use IPv4 exclusively. When set to 1, the cmdlet will use IPv6 exclusively. To instruct the cmdlet 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:

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.

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

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 cmdlet is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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 cmdlet is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

When queried, this setting will return a string containing information about the license this instance of a cmdlet 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.

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

This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all cmdlets used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.