IPWorks EDI 2024 API Changes


Upgrading from a previous version is usually as simple as referencing the updated library versions. We have minimized breaking changes to ensure a straightforward upgrade process. However, the release of IPWorks EDI 2024 includes several API changes that may require code changes. The table below lists the changes between IPWorks EDI 2022 and IPWorks EDI 2024.

Please contact us at support@nsoftware.com with any questions or comments.

Components with Changes

API Changes

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

AS1Receiver
PropertyMailMessageSizeRemoved
PropertyMailMessageUIDRemoved
MethodQueryMessageSizeNew
MethodQueryMessageUIDNew
AS1Sender
PropertyMailMessageSizeRemoved
PropertyMailMessageUIDRemoved
AS3Receiver
PropertyFTPCommandRemoved (previously deprecated)
PropertyRemotePathRemoved (previously deprecated)
MethodQueryRemotePathNew
MethodSendFTPCommandNew
AS3Sender
PropertyFTPCommandRemoved (previously deprecated)
PropertyRemotePathRemoved (previously deprecated)
MethodQueryRemotePathNew
CertMgr
MethodCheckCRLNew
MethodCheckOCSPNew
FTP
PropertyCommandRemoved (previously deprecated)
PropertyFileExistsRemoved (previously deprecated)
PropertyFileSizeRemoved (previously deprecated)
PropertyFileTimeRemoved (previously deprecated)
PropertyRemotePathRemoved (previously deprecated)
HTMLMailer
PropertyCommandRemoved (previously deprecated)
IMAP
PropertyCommandRemoved (previously deprecated)
MethodFetchMessageHeadersRenamed to RetrieveMessageHeaders
MethodFetchMessageInfoRenamed to RetrieveMessageInfo
MethodFetchMessagePartRenamed to RetrieveMessagePart
MethodFetchMessagePartHeadersRenamed to RetrieveMessagePartHeaders
MethodFetchMessageTextRenamed to RetrieveMessageText
MLLPClient
PropertyInputFilenameRemoved
PropertyInputFileNameNew
PropertyOutputFileNameNew
PropertyOutputFilenameRemoved
POP
PropertyCommandRemoved (previously deprecated)
PropertyMessageSizeRemoved (previously deprecated)
PropertyMessageUIDRemoved (previously deprecated)
PropertyTotalSizeRemoved (previously deprecated)
SFTPClient (Previously SFTP)
PropertyFileExistsRemoved (previously deprecated)
MethodDownloadRangeNew
MethodUploadRangeNew
SFTPServerNew
SMTP
PropertyCommandRemoved (previously deprecated)

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