IPWorks 2022 API Changes

In most cases upgrading is seamless and requires no code changes, as efforts have been made to maintain backwards compatibility. However, the release of IPWorks 2022 includes several API changes that may require code changes. The table below is a list of major changes between IPWorks 2020 and IPWorks 2022.

Upgrading to IPWorks 2022 is designed to be a quick process and involve only minimal code changes while offering additional functionality and options for new and existing users. Please contact us at support@nsoftware.com with any questions or comments.

GRPC
HTMLMailer
HTTP
ICMP
IMAP

IPMonitor
JSON
LDAP
MCast
MIME

NNTP
OAuth
OData
Ping
POP

REST
Rexec
Rshell
RSS
S3

SMPP
SMTP
SNPP
SOAP
SysLog

TCPClient
TCPServer
Telnet
TFTPServer
TraceRoute

UDP
WebDAV
WebForm
WebUpload
WSClient

WSServer
XMPP

API Changes

The table below describes API changes in IPWorks 2022. Please refer to the notes for each entry for details.

Atom
	Property	`SSLProvider`	New
CalDAV
	Property	`SSLProvider`	New
DNS
	Event	`Log`	New
FileMailer
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`SendCommand`	New
FTP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`FileExists`	Deprecated: Please use the CheckFileExists method instead.
	Property	`FileSize`	Deprecated: Please use the QueryFileSize method instead.
	Property	`FileTime`	Deprecated: Please use the QueryFileTime method instead.
	Property	`RemotePath`	Deprecated: Please use the QueryRemotePath method or the ChangeRemotePath method instead.
	Property	`SSLProvider`	New
	Method	`ChangeRemotePath`	New
	Method	`ChangeTransferMode`	New
	Method	`CheckFileExists`	New
	Method	`Connect`	New
	Method	`Disconnect`	New
	Method	`QueryFileSize`	New
	Method	`QueryFileTime`	New
	Method	`QueryRemotePath`	New
	Method	`SendCommand`	New
GRPC			New Component
HTMLMailer
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`CalcMessageText`	New
	Method	`SendCommand`	New
HTTP
	Property	`SSLProvider`	New
	Method	`CalcAuthorization`	New
	Method	`Connect`	New
	Method	`Disconnect`	New
ICMP (Previously ICMPPort)
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`ResolveRemoteHost`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
IMAP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`SendCommand`	New
IPMonitor
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
JSON
	Method	`LoadSchema`	Removed
LDAP
	Property	`SSLProvider`	New
	Method	`Connect`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
MCast
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`ResolveRemoteHost`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
MIME
	Method	`DecodePart`	New
	Method	`DecodePartToFile`	New
	Method	`DecodePartToStream`	New
NNTP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`ChangeCurrentGroup`	New
	Method	`SendCommand`	New
OAuth
	Property	`AccessTokenExp`	New
	Property	`SSLProvider`	New
	Property	`UsePKCE`	New
	Method	`GetParam`	New
OData
	Property	`SSLProvider`	New
Ping
	Property	`ResponseStatus`	New
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`ResolveRemoteHost`	New
POP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`MessageSize`	Deprecated: Please use the QueryMessageSize method instead.
	Property	`MessageUID`	Deprecated: Please use the QueryMessageUID method instead.
	Property	`SSLProvider`	New
	Property	`TotalSize`	Deprecated: Please use the QueryTotalSize method instead.
	Method	`QueryMessageSize`	New
	Method	`QueryMessageUID`	New
	Method	`QueryTotalSize`	New
	Method	`SendCommand`	New
REST
	Property	`SSLProvider`	New
Rexec
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`Stdin`	Deprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
	Method	`Connect`	New
	Method	`SendCommand`	New
	Method	`SendStdinBytes`	New
	Method	`SendStdinText`	New
Rshell
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`Stdin`	Deprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
	Method	`Connect`	New
	Method	`SendCommand`	New
	Method	`SendStdinBytes`	New
	Method	`SendStdinText`	New
RSS
	Property	`SSLProvider`	New
S3			New Component
SMPP
	Property	`SSLProvider`	New
	Method	`ConnectTo`	New
SMTP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`SendCommand`	New
SNPP
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`SSLProvider`	New
	Method	`SendCommand`	New
SOAP
	Property	`SSLProvider`	New
SysLog
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`ResolveRemoteHost`	New
TCPClient (Previously IPPort)
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Property	`SSLProvider`	New
	Method	`ChangeRecordLength`	New
	Method	`ConnectTo`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
TCPServer (Previously IPDaemon)
	Property	`SSLProvider`	New
	Method	`ChangeRecordLength`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
	Method	`SetUploadStream`	New
	Method	`StartListening`	New
	Method	`StopListening`	New
Telnet
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Property	`DontOption`	Deprecated: Please use the SendDontOption method instead.
	Property	`DoOption`	Deprecated: Please use the SendDoOption method instead.
	Property	`DoSubOption`	Deprecated: Please use the SendDoSubOption method instead.
	Property	`SSLProvider`	New
	Property	`UrgentData`	Deprecated: Please use the SendUrgentBytes method or the SendUrgentText method instead.
	Property	`WillOption`	Deprecated: Please use the SendWillOption method instead.
	Property	`WontOption`	Deprecated: Please use the SendWontOption method instead.
	Method	`ConnectTo`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`SendBytes`	New
	Method	`SendCommand`	New
	Method	`SendDontOption`	New
	Method	`SendDoOption`	New
	Method	`SendDoSubOption`	New
	Method	`SendText`	New
	Method	`SendUrgentBytes`	New
	Method	`SendUrgentText`	New
	Method	`SendWillOption`	New
	Method	`SendWontOption`	New
TFTPServer			New Component
TraceRoute
	Method	`ResolveRemoteHost`	New
UDP (Previously UDPPort)
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Method	`Activate`	New
	Method	`Deactivate`	New
	Method	`PauseData`	New
	Method	`ProcessData`	New
	Method	`ResolveRemoteHost`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
WebDAV
	Property	`SSLProvider`	New
WebForm
	Property	`SSLProvider`	New
WebUpload
	Property	`SSLProvider`	New
WSClient (Previously WebSocket)
	Property	`CompressionMethod`	New
	Property	`DataToSend`	Deprecated: Please use the SendBytes method or the SendText method instead.
	Property	`LineMode`	New
	Property	`SSLProvider`	New
	Property	`URL`	New
	Method	`ChangeLineMode`	New
	Method	`ConnectTo`	New
	Method	`SendBytes`	New
	Event	`Ping`	New
WSServer			New Component
XMPP
	Property	`SSLProvider`	New
	Method	`ConnectTo`	New
	Method	`UpdateBuddyGroup`	New

We appreciate your feedback. If you have any questions, comments, or suggestions about this article please contact our support team at kb@nsoftware.com.