@chilkat/react-native 11.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (530) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/ChilkatRN.podspec +44 -0
  3. package/LICENSE +254 -0
  4. package/README.md +67 -0
  5. package/android/CMakeLists.txt +60 -0
  6. package/android/build.gradle +148 -0
  7. package/android/gradle.properties +5 -0
  8. package/android/src/main/AndroidManifest.xml +2 -0
  9. package/android/src/main/cpp/cpp-adapter.cpp +12 -0
  10. package/android/src/main/java/com/margelo/nitro/chilkat/ChilkatRNPackage.java +33 -0
  11. package/chilkat-checksums.json +9 -0
  12. package/cpp/HybridAi.cpp +660 -0
  13. package/cpp/HybridAi.hpp +159 -0
  14. package/cpp/HybridAsn.cpp +403 -0
  15. package/cpp/HybridAsn.hpp +105 -0
  16. package/cpp/HybridAuthAws.cpp +188 -0
  17. package/cpp/HybridAuthAws.hpp +55 -0
  18. package/cpp/HybridAuthAzureSAS.cpp +142 -0
  19. package/cpp/HybridAuthAzureSAS.hpp +47 -0
  20. package/cpp/HybridAuthAzureStorage.cpp +144 -0
  21. package/cpp/HybridAuthAzureStorage.hpp +47 -0
  22. package/cpp/HybridAuthGoogle.cpp +215 -0
  23. package/cpp/HybridAuthGoogle.hpp +67 -0
  24. package/cpp/HybridBinData.cpp +439 -0
  25. package/cpp/HybridBinData.hpp +112 -0
  26. package/cpp/HybridBz2.cpp +177 -0
  27. package/cpp/HybridBz2.hpp +58 -0
  28. package/cpp/HybridCache.cpp +314 -0
  29. package/cpp/HybridCache.hpp +82 -0
  30. package/cpp/HybridCert.cpp +840 -0
  31. package/cpp/HybridCert.hpp +196 -0
  32. package/cpp/HybridCertChain.cpp +149 -0
  33. package/cpp/HybridCertChain.hpp +50 -0
  34. package/cpp/HybridCertStore.cpp +276 -0
  35. package/cpp/HybridCertStore.hpp +78 -0
  36. package/cpp/HybridCharset.cpp +333 -0
  37. package/cpp/HybridCharset.hpp +83 -0
  38. package/cpp/HybridCkDateTime.cpp +384 -0
  39. package/cpp/HybridCkDateTime.hpp +105 -0
  40. package/cpp/HybridCodeSign.cpp +156 -0
  41. package/cpp/HybridCodeSign.hpp +55 -0
  42. package/cpp/HybridCompression.cpp +422 -0
  43. package/cpp/HybridCompression.hpp +100 -0
  44. package/cpp/HybridCrypt2.cpp +1517 -0
  45. package/cpp/HybridCrypt2.hpp +320 -0
  46. package/cpp/HybridCsr.cpp +292 -0
  47. package/cpp/HybridCsr.hpp +77 -0
  48. package/cpp/HybridCsv.cpp +382 -0
  49. package/cpp/HybridCsv.hpp +101 -0
  50. package/cpp/HybridDh.cpp +137 -0
  51. package/cpp/HybridDh.hpp +47 -0
  52. package/cpp/HybridDirTree.cpp +167 -0
  53. package/cpp/HybridDirTree.hpp +53 -0
  54. package/cpp/HybridDkim.cpp +249 -0
  55. package/cpp/HybridDkim.hpp +74 -0
  56. package/cpp/HybridDns.cpp +193 -0
  57. package/cpp/HybridDns.hpp +64 -0
  58. package/cpp/HybridDsa.cpp +453 -0
  59. package/cpp/HybridDsa.hpp +112 -0
  60. package/cpp/HybridDtObj.cpp +172 -0
  61. package/cpp/HybridDtObj.hpp +57 -0
  62. package/cpp/HybridEcc.cpp +195 -0
  63. package/cpp/HybridEcc.hpp +55 -0
  64. package/cpp/HybridEdDSA.cpp +147 -0
  65. package/cpp/HybridEdDSA.hpp +47 -0
  66. package/cpp/HybridEmail.cpp +1911 -0
  67. package/cpp/HybridEmail.hpp +419 -0
  68. package/cpp/HybridEmailBundle.cpp +204 -0
  69. package/cpp/HybridEmailBundle.hpp +64 -0
  70. package/cpp/HybridFileAccess.cpp +631 -0
  71. package/cpp/HybridFileAccess.hpp +149 -0
  72. package/cpp/HybridFtp2.cpp +2308 -0
  73. package/cpp/HybridFtp2.hpp +462 -0
  74. package/cpp/HybridGlobal.cpp +221 -0
  75. package/cpp/HybridGlobal.hpp +68 -0
  76. package/cpp/HybridGzip.cpp +440 -0
  77. package/cpp/HybridGzip.hpp +105 -0
  78. package/cpp/HybridHashtable.cpp +211 -0
  79. package/cpp/HybridHashtable.hpp +64 -0
  80. package/cpp/HybridHtmlToText.cpp +136 -0
  81. package/cpp/HybridHtmlToText.hpp +47 -0
  82. package/cpp/HybridHtmlToXml.cpp +218 -0
  83. package/cpp/HybridHtmlToXml.hpp +65 -0
  84. package/cpp/HybridHttp.cpp +2067 -0
  85. package/cpp/HybridHttp.hpp +416 -0
  86. package/cpp/HybridHttpCurl.cpp +337 -0
  87. package/cpp/HybridHttpCurl.hpp +93 -0
  88. package/cpp/HybridHttpRequest.cpp +455 -0
  89. package/cpp/HybridHttpRequest.hpp +109 -0
  90. package/cpp/HybridHttpResponse.cpp +340 -0
  91. package/cpp/HybridHttpResponse.hpp +86 -0
  92. package/cpp/HybridImap.cpp +1818 -0
  93. package/cpp/HybridImap.hpp +363 -0
  94. package/cpp/HybridJavaKeyStore.cpp +387 -0
  95. package/cpp/HybridJavaKeyStore.hpp +98 -0
  96. package/cpp/HybridJs.cpp +154 -0
  97. package/cpp/HybridJs.hpp +54 -0
  98. package/cpp/HybridJsonArray.cpp +441 -0
  99. package/cpp/HybridJsonArray.hpp +120 -0
  100. package/cpp/HybridJsonObject.cpp +1125 -0
  101. package/cpp/HybridJsonObject.hpp +260 -0
  102. package/cpp/HybridJwe.cpp +294 -0
  103. package/cpp/HybridJwe.hpp +82 -0
  104. package/cpp/HybridJws.cpp +290 -0
  105. package/cpp/HybridJws.hpp +82 -0
  106. package/cpp/HybridJwt.cpp +198 -0
  107. package/cpp/HybridJwt.hpp +57 -0
  108. package/cpp/HybridLog.cpp +212 -0
  109. package/cpp/HybridLog.hpp +63 -0
  110. package/cpp/HybridMailMan.cpp +1853 -0
  111. package/cpp/HybridMailMan.hpp +386 -0
  112. package/cpp/HybridMailboxes.cpp +165 -0
  113. package/cpp/HybridMailboxes.hpp +54 -0
  114. package/cpp/HybridMcp.cpp +322 -0
  115. package/cpp/HybridMcp.hpp +85 -0
  116. package/cpp/HybridMessageSet.cpp +162 -0
  117. package/cpp/HybridMessageSet.hpp +54 -0
  118. package/cpp/HybridMht.cpp +700 -0
  119. package/cpp/HybridMht.hpp +165 -0
  120. package/cpp/HybridMime.cpp +1119 -0
  121. package/cpp/HybridMime.hpp +266 -0
  122. package/cpp/HybridNtlm.cpp +333 -0
  123. package/cpp/HybridNtlm.hpp +83 -0
  124. package/cpp/HybridOAuth1.cpp +307 -0
  125. package/cpp/HybridOAuth1.hpp +78 -0
  126. package/cpp/HybridOAuth2.cpp +515 -0
  127. package/cpp/HybridOAuth2.hpp +127 -0
  128. package/cpp/HybridPdf.cpp +370 -0
  129. package/cpp/HybridPdf.hpp +103 -0
  130. package/cpp/HybridPem.cpp +327 -0
  131. package/cpp/HybridPem.hpp +88 -0
  132. package/cpp/HybridPfx.cpp +343 -0
  133. package/cpp/HybridPfx.hpp +87 -0
  134. package/cpp/HybridPkcs11.cpp +318 -0
  135. package/cpp/HybridPkcs11.hpp +88 -0
  136. package/cpp/HybridPrivateKey.cpp +464 -0
  137. package/cpp/HybridPrivateKey.hpp +117 -0
  138. package/cpp/HybridPrng.cpp +192 -0
  139. package/cpp/HybridPrng.hpp +57 -0
  140. package/cpp/HybridPublicKey.cpp +238 -0
  141. package/cpp/HybridPublicKey.hpp +68 -0
  142. package/cpp/HybridRest.cpp +993 -0
  143. package/cpp/HybridRest.hpp +214 -0
  144. package/cpp/HybridRsa.cpp +348 -0
  145. package/cpp/HybridRsa.hpp +90 -0
  146. package/cpp/HybridSCard.cpp +328 -0
  147. package/cpp/HybridSCard.hpp +91 -0
  148. package/cpp/HybridSFtp.cpp +1889 -0
  149. package/cpp/HybridSFtp.hpp +366 -0
  150. package/cpp/HybridSFtpDir.cpp +119 -0
  151. package/cpp/HybridSFtpDir.hpp +43 -0
  152. package/cpp/HybridSFtpFile.cpp +203 -0
  153. package/cpp/HybridSFtpFile.hpp +60 -0
  154. package/cpp/HybridScMinidriver.cpp +341 -0
  155. package/cpp/HybridScMinidriver.hpp +88 -0
  156. package/cpp/HybridScp.cpp +398 -0
  157. package/cpp/HybridScp.hpp +96 -0
  158. package/cpp/HybridSecrets.cpp +328 -0
  159. package/cpp/HybridSecrets.hpp +84 -0
  160. package/cpp/HybridSecureString.cpp +175 -0
  161. package/cpp/HybridSecureString.hpp +55 -0
  162. package/cpp/HybridServerSentEvent.cpp +112 -0
  163. package/cpp/HybridServerSentEvent.hpp +41 -0
  164. package/cpp/HybridSocket.cpp +1567 -0
  165. package/cpp/HybridSocket.hpp +336 -0
  166. package/cpp/HybridSpider.cpp +543 -0
  167. package/cpp/HybridSpider.hpp +138 -0
  168. package/cpp/HybridSsh.cpp +1330 -0
  169. package/cpp/HybridSsh.hpp +282 -0
  170. package/cpp/HybridSshKey.cpp +310 -0
  171. package/cpp/HybridSshKey.hpp +83 -0
  172. package/cpp/HybridSshTunnel.cpp +687 -0
  173. package/cpp/HybridSshTunnel.hpp +159 -0
  174. package/cpp/HybridStream.cpp +496 -0
  175. package/cpp/HybridStream.hpp +123 -0
  176. package/cpp/HybridStringArray.cpp +368 -0
  177. package/cpp/HybridStringArray.hpp +99 -0
  178. package/cpp/HybridStringBuilder.cpp +739 -0
  179. package/cpp/HybridStringBuilder.hpp +178 -0
  180. package/cpp/HybridStringTable.cpp +218 -0
  181. package/cpp/HybridStringTable.hpp +66 -0
  182. package/cpp/HybridTar.cpp +547 -0
  183. package/cpp/HybridTar.hpp +134 -0
  184. package/cpp/HybridTrustedRoots.cpp +178 -0
  185. package/cpp/HybridTrustedRoots.hpp +61 -0
  186. package/cpp/HybridUnixCompress.cpp +191 -0
  187. package/cpp/HybridUnixCompress.hpp +60 -0
  188. package/cpp/HybridUpload.cpp +427 -0
  189. package/cpp/HybridUpload.hpp +114 -0
  190. package/cpp/HybridUrl.cpp +152 -0
  191. package/cpp/HybridUrl.hpp +48 -0
  192. package/cpp/HybridWebSocket.cpp +378 -0
  193. package/cpp/HybridWebSocket.hpp +103 -0
  194. package/cpp/HybridXml.cpp +1527 -0
  195. package/cpp/HybridXml.hpp +340 -0
  196. package/cpp/HybridXmlCertVault.cpp +215 -0
  197. package/cpp/HybridXmlCertVault.hpp +63 -0
  198. package/cpp/HybridXmlDSig.cpp +328 -0
  199. package/cpp/HybridXmlDSig.hpp +88 -0
  200. package/cpp/HybridXmlDSigGen.cpp +549 -0
  201. package/cpp/HybridXmlDSigGen.hpp +126 -0
  202. package/cpp/HybridXmp.cpp +329 -0
  203. package/cpp/HybridXmp.hpp +86 -0
  204. package/cpp/HybridZip.cpp +1000 -0
  205. package/cpp/HybridZip.hpp +226 -0
  206. package/cpp/HybridZipCrc.cpp +162 -0
  207. package/cpp/HybridZipCrc.hpp +57 -0
  208. package/cpp/HybridZipEntry.cpp +395 -0
  209. package/cpp/HybridZipEntry.hpp +102 -0
  210. package/cpp/runtime/AsyncCall.hpp +96 -0
  211. package/cpp/runtime/Bytes.hpp +49 -0
  212. package/cpp/runtime/ChilkatError.hpp +66 -0
  213. package/cpp/runtime/ChilkatObject.hpp +219 -0
  214. package/cpp/runtime/ProgLang.hpp +9 -0
  215. package/cpp/runtime/ProgressAdapter.hpp +43 -0
  216. package/nitro.json +113 -0
  217. package/nitrogen/generated/.gitattributes +1 -0
  218. package/nitrogen/generated/android/ChilkatRN+autolinking.cmake +179 -0
  219. package/nitrogen/generated/android/ChilkatRN+autolinking.gradle +27 -0
  220. package/nitrogen/generated/android/ChilkatRNOnLoad.cpp +1029 -0
  221. package/nitrogen/generated/android/ChilkatRNOnLoad.hpp +34 -0
  222. package/nitrogen/generated/android/kotlin/com/margelo/nitro/chilkat/ChilkatRNOnLoad.kt +35 -0
  223. package/nitrogen/generated/ios/ChilkatRN+autolinking.rb +62 -0
  224. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.cpp +17 -0
  225. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.hpp +27 -0
  226. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Umbrella.hpp +38 -0
  227. package/nitrogen/generated/ios/ChilkatRNAutolinking.mm +1015 -0
  228. package/nitrogen/generated/ios/ChilkatRNAutolinking.swift +16 -0
  229. package/nitrogen/generated/shared/c++/HybridAiSpec.cpp +114 -0
  230. package/nitrogen/generated/shared/c++/HybridAiSpec.hpp +175 -0
  231. package/nitrogen/generated/shared/c++/HybridAsnSpec.cpp +70 -0
  232. package/nitrogen/generated/shared/c++/HybridAsnSpec.hpp +116 -0
  233. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.cpp +49 -0
  234. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.hpp +89 -0
  235. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.cpp +38 -0
  236. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.hpp +78 -0
  237. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.cpp +41 -0
  238. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.hpp +81 -0
  239. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.cpp +56 -0
  240. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.hpp +108 -0
  241. package/nitrogen/generated/shared/c++/HybridBinDataSpec.cpp +69 -0
  242. package/nitrogen/generated/shared/c++/HybridBinDataSpec.hpp +116 -0
  243. package/nitrogen/generated/shared/c++/HybridBz2Spec.cpp +47 -0
  244. package/nitrogen/generated/shared/c++/HybridBz2Spec.hpp +93 -0
  245. package/nitrogen/generated/shared/c++/HybridCacheSpec.cpp +57 -0
  246. package/nitrogen/generated/shared/c++/HybridCacheSpec.hpp +106 -0
  247. package/nitrogen/generated/shared/c++/HybridCertChainSpec.cpp +40 -0
  248. package/nitrogen/generated/shared/c++/HybridCertChainSpec.hpp +89 -0
  249. package/nitrogen/generated/shared/c++/HybridCertSpec.cpp +138 -0
  250. package/nitrogen/generated/shared/c++/HybridCertSpec.hpp +205 -0
  251. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.cpp +55 -0
  252. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.hpp +104 -0
  253. package/nitrogen/generated/shared/c++/HybridCharsetSpec.cpp +61 -0
  254. package/nitrogen/generated/shared/c++/HybridCharsetSpec.hpp +101 -0
  255. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.cpp +66 -0
  256. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.hpp +115 -0
  257. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.cpp +44 -0
  258. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.hpp +93 -0
  259. package/nitrogen/generated/shared/c++/HybridCompressionSpec.cpp +79 -0
  260. package/nitrogen/generated/shared/c++/HybridCompressionSpec.hpp +134 -0
  261. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.cpp +215 -0
  262. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.hpp +283 -0
  263. package/nitrogen/generated/shared/c++/HybridCsrSpec.cpp +61 -0
  264. package/nitrogen/generated/shared/c++/HybridCsrSpec.hpp +116 -0
  265. package/nitrogen/generated/shared/c++/HybridCsvSpec.cpp +72 -0
  266. package/nitrogen/generated/shared/c++/HybridCsvSpec.hpp +121 -0
  267. package/nitrogen/generated/shared/c++/HybridDhSpec.cpp +37 -0
  268. package/nitrogen/generated/shared/c++/HybridDhSpec.hpp +77 -0
  269. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.cpp +46 -0
  270. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.hpp +86 -0
  271. package/nitrogen/generated/shared/c++/HybridDkimSpec.cpp +60 -0
  272. package/nitrogen/generated/shared/c++/HybridDkimSpec.hpp +109 -0
  273. package/nitrogen/generated/shared/c++/HybridDnsSpec.cpp +51 -0
  274. package/nitrogen/generated/shared/c++/HybridDnsSpec.hpp +97 -0
  275. package/nitrogen/generated/shared/c++/HybridDsaSpec.cpp +73 -0
  276. package/nitrogen/generated/shared/c++/HybridDsaSpec.hpp +116 -0
  277. package/nitrogen/generated/shared/c++/HybridDtObjSpec.cpp +50 -0
  278. package/nitrogen/generated/shared/c++/HybridDtObjSpec.hpp +90 -0
  279. package/nitrogen/generated/shared/c++/HybridEccSpec.cpp +41 -0
  280. package/nitrogen/generated/shared/c++/HybridEccSpec.hpp +96 -0
  281. package/nitrogen/generated/shared/c++/HybridEdDSASpec.cpp +38 -0
  282. package/nitrogen/generated/shared/c++/HybridEdDSASpec.hpp +90 -0
  283. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.cpp +45 -0
  284. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.hpp +91 -0
  285. package/nitrogen/generated/shared/c++/HybridEmailSpec.cpp +259 -0
  286. package/nitrogen/generated/shared/c++/HybridEmailSpec.hpp +326 -0
  287. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.cpp +90 -0
  288. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.hpp +140 -0
  289. package/nitrogen/generated/shared/c++/HybridFtp2Spec.cpp +367 -0
  290. package/nitrogen/generated/shared/c++/HybridFtp2Spec.hpp +434 -0
  291. package/nitrogen/generated/shared/c++/HybridGlobalSpec.cpp +59 -0
  292. package/nitrogen/generated/shared/c++/HybridGlobalSpec.hpp +99 -0
  293. package/nitrogen/generated/shared/c++/HybridGzipSpec.cpp +79 -0
  294. package/nitrogen/generated/shared/c++/HybridGzipSpec.hpp +134 -0
  295. package/nitrogen/generated/shared/c++/HybridHashtableSpec.cpp +45 -0
  296. package/nitrogen/generated/shared/c++/HybridHashtableSpec.hpp +91 -0
  297. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.cpp +40 -0
  298. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.hpp +83 -0
  299. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.cpp +49 -0
  300. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.hpp +95 -0
  301. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.cpp +67 -0
  302. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.hpp +125 -0
  303. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.cpp +76 -0
  304. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.hpp +122 -0
  305. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.cpp +64 -0
  306. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.hpp +119 -0
  307. package/nitrogen/generated/shared/c++/HybridHttpSpec.cpp +334 -0
  308. package/nitrogen/generated/shared/c++/HybridHttpSpec.hpp +407 -0
  309. package/nitrogen/generated/shared/c++/HybridImapSpec.cpp +275 -0
  310. package/nitrogen/generated/shared/c++/HybridImapSpec.hpp +360 -0
  311. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.cpp +65 -0
  312. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.hpp +132 -0
  313. package/nitrogen/generated/shared/c++/HybridJsSpec.cpp +43 -0
  314. package/nitrogen/generated/shared/c++/HybridJsSpec.hpp +92 -0
  315. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.cpp +76 -0
  316. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.hpp +131 -0
  317. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.cpp +154 -0
  318. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.hpp +218 -0
  319. package/nitrogen/generated/shared/c++/HybridJweSpec.cpp +57 -0
  320. package/nitrogen/generated/shared/c++/HybridJweSpec.hpp +112 -0
  321. package/nitrogen/generated/shared/c++/HybridJwsSpec.cpp +57 -0
  322. package/nitrogen/generated/shared/c++/HybridJwsSpec.hpp +115 -0
  323. package/nitrogen/generated/shared/c++/HybridJwtSpec.cpp +43 -0
  324. package/nitrogen/generated/shared/c++/HybridJwtSpec.hpp +92 -0
  325. package/nitrogen/generated/shared/c++/HybridLogSpec.cpp +44 -0
  326. package/nitrogen/generated/shared/c++/HybridLogSpec.hpp +85 -0
  327. package/nitrogen/generated/shared/c++/HybridMailManSpec.cpp +311 -0
  328. package/nitrogen/generated/shared/c++/HybridMailManSpec.hpp +396 -0
  329. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.cpp +40 -0
  330. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.hpp +80 -0
  331. package/nitrogen/generated/shared/c++/HybridMcpSpec.cpp +68 -0
  332. package/nitrogen/generated/shared/c++/HybridMcpSpec.hpp +117 -0
  333. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.cpp +41 -0
  334. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.hpp +84 -0
  335. package/nitrogen/generated/shared/c++/HybridMhtSpec.cpp +138 -0
  336. package/nitrogen/generated/shared/c++/HybridMhtSpec.hpp +181 -0
  337. package/nitrogen/generated/shared/c++/HybridMimeSpec.cpp +169 -0
  338. package/nitrogen/generated/shared/c++/HybridMimeSpec.hpp +233 -0
  339. package/nitrogen/generated/shared/c++/HybridNtlmSpec.cpp +69 -0
  340. package/nitrogen/generated/shared/c++/HybridNtlmSpec.hpp +109 -0
  341. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.cpp +67 -0
  342. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.hpp +110 -0
  343. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.cpp +107 -0
  344. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.hpp +156 -0
  345. package/nitrogen/generated/shared/c++/HybridPdfSpec.cpp +73 -0
  346. package/nitrogen/generated/shared/c++/HybridPdfSpec.hpp +134 -0
  347. package/nitrogen/generated/shared/c++/HybridPemSpec.cpp +63 -0
  348. package/nitrogen/generated/shared/c++/HybridPemSpec.hpp +124 -0
  349. package/nitrogen/generated/shared/c++/HybridPfxSpec.cpp +61 -0
  350. package/nitrogen/generated/shared/c++/HybridPfxSpec.hpp +122 -0
  351. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.cpp +60 -0
  352. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.hpp +115 -0
  353. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.cpp +76 -0
  354. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.hpp +131 -0
  355. package/nitrogen/generated/shared/c++/HybridPrngSpec.cpp +42 -0
  356. package/nitrogen/generated/shared/c++/HybridPrngSpec.hpp +85 -0
  357. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.cpp +48 -0
  358. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.hpp +91 -0
  359. package/nitrogen/generated/shared/c++/HybridRestSpec.cpp +150 -0
  360. package/nitrogen/generated/shared/c++/HybridRestSpec.hpp +229 -0
  361. package/nitrogen/generated/shared/c++/HybridRsaSpec.cpp +68 -0
  362. package/nitrogen/generated/shared/c++/HybridRsaSpec.hpp +120 -0
  363. package/nitrogen/generated/shared/c++/HybridSCardSpec.cpp +64 -0
  364. package/nitrogen/generated/shared/c++/HybridSCardSpec.hpp +116 -0
  365. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.cpp +35 -0
  366. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.hpp +78 -0
  367. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.cpp +57 -0
  368. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.hpp +98 -0
  369. package/nitrogen/generated/shared/c++/HybridSFtpSpec.cpp +284 -0
  370. package/nitrogen/generated/shared/c++/HybridSFtpSpec.hpp +354 -0
  371. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.cpp +61 -0
  372. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.hpp +119 -0
  373. package/nitrogen/generated/shared/c++/HybridScpSpec.cpp +78 -0
  374. package/nitrogen/generated/shared/c++/HybridScpSpec.hpp +127 -0
  375. package/nitrogen/generated/shared/c++/HybridSecretsSpec.cpp +65 -0
  376. package/nitrogen/generated/shared/c++/HybridSecretsSpec.hpp +120 -0
  377. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.cpp +42 -0
  378. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.hpp +88 -0
  379. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.cpp +35 -0
  380. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.hpp +75 -0
  381. package/nitrogen/generated/shared/c++/HybridSocketSpec.cpp +262 -0
  382. package/nitrogen/generated/shared/c++/HybridSocketSpec.hpp +327 -0
  383. package/nitrogen/generated/shared/c++/HybridSpiderSpec.cpp +110 -0
  384. package/nitrogen/generated/shared/c++/HybridSpiderSpec.hpp +153 -0
  385. package/nitrogen/generated/shared/c++/HybridSshKeySpec.cpp +59 -0
  386. package/nitrogen/generated/shared/c++/HybridSshKeySpec.hpp +102 -0
  387. package/nitrogen/generated/shared/c++/HybridSshSpec.cpp +215 -0
  388. package/nitrogen/generated/shared/c++/HybridSshSpec.hpp +276 -0
  389. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.cpp +136 -0
  390. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.hpp +191 -0
  391. package/nitrogen/generated/shared/c++/HybridStreamSpec.cpp +100 -0
  392. package/nitrogen/generated/shared/c++/HybridStreamSpec.hpp +150 -0
  393. package/nitrogen/generated/shared/c++/HybridStringArraySpec.cpp +66 -0
  394. package/nitrogen/generated/shared/c++/HybridStringArraySpec.hpp +109 -0
  395. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.cpp +104 -0
  396. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.hpp +156 -0
  397. package/nitrogen/generated/shared/c++/HybridStringTableSpec.cpp +46 -0
  398. package/nitrogen/generated/shared/c++/HybridStringTableSpec.hpp +89 -0
  399. package/nitrogen/generated/shared/c++/HybridTarSpec.cpp +110 -0
  400. package/nitrogen/generated/shared/c++/HybridTarSpec.hpp +156 -0
  401. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.cpp +48 -0
  402. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.hpp +97 -0
  403. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.cpp +48 -0
  404. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.hpp +91 -0
  405. package/nitrogen/generated/shared/c++/HybridUploadSpec.cpp +98 -0
  406. package/nitrogen/generated/shared/c++/HybridUploadSpec.hpp +141 -0
  407. package/nitrogen/generated/shared/c++/HybridUrlSpec.cpp +42 -0
  408. package/nitrogen/generated/shared/c++/HybridUrlSpec.hpp +82 -0
  409. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.cpp +80 -0
  410. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.hpp +135 -0
  411. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.cpp +45 -0
  412. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.hpp +94 -0
  413. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.cpp +99 -0
  414. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.hpp +163 -0
  415. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.cpp +62 -0
  416. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.hpp +126 -0
  417. package/nitrogen/generated/shared/c++/HybridXmlSpec.cpp +203 -0
  418. package/nitrogen/generated/shared/c++/HybridXmlSpec.hpp +253 -0
  419. package/nitrogen/generated/shared/c++/HybridXmpSpec.cpp +58 -0
  420. package/nitrogen/generated/shared/c++/HybridXmpSpec.hpp +104 -0
  421. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.cpp +43 -0
  422. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.hpp +92 -0
  423. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.cpp +82 -0
  424. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.hpp +137 -0
  425. package/nitrogen/generated/shared/c++/HybridZipSpec.cpp +176 -0
  426. package/nitrogen/generated/shared/c++/HybridZipSpec.hpp +231 -0
  427. package/package.json +46 -0
  428. package/react-native.config.js +9 -0
  429. package/scripts/fetch-chilkat.js +184 -0
  430. package/src/index.ts +306 -0
  431. package/src/runtime/chilkat.ts +25 -0
  432. package/src/specs/Ai.nitro.ts +1288 -0
  433. package/src/specs/Asn.nitro.ts +509 -0
  434. package/src/specs/AuthAws.nitro.ts +234 -0
  435. package/src/specs/AuthAzureSAS.nitro.ts +205 -0
  436. package/src/specs/AuthAzureStorage.nitro.ts +172 -0
  437. package/src/specs/AuthGoogle.nitro.ts +291 -0
  438. package/src/specs/BinData.nitro.ts +470 -0
  439. package/src/specs/Bz2.nitro.ts +269 -0
  440. package/src/specs/Cache.nitro.ts +483 -0
  441. package/src/specs/Cert.nitro.ts +1279 -0
  442. package/src/specs/CertChain.nitro.ts +312 -0
  443. package/src/specs/CertStore.nitro.ts +430 -0
  444. package/src/specs/Charset.nitro.ts +518 -0
  445. package/src/specs/CkDateTime.nitro.ts +492 -0
  446. package/src/specs/CodeSign.nitro.ts +307 -0
  447. package/src/specs/Compression.nitro.ts +654 -0
  448. package/src/specs/Crypt2.nitro.ts +2387 -0
  449. package/src/specs/Csr.nitro.ts +461 -0
  450. package/src/specs/Csv.nitro.ts +670 -0
  451. package/src/specs/Dh.nitro.ts +343 -0
  452. package/src/specs/DirTree.nitro.ts +332 -0
  453. package/src/specs/Dkim.nitro.ts +595 -0
  454. package/src/specs/Dns.nitro.ts +271 -0
  455. package/src/specs/Dsa.nitro.ts +653 -0
  456. package/src/specs/DtObj.nitro.ts +198 -0
  457. package/src/specs/Ecc.nitro.ts +375 -0
  458. package/src/specs/EdDSA.nitro.ts +273 -0
  459. package/src/specs/Email.nitro.ts +2921 -0
  460. package/src/specs/EmailBundle.nitro.ts +334 -0
  461. package/src/specs/FileAccess.nitro.ts +836 -0
  462. package/src/specs/Ftp2.nitro.ts +3943 -0
  463. package/src/specs/Global.nitro.ts +319 -0
  464. package/src/specs/Gzip.nitro.ts +646 -0
  465. package/src/specs/Hashtable.nitro.ts +356 -0
  466. package/src/specs/HtmlToText.nitro.ts +238 -0
  467. package/src/specs/HtmlToXml.nitro.ts +323 -0
  468. package/src/specs/Http.nitro.ts +3095 -0
  469. package/src/specs/HttpCurl.nitro.ts +550 -0
  470. package/src/specs/HttpRequest.nitro.ts +522 -0
  471. package/src/specs/HttpResponse.nitro.ts +424 -0
  472. package/src/specs/Imap.nitro.ts +2991 -0
  473. package/src/specs/JavaKeyStore.nitro.ts +619 -0
  474. package/src/specs/Js.nitro.ts +263 -0
  475. package/src/specs/JsonArray.nitro.ts +681 -0
  476. package/src/specs/JsonObject.nitro.ts +1454 -0
  477. package/src/specs/Jwe.nitro.ts +756 -0
  478. package/src/specs/Jws.nitro.ts +733 -0
  479. package/src/specs/Jwt.nitro.ts +380 -0
  480. package/src/specs/Log.nitro.ts +258 -0
  481. package/src/specs/MailMan.nitro.ts +3571 -0
  482. package/src/specs/Mailboxes.nitro.ts +251 -0
  483. package/src/specs/Mcp.nitro.ts +491 -0
  484. package/src/specs/MessageSet.nitro.ts +320 -0
  485. package/src/specs/Mht.nitro.ts +1684 -0
  486. package/src/specs/Mime.nitro.ts +1745 -0
  487. package/src/specs/Ntlm.nitro.ts +556 -0
  488. package/src/specs/OAuth1.nitro.ts +331 -0
  489. package/src/specs/OAuth2.nitro.ts +1023 -0
  490. package/src/specs/Pdf.nitro.ts +740 -0
  491. package/src/specs/Pem.nitro.ts +484 -0
  492. package/src/specs/Pfx.nitro.ts +1003 -0
  493. package/src/specs/Pkcs11.nitro.ts +559 -0
  494. package/src/specs/PrivateKey.nitro.ts +994 -0
  495. package/src/specs/Prng.nitro.ts +348 -0
  496. package/src/specs/PublicKey.nitro.ts +610 -0
  497. package/src/specs/Rest.nitro.ts +1972 -0
  498. package/src/specs/Rsa.nitro.ts +453 -0
  499. package/src/specs/SCard.nitro.ts +739 -0
  500. package/src/specs/SFtp.nitro.ts +3138 -0
  501. package/src/specs/SFtpDir.nitro.ts +213 -0
  502. package/src/specs/SFtpFile.nitro.ts +452 -0
  503. package/src/specs/ScMinidriver.nitro.ts +443 -0
  504. package/src/specs/Scp.nitro.ts +708 -0
  505. package/src/specs/Secrets.nitro.ts +470 -0
  506. package/src/specs/SecureString.nitro.ts +231 -0
  507. package/src/specs/ServerSentEvent.nitro.ts +183 -0
  508. package/src/specs/Socket.nitro.ts +3335 -0
  509. package/src/specs/Spider.nitro.ts +609 -0
  510. package/src/specs/Ssh.nitro.ts +2842 -0
  511. package/src/specs/SshKey.nitro.ts +740 -0
  512. package/src/specs/SshTunnel.nitro.ts +1243 -0
  513. package/src/specs/Stream.nitro.ts +737 -0
  514. package/src/specs/StringArray.nitro.ts +396 -0
  515. package/src/specs/StringBuilder.nitro.ts +920 -0
  516. package/src/specs/StringTable.nitro.ts +271 -0
  517. package/src/specs/Tar.nitro.ts +804 -0
  518. package/src/specs/TrustedRoots.nitro.ts +360 -0
  519. package/src/specs/UnixCompress.nitro.ts +293 -0
  520. package/src/specs/Upload.nitro.ts +623 -0
  521. package/src/specs/Url.nitro.ts +246 -0
  522. package/src/specs/WebSocket.nitro.ts +840 -0
  523. package/src/specs/Xml.nitro.ts +1988 -0
  524. package/src/specs/XmlCertVault.nitro.ts +259 -0
  525. package/src/specs/XmlDSig.nitro.ts +464 -0
  526. package/src/specs/XmlDSigGen.nitro.ts +978 -0
  527. package/src/specs/Xmp.nitro.ts +364 -0
  528. package/src/specs/Zip.nitro.ts +1611 -0
  529. package/src/specs/ZipCrc.nitro.ts +229 -0
  530. package/src/specs/ZipEntry.nitro.ts +782 -0
@@ -0,0 +1,1684 @@
1
+ // Generated by ReactNativeNs.RnGenerator -- do not edit.
2
+ import type { HybridObject } from 'react-native-nitro-modules'
3
+
4
+ /**
5
+ * Create, save, zip, email, and unpack MHT web archives.
6
+ *
7
+ * `Mht` creates MHT web archives and EML email messages
8
+ * from HTTP/HTTPS pages, local HTML files, or in-memory HTML strings. It
9
+ * analyzes the supplied HTML source, resolves and retrieves supported static
10
+ * resources, rewrites references as needed, and packages the result as MIME.
11
+ * It also supports disk caching, proxies, authentication, file or ZIP output,
12
+ * and unpacking existing MHT data.
13
+ *
14
+ * **Create MHT archives**
15
+ *
16
+ * Convert a web page, local HTML file, or HTML string into an MHT archive
17
+ * with supported related resources embedded when settings permit and each
18
+ * resource can be obtained.
19
+ *
20
+ * **Generate EML messages**
21
+ *
22
+ * Produce an HTML-email MIME draft from HTML. Image embedding follows
23
+ * `EmbedImages` and `EmbedLocalOnly`; scripts, frames, and
24
+ * comments are removed. Addressing, subject, and sending remain application tasks.
25
+ *
26
+ * **Embed static resources**
27
+ *
28
+ * Capture images, CSS, CSS imports and backgrounds, and—when producing
29
+ * MHT—frames and supported external scripts.
30
+ *
31
+ * **Network configuration**
32
+ *
33
+ * Use proxy settings, authentication, caching, redirects, capture-scoped cookies,
34
+ * and related options when fetching pages and dependent resources.
35
+ *
36
+ * **Save or zip output**
37
+ *
38
+ * Return generated MHT or EML text in memory, save it to disk, or place it
39
+ * into a ZIP archive.
40
+ *
41
+ * **Unpack MHT files**
42
+ *
43
+ * Extract an MHT archive into an HTML file plus supporting resource files
44
+ * for inspection, editing, or republishing.
45
+ *
46
+ * **Not a browser rendering engine:**
47
+ * `Mht` does not execute JavaScript, build or wait for a browser DOM,
48
+ * trigger lazy loading, or capture AJAX, `fetch`, XHR, React, Angular,
49
+ * Vue, or other client-rendered content. It captures the original HTML source
50
+ * and resources that are statically referenced by that source. MHT output can
51
+ * preserve scripts so they may execute when the saved archive is later opened;
52
+ * EML output always removes scripts.
53
+ *
54
+ * **URL or local file:**
55
+ * Methods accepting a URL-or-file argument use a strict prefix rule. A value is
56
+ * a web URL only if it begins, case-insensitively, with `http:` or
57
+ * `https:`. Every other value is treated as a local path.
58
+ * `file://` is not recognized. Relative paths use the process current
59
+ * working directory, and a local source file must already exist and be readable.
60
+ *
61
+ * **Base resolution:**
62
+ * Resolution precedence is the HTML `<base href>` element, then
63
+ * `BaseUrl`, then the source page URL or local file directory. Use a
64
+ * URL—not a filesystem directory—for `BaseUrl`, and end a directory-style
65
+ * base URL with `/`. Downloaded CSS resolves its own relative
66
+ * `url(...)` and `@import` references against the stylesheet URL;
67
+ * inline CSS resolves against the page base.
68
+ *
69
+ * **Default static resource handling:**
70
+ *
71
+ * HTML/CSS reference
72
+ * Behavior
73
+ *
74
+ * | `<img src>` | | Captured by default, subject to `EmbedImages` and `EmbedLocalOnly`. |
75
+ *
76
+ * | `srcset` / `sizes` | | Not used for candidate selection. These attributes are stripped and the
77
+ * ordinary `src` is used; obvious spacer placeholders are detected so the real image can be
78
+ * captured. |
79
+ *
80
+ * | CSS `url(...)` | | Captured from external style sheets, `<style>` blocks, and inline `style`
81
+ * attributes. |
82
+ *
83
+ * | CSS `@import` | | Downloaded, inlined, and processed recursively. |
84
+ *
85
+ * | `<link rel="stylesheet">` | | Downloaded and inlined; its CSS references are then processed
86
+ * recursively. |
87
+ *
88
+ * | `<iframe>` / `<frame>` | | Fetched and captured for MHT; removed for EML. |
89
+ *
90
+ * | `<script src>` | | Supported external scripts are captured for MHT and inline scripts may be
91
+ * retained; all scripts are removed for EML. Script handling remains subject to `NoScripts` and
92
+ * `PreferMHTScripts`. |
93
+ *
94
+ * | `<object data>`, `<embed src>`, media elements | | References are made absolute, but the
95
+ * payload is not downloaded. This includes `video`, `audio`, `source`, and `track`. |
96
+ *
97
+ * | Favicons | | Not captured. |
98
+ *
99
+ * | Navigation and form URLs | | Made absolute when possible, but their targets are not downloaded.
100
+ * |
101
+ *
102
+ * | HTTP redirects | | Followed for the primary page and dependent resources. After a primary
103
+ * redirect, relative references use the final landing URL as their base. |
104
+ *
105
+ * **Dependent-resource failures do not fail the capture:**
106
+ * If a dependent image, style sheet, imported CSS file, frame, script, or other
107
+ * supported resource cannot be downloaded, Chilkat omits that MIME part,
108
+ * restores the HTML reference to the original absolute live URL, logs the
109
+ * problem in `LastErrorText`, and continues with a successful result.
110
+ * No empty placeholder part is created. Failure to load the primary URL or
111
+ * local HTML file does fail the operation. Consequently, output is fully
112
+ * self-contained only to the extent allowed by the embedding properties and
113
+ * the resources that were successfully obtained.
114
+ *
115
+ * **String-returning methods:**
116
+ * For `GetMHT`, `GetEML`, `HtmlToMHT`,
117
+ * `HtmlToEML`, and `GetCacheRoot`, check
118
+ * `LastMethodSuccess`. Do not infer success or failure from whether
119
+ * the returned string is empty. On failure the string is cleared or may contain
120
+ * partial output, and `LastErrorText` contains the diagnostic.
121
+ *
122
+ * **File output:**
123
+ * Save methods generate the MIME document in memory before opening the
124
+ * destination. Existing files are overwritten, parent directories are not
125
+ * created, and relative paths use the process current working directory. The
126
+ * final write is not atomic, so a write-time I/O failure can leave partial
127
+ * output. Generation failure leaves an existing destination file untouched.
128
+ *
129
+ * **Redirect and cookie behavior:**
130
+ * Redirects are followed automatically for the main page and dependent resources.
131
+ * Cookies received during one capture are retained and sent on later requests in
132
+ * that same capture. The redirect limit, exact followed status codes, and
133
+ * HTTPS-to-HTTP downgrade policy are controlled by the underlying HTTP engine and
134
+ * are not exposed as `Mht` settings.
135
+ *
136
+ * **Object state persists:**
137
+ * External style sheets, exclusion patterns, custom headers, and cache roots remain
138
+ * configured across conversions. `RestoreDefaults` clears only the external
139
+ * style-sheet and exclusion-pattern collections; it does not clear custom headers or
140
+ * cache roots. Cache roots can be reset only by using a new object.
141
+ *
142
+ * **Custom headers are cross-host:**
143
+ * Permitted custom headers are sent to the primary page, redirect targets, and every
144
+ * dependent-resource host. `Authorization` and `Content-Length` are
145
+ * rejected, but other sensitive fields such as a manually supplied `Cookie`
146
+ * can be sent to third-party hosts.
147
+ *
148
+ * **MHT versus EML:**
149
+ * Both are MIME documents with an HTML root and related embedded resources. MHT is a
150
+ * web-archive form and omits `Date` and `X-Unsent`. EML adds the
151
+ * current `Date` and `X-Unsent: 1`, removes scripts, frames, and
152
+ * comments, and is best treated as an HTML-email draft. It has no generated
153
+ * `Message-ID` and no plain-text alternative; the application must add the
154
+ * required addressing and subject information before sending.
155
+ *
156
+ * **Returned MIME strings:**
157
+ * Preserve CRLF line endings and write the result as UTF-8 without a BOM. Treat the
158
+ * string as opaque MIME text. The file-writing methods are preferable when exact
159
+ * serialized bytes are required.
160
+ *
161
+ * **ZIP and unpack safety:**
162
+ * ZIP methods reject an existing entry name and rewrite the complete archive
163
+ * non-atomically. Normal unpacking contains extracted paths beneath the requested
164
+ * directory, but existing files from earlier runs are overwritten. Direct unpack mode
165
+ * is for relative `Content-Location` values and skips parts whose locations
166
+ * are full URLs.
167
+ *
168
+ * **Common pattern:**
169
+ * Provide an HTTP/HTTPS URL, a readable local HTML path, or an HTML string;
170
+ * configure the base URL, proxy, authentication, caching, and resource options;
171
+ * then return, save, or zip the MHT/EML output. When the desired content exists
172
+ * only after JavaScript executes, first obtain rendered HTML with a browser or
173
+ * browser-automation tool and pass that HTML to an `HtmlTo*` method.
174
+ *
175
+ * For an extended overview, see
176
+ * [Mht Class Overview](https://www.chilkatsoft.com/mht_class_overview.asp).
177
+ *
178
+ * Each `Mht` instance owns a native Chilkat object. It is released when the JavaScript object is
179
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
180
+ * Create one with `new Mht()`.
181
+ *
182
+ * Methods that can take a while (network, files, compression, key generation) also have an
183
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
184
+ * rendering. While such a call is pending, every other call on this object throws, except
185
+ * {@link Mht.abort} and assigning {@link Mht.onPercentDone} / {@link Mht.onProgressInfo}.
186
+ */
187
+ export interface Mht extends HybridObject<{ ios: 'c++', android: 'c++' }> {
188
+ // ---- Properties ----
189
+
190
+ /**
191
+ * Provides HTML-formatted information about the last called method or property. If a method call
192
+ * fails or behaves unexpectedly, check this property for details. Note that information is
193
+ * available regardless of the method call's success.
194
+ *
195
+ * This property is read-only.
196
+ */
197
+ readonly lastErrorHtml: string
198
+
199
+ /**
200
+ * Provides plain text information about the last called method or property. If a method call
201
+ * fails or behaves unexpectedly, check this property for details. Note that information is
202
+ * available regardless of the method call's success.
203
+ *
204
+ * This property is read-only.
205
+ */
206
+ readonly lastErrorText: string
207
+
208
+ /**
209
+ * Provides XML-formatted information about the last called method or property. If a method call
210
+ * fails or behaves unexpectedly, check this property for details. Note that information is
211
+ * available regardless of the method call's success.
212
+ *
213
+ * This property is read-only.
214
+ */
215
+ readonly lastErrorXml: string
216
+
217
+ /**
218
+ * Version of the component/library, such as "10.1.0"
219
+ *
220
+ * This property is read-only.
221
+ */
222
+ readonly version: string
223
+
224
+ /**
225
+ * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
226
+ * call to the specified file. This logging helps identify the context and history of Chilkat
227
+ * calls leading up to any crash or hang, aiding in debugging.
228
+ *
229
+ * Enabling the VerboseLogging property provides more detailed information.
230
+ *
231
+ * This property is mainly used for debugging rare instances where a Chilkat method call causes a
232
+ * hang or crash, which should generally not happen.
233
+ *
234
+ * Possible causes of hangs include:
235
+ *
236
+ * - A timeout property set to 0, indicating an infinite timeout.
237
+ *
238
+ * - A hang occurring within an event callback in the application code.
239
+ *
240
+ * - An internal bug in the Chilkat code causing the hang.
241
+ */
242
+ debugLogFilePath: string
243
+
244
+ /**
245
+ * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
246
+ * contain more verbose information. The default value is `false`. Verbose logging should only be
247
+ * used for debugging. The potentially large quantity of logged information may adversely affect
248
+ * peformance.
249
+ */
250
+ verboseLogging: boolean
251
+
252
+ /**
253
+ * Indicates the success or failure of the most recent method call: `true` means success, `false`
254
+ * means failure. This property remains unchanged by property setters or getters. This method is
255
+ * present to address challenges in checking for null or Nothing returns in certain programming
256
+ * languages. Note: This property does not apply to methods that return integer values or to
257
+ * boolean-returning methods where the boolean does not indicate success or failure.
258
+ */
259
+ lastMethodSuccess: boolean
260
+
261
+ /**
262
+ * Specifies a web base URL used when relative references in a local HTML file or in-memory HTML
263
+ * string must be resolved in an HTTP/HTTPS context. For an HTTP/HTTPS source page, Chilkat
264
+ * derives the base from the fetched URL automatically.
265
+ *
266
+ * **Resolution precedence:** An HTML `<base href>` element takes precedence over this property.
267
+ * If no usable `<base>` exists, `BaseUrl` is used; otherwise Chilkat falls back to the source
268
+ * page URL or the directory containing the local HTML file.
269
+ *
270
+ * **Local files:** Relative filesystem references in a local HTML file can be resolved from the
271
+ * file's own directory without setting this property. Set `BaseUrl` when the document contains
272
+ * site-relative or root-relative references that should resolve against a web origin. The value
273
+ * should be an HTTP or HTTPS URL, not a filesystem directory.
274
+ *
275
+ * **Trailing slash:** URL resolution follows normal base-URL rules. Use a trailing slash for a
276
+ * directory-style base, such as `https://www.example.com/section/`. Without it, the last path
277
+ * segment is treated as a filename and is removed before relative resolution.
278
+ *
279
+ * Relative `url(...)` and `@import` references inside a downloaded external stylesheet are
280
+ * resolved against that stylesheet's final URL. References in inline `<style>` blocks and `style`
281
+ * attributes are resolved against the page base. If no usable base exists, unresolved relative
282
+ * references remain relative and their resources are not captured.
283
+ */
284
+ baseUrl: string
285
+
286
+ /**
287
+ * Specifies the maximum number of seconds allowed for establishing a connection to an HTTP
288
+ * server. The default is `10` seconds.
289
+ *
290
+ * **Connection timeout only:** This setting limits connection establishment; it is not a limit on
291
+ * the total time required to download a page. Use {@link Mht.readTimeout} to control inactivity
292
+ * while receiving data.
293
+ */
294
+ connectTimeout: number
295
+
296
+ /**
297
+ * Specifies a local file path where Chilkat saves the HTML after it has been processed for MHT or
298
+ * EML generation. Leave the property empty to disable this diagnostic output.
299
+ *
300
+ * **Troubleshooting aid:** Compare this file with {@link Mht.debugHtmlBefore} to inspect
301
+ * rewritten URLs, removed scripts, and other transformations applied before the MIME document is
302
+ * assembled. Do not enable diagnostic output to a sensitive or publicly accessible location.
303
+ *
304
+ * **Debug-file behavior:** An existing debug file is overwritten in place. Parent directories are
305
+ * not created, and a relative path is resolved against the process current working directory. The
306
+ * write is best-effort: failure to create or update the debug file is recorded diagnostically but
307
+ * does not cause the main MHT or EML operation to fail. The write is not atomic, so an I/O error
308
+ * can leave a partial debug file.
309
+ */
310
+ debugHtmlAfter: string
311
+
312
+ /**
313
+ * Specifies a local file path where Chilkat saves the source HTML before it is transformed for
314
+ * MHT or EML generation. Leave the property empty to disable this diagnostic output.
315
+ *
316
+ * **Troubleshooting aid:** Use this together with {@link Mht.debugHtmlAfter} to determine whether
317
+ * a problem originates in the input HTML or in the conversion and URL-rewriting process.
318
+ *
319
+ * **Debug-file behavior:** An existing debug file is overwritten in place. Parent directories are
320
+ * not created, and a relative path is resolved against the process current working directory. The
321
+ * write is best-effort: failure to create or update the debug file is recorded diagnostically but
322
+ * does not cause the main MHT or EML operation to fail. The write is not atomic, so an I/O error
323
+ * can leave a partial debug file.
324
+ */
325
+ debugHtmlBefore: string
326
+
327
+ /**
328
+ * Controls whether images referenced by the HTML are downloaded or read from disk and embedded as
329
+ * related MIME parts in both MHT and EML output. The default is `true`.
330
+ *
331
+ * `EmbedImages``EmbedLocalOnly`Image behavior
332
+ *
333
+ * | `false` | | Either | | No images are embedded. References are made absolute when sufficient
334
+ * base information is available. |
335
+ *
336
+ * | `true` | | `false` | | Local and HTTP/HTTPS images are embedded when they can be obtained.
337
+ * This is the default combination. |
338
+ *
339
+ * | `true` | | `true` | | Only local-file images are embedded. HTTP/HTTPS images remain external
340
+ * references. |
341
+ *
342
+ * **Recognized image source:** Chilkat captures the ordinary `<img src>` value. It does not use
343
+ * `srcset` or `sizes` to choose a candidate; those attributes are removed. Obvious spacer or 1×1
344
+ * placeholder sources are detected so the real image reference can be used when available.
345
+ *
346
+ * **Self-contained output:** MHT or EML output is self-contained with respect to images only when
347
+ * the settings permit embedding and every required image is successfully obtained. A failed image
348
+ * is omitted and its reference remains an absolute live URL.
349
+ */
350
+ embedImages: boolean
351
+
352
+ /**
353
+ * When `true`, only images whose references resolve to the local filesystem are embedded. Images
354
+ * referenced through HTTP or HTTPS remain external. The default is `false`. This property has an
355
+ * effect only when {@link Mht.embedImages} is `true` and applies to both MHT and EML output.
356
+ *
357
+ * **Scope:** This option applies to images, including image URLs found in HTML and CSS. It does
358
+ * not prevent Chilkat from fetching non-image web resources such as external style sheets or, for
359
+ * MHT output, supported frames and scripts.
360
+ */
361
+ embedLocalOnly: boolean
362
+
363
+ /**
364
+ * When `true`, Chilkat attempts to satisfy page and resource requests from the configured disk
365
+ * cache before downloading them. Add one or more cache directories with {@link Mht.addCacheRoot}.
366
+ * The default is `false`.
367
+ *
368
+ * **Related settings:** {@link Mht.updateCache} controls whether network responses are written to
369
+ * the cache. {@link Mht.ignoreMustRevalidate} and {@link Mht.ignoreNoCache} control whether
370
+ * certain HTTP cache directives are honored.
371
+ */
372
+ fetchFromCache: boolean
373
+
374
+ /**
375
+ * Specifies the interval, in milliseconds, between `AbortCheck` event callbacks during supported
376
+ * long-running operations. The default is `0`, which disables these periodic callbacks.
377
+ *
378
+ * **Cancellation:** An event handler may request cancellation when an `AbortCheck` callback
379
+ * occurs. Choose an interval that is responsive without generating excessive callback traffic.
380
+ */
381
+ heartbeatMs: number
382
+
383
+ /**
384
+ * Controls how cached responses containing `Cache-Control: must-revalidate` are handled. When
385
+ * `false` (the default), Chilkat revalidates such a cached response before reuse. When `true`, a
386
+ * still-fresh cached response may be used without revalidation. This property is relevant only
387
+ * when {@link Mht.fetchFromCache} is `true`.
388
+ *
389
+ * **Cache semantics:** Ignoring `must-revalidate` can improve offline or high-latency operation,
390
+ * but it may also use content the origin server intended to be checked before reuse.
391
+ */
392
+ ignoreMustRevalidate: boolean
393
+
394
+ /**
395
+ * Controls whether HTTP response directives that prohibit or restrict caching are ignored. The
396
+ * default is `false`, which honors the server's caching instructions. When `true`, Chilkat may
397
+ * store responses that would otherwise be excluded from the disk cache.
398
+ *
399
+ * **Use carefully:** Caching content against the origin server's instructions can retain stale,
400
+ * private, or sensitive data. Enable this only when the application controls the content or has a
401
+ * specific offline-caching requirement.
402
+ */
403
+ ignoreNoCache: boolean
404
+
405
+ /**
406
+ * Controls script removal when creating MHT output. When `true`, script content is removed. When
407
+ * `false` (the default), inline scripts and supported external scripts may be preserved according
408
+ * to {@link Mht.preferMHTScripts}.
409
+ *
410
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
411
+ * engine. It processes the original HTML source and statically referenced resources. Content
412
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
413
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
414
+ * when the saved archive is later opened; EML output removes scripts.
415
+ *
416
+ * **EML behavior:** Scripts are always removed when generating EML or email-oriented output,
417
+ * regardless of this property. Framed documents are also removed from EML output.
418
+ */
419
+ noScripts: boolean
420
+
421
+ /**
422
+ * When `true`, Chilkat uses NTLM authentication when the origin HTTP server requests
423
+ * authentication. The default is `false`. Set {@link Mht.webSiteLogin}, {@link
424
+ * Mht.webSitePassword}, and, when required, {@link Mht.webSiteLoginDomain}.
425
+ *
426
+ * **Origin versus proxy authentication:** These credentials authenticate to the website. Proxy
427
+ * credentials are configured separately with {@link Mht.proxyLogin} and {@link
428
+ * Mht.proxyPassword}. Use HTTPS whenever credentials or authenticated content are transmitted.
429
+ */
430
+ ntlmAuth: boolean
431
+
432
+ /**
433
+ * Specifies the number of directory levels used beneath each disk-cache root. The default is `0`,
434
+ * which stores cached items directly in the root. A value of `1` distributes items among 256
435
+ * subdirectories named `0` through `255`. A value of `2` uses two such levels, for example
436
+ * `17/204`. Chilkat creates the required subdirectories automatically.
437
+ *
438
+ * **Why use levels?** Directory fan-out prevents very large caches from placing thousands of
439
+ * files in one directory, which can degrade filesystem tools and directory operations.
440
+ */
441
+ numCacheLevels: number
442
+
443
+ /**
444
+ * Returns the number of disk-cache root directories currently configured through {@link
445
+ * Mht.addCacheRoot}. Multiple roots allow cached items to be distributed across different
446
+ * directories or storage volumes.
447
+ *
448
+ * **Indexing:** Cache-root indexes are zero-based. Use {@link Mht.getCacheRoot} to retrieve a
449
+ * configured root by index.
450
+ *
451
+ * This property is read-only.
452
+ */
453
+ readonly numCacheRoots: number
454
+
455
+ /**
456
+ * Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses.
457
+ * The default is `false`, which prefers IPv4. Set to `true` to prefer IPv6.
458
+ *
459
+ * **Preference, not a requirement:** This setting does not guarantee that IPv6 will be used. The
460
+ * selected address must still be reachable, and fallback behavior depends on the available
461
+ * addresses and connection results.
462
+ */
463
+ preferIpv6: boolean
464
+
465
+ /**
466
+ * Controls which content is retained when HTML contains a script together with a `<noscript>`
467
+ * alternative. When `true` (the default), the script is preferred and the `<noscript>` content is
468
+ * discarded. When `false`, the script is removed and the `<noscript>` content is retained.
469
+ *
470
+ * **Interaction with NoScripts:** {@link Mht.noScripts} takes precedence when script removal is
471
+ * required. EML generation always removes scripts.
472
+ *
473
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
474
+ * engine. It processes the original HTML source and statically referenced resources. Content
475
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
476
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
477
+ * when the saved archive is later opened; EML output removes scripts.
478
+ */
479
+ preferMHTScripts: boolean
480
+
481
+ /**
482
+ * Specifies an HTTP proxy as `hostname:port`, for example `proxy.example.com:8080`. Leave the
483
+ * property empty when no explicit HTTP proxy is required.
484
+ *
485
+ * **Formatting:** Supply only the proxy host and port; do not include an `http://` or `https://`
486
+ * scheme. If the proxy requires credentials, set {@link Mht.proxyLogin} and {@link
487
+ * Mht.proxyPassword}.
488
+ */
489
+ proxy: string
490
+
491
+ /**
492
+ * Specifies the username used to authenticate with the HTTP proxy configured by {@link
493
+ * Mht.proxy}. Leave empty when the proxy does not require authentication.
494
+ */
495
+ proxyLogin: string
496
+
497
+ /**
498
+ * Specifies the password used to authenticate with the HTTP proxy configured by {@link
499
+ * Mht.proxy}. Leave empty when the proxy does not require authentication.
500
+ *
501
+ * **Credential handling:** Treat proxy passwords as secrets and avoid writing them to diagnostic
502
+ * logs or persistent configuration in cleartext.
503
+ */
504
+ proxyPassword: string
505
+
506
+ /**
507
+ * Specifies the maximum number of seconds that an HTTP read may remain inactive while waiting for
508
+ * additional data. The default is `20` seconds. If data continues to arrive, a long download may
509
+ * run longer than this value.
510
+ *
511
+ * **Inactivity timeout:** This is not a total-operation timeout. It applies when the incoming
512
+ * data stream stops making progress.
513
+ */
514
+ readTimeout: number
515
+
516
+ /**
517
+ * Controls verification of the TLS server certificate for HTTPS connections. When `true`, the
518
+ * connection is rejected if certificate verification fails, such as because the certificate is
519
+ * expired or its chain or signature cannot be validated. The default is `false`.
520
+ *
521
+ * **Recommended for HTTPS:** Enable certificate verification for production connections to
522
+ * prevent accepting an untrusted or invalid server certificate. Disabling verification removes an
523
+ * important protection against impersonation and man-in-the-middle attacks.
524
+ */
525
+ requireSslCertVerify: boolean
526
+
527
+ /**
528
+ * Specifies the hostname or dotted-decimal IPv4 address of the SOCKS proxy. This property is used
529
+ * only when {@link Mht.socksVersion} is `4` or `5`.
530
+ */
531
+ socksHostname: string
532
+
533
+ /**
534
+ * Specifies the password for SOCKS5 proxy authentication. SOCKS4 does not define password
535
+ * authentication, so this property is ignored when {@link Mht.socksVersion} is `4`.
536
+ */
537
+ socksPassword: string
538
+
539
+ /**
540
+ * Specifies the TCP port of the SOCKS4 or SOCKS5 proxy. The default is `1080`. This property is
541
+ * used only when {@link Mht.socksVersion} is `4` or `5`.
542
+ */
543
+ socksPort: number
544
+
545
+ /**
546
+ * Specifies the username sent to the SOCKS4 or SOCKS5 proxy. It is used only when {@link
547
+ * Mht.socksVersion} is `4` or `5`. For SOCKS5, set {@link Mht.socksPassword} when password
548
+ * authentication is required.
549
+ */
550
+ socksUsername: string
551
+
552
+ /**
553
+ * Selects whether requests are routed through a SOCKS proxy.
554
+ *
555
+ * ValueBehavior
556
+ *
557
+ * | `0` | | Do not use a SOCKS proxy. This is the default. |
558
+ *
559
+ * | `4` | | Connect through a SOCKS4 proxy. |
560
+ *
561
+ * | `5` | | Connect through a SOCKS5 proxy. |
562
+ *
563
+ * **Required companion settings:** For versions `4` and `5`, set {@link Mht.socksHostname} and
564
+ * {@link Mht.socksPort}. Configure username and password properties when the proxy requires them.
565
+ */
566
+ socksVersion: number
567
+
568
+ /**
569
+ * Controls whether MHT parts are extracted directly according to their relative
570
+ * `Content-Location` values. The default is `false`.
571
+ *
572
+ * SettingBehavior
573
+ *
574
+ * | `false` | | Normal mode: Chilkat selects the primary HTML part, writes related resources
575
+ * beneath the parts subdirectory, rewrites HTML references, and applies path-containment and
576
+ * filename-collision handling. |
577
+ *
578
+ * | `true` | | Direct mode: relative `Content-Location` paths are written beneath the unpack
579
+ * directory without the normal HTML-reference rewriting. The `partsSubDir` method argument is
580
+ * ignored. |
581
+ *
582
+ * **Full URLs are not valid in direct mode:** If a part has a `Content-Location` beginning with
583
+ * `http://`, `https://`, or `file:/`, Chilkat logs the problem and does not write that part.
584
+ * Direct mode is intended for archives whose locations are already relative; use normal mode for
585
+ * web-captured MHT data.
586
+ */
587
+ unpackDirect: boolean
588
+
589
+ /**
590
+ * Controls how extracted resources are referenced from the rewritten HTML produced by the normal
591
+ * unpacking mode. The default is `true`, which uses relative paths. Set to `false` to write
592
+ * absolute local paths.
593
+ *
594
+ * **Portability:** Relative paths keep the unpacked HTML and its resource directory movable as a
595
+ * unit. Absolute paths bind the HTML to the extraction location on the current computer.
596
+ */
597
+ unpackUseRelPaths: boolean
598
+
599
+ /**
600
+ * Controls whether successful HTTP GET responses are written to the configured disk cache. The
601
+ * default is `false`. When `true`, add at least one cache root with {@link Mht.addCacheRoot}.
602
+ *
603
+ * **Reading and writing are separate:** {@link Mht.fetchFromCache} controls cache reads.
604
+ * Applications may enable either setting independently or enable both for normal read-through
605
+ * caching.
606
+ */
607
+ updateCache: boolean
608
+
609
+ /**
610
+ * Controls how embedded resources are identified and referenced in generated MHT and EML MIME
611
+ * documents. The default is `false`.
612
+ *
613
+ * SettingResource-part headersHTML reference
614
+ *
615
+ * | `false` | | A `Content-Location` containing the resolved URL or path; no `Content-ID`. | |
616
+ * The resource is referenced by its URL or location. |
617
+ *
618
+ * | `true` | | A generated, angle-bracketed `Content-ID`; no `Content-Location`. | | The resource
619
+ * URL is rewritten as `cid:<id>`. |
620
+ *
621
+ * **Mutually exclusive identification models:** A generated resource part uses either
622
+ * `Content-Location` or `Content-ID`, not both. `cid:` references are common in HTML email;
623
+ * location-based references preserve the resolved resource URL or path.
624
+ */
625
+ useCids: boolean
626
+
627
+ /**
628
+ * Controls whether the generated `Content-Disposition` for an embedded resource includes a
629
+ * `filename` parameter. The default is `true`. Setting this property to `true` forces an inline
630
+ * disposition to be emitted even when {@link Mht.useInline} is `false`.
631
+ *
632
+ * `UseInline``UseFilename`Generated `Content-Disposition`
633
+ *
634
+ * | `true` | | `true` | | `inline; filename="<name>"` |
635
+ *
636
+ * | `true` | | `false` | | `inline` |
637
+ *
638
+ * | `false` | | `true` | | `inline; filename="<name>"` |
639
+ *
640
+ * | `false` | | `false` | | No `Content-Disposition` header. |
641
+ *
642
+ * **Content-Type name parameter:** Every embedded resource always receives `name="<name>"` on its
643
+ * `Content-Type`, regardless of `UseFilename` and `UseInline`. The MIME filename is presentation
644
+ * metadata, not the source filesystem path.
645
+ */
646
+ useFilename: boolean
647
+
648
+ /**
649
+ * When `true`, Chilkat uses the proxy configuration associated with Windows Internet Options /
650
+ * Internet Explorer. This setting is relevant on Windows systems.
651
+ *
652
+ * **Explicit configuration:** Use {@link Mht.proxy} when the application should specify a
653
+ * particular proxy directly rather than relying on the current user's Windows proxy settings.
654
+ */
655
+ useIEProxy: boolean
656
+
657
+ /**
658
+ * Controls whether embedded resource parts receive an inline `Content-Disposition` when {@link
659
+ * Mht.useFilename} does not independently require the header. The default is `true`.
660
+ *
661
+ * `UseInline``UseFilename`Generated `Content-Disposition`
662
+ *
663
+ * | `true` | | `true` | | `inline; filename="<name>"` |
664
+ *
665
+ * | `true` | | `false` | | `inline` |
666
+ *
667
+ * | `false` | | `true` | | `inline; filename="<name>"` |
668
+ *
669
+ * | `false` | | `false` | | No `Content-Disposition` header. |
670
+ *
671
+ * **No attachment mode:** Whenever Chilkat emits this header, the disposition is `inline`; these
672
+ * properties do not produce `attachment`. Every embedded resource always receives a `name`
673
+ * parameter on its `Content-Type`, independent of both settings.
674
+ */
675
+ useInline: boolean
676
+
677
+ /**
678
+ * Specifies the username used when the origin website requires HTTP authentication. It is
679
+ * optional for public pages. For NTLM authentication, also set {@link Mht.ntlmAuth} to `true` and
680
+ * provide a domain when required.
681
+ */
682
+ webSiteLogin: string
683
+
684
+ /**
685
+ * Specifies the optional Windows domain used with NTLM website authentication. This property is
686
+ * relevant when {@link Mht.ntlmAuth} is `true`.
687
+ */
688
+ webSiteLoginDomain: string
689
+
690
+ /**
691
+ * Specifies the password used with {@link Mht.webSiteLogin} when the origin website requires HTTP
692
+ * authentication.
693
+ *
694
+ * **Credential handling:** Treat this value as a secret. Use HTTPS for authenticated pages and
695
+ * avoid exposing credentials through debug output or application logs.
696
+ */
697
+ webSitePassword: string
698
+
699
+ /**
700
+ * Set to `true` to request cancellation of the operation currently running on this object.
701
+ * Long-running network and file operations periodically check this property; a fast operation may
702
+ * complete before the request is observed.
703
+ *
704
+ * A synchronous method can be cancelled from another thread by setting this property on the same
705
+ * object. Chilkat resets the property to `false` after an abort is processed, and a stale request
706
+ * is cleared when a later method begins.
707
+ *
708
+ * **Cancellation request:** Cancellation is cooperative rather than instantaneous. Always inspect
709
+ * the method's return value and diagnostic properties to determine the final outcome.
710
+ */
711
+ abortCurrent: boolean
712
+
713
+ // ---- Methods ----
714
+
715
+ /**
716
+ * Adds `dir` as a persistent root directory for the disk cache. Call this method once for each
717
+ * cache location the application wants Chilkat to use. Multiple roots may be placed on different
718
+ * directories or storage volumes.
719
+ *
720
+ * **Enabling cache use:** Adding a root defines a storage location but does not by itself read or
721
+ * write cached content. Use {@link Mht.fetchFromCache} and {@link Mht.updateCache} to enable
722
+ * cache reads and writes.
723
+ *
724
+ * **Persistent collection:** Cache roots remain configured across conversions, duplicates are
725
+ * accepted, and no method removes an individual root. {@link Mht.restoreDefaults} does not clear
726
+ * them. Use a new `Mht` object when the cache-root list must be reset.
727
+ */
728
+ addCacheRoot(dir: string): void
729
+
730
+ /**
731
+ * Adds an HTTP request header to the persistent custom-header collection used for the main page,
732
+ * redirect targets, and every HTTP/HTTPS dependent-resource request, including requests to
733
+ * third-party hosts. `name` is the field name without a trailing colon, and `value` is the field
734
+ * value.
735
+ *
736
+ * Field nameBehavior when added again
737
+ *
738
+ * | `User-Agent` or `Accept-Language` | | Replaces the existing value. |
739
+ *
740
+ * | Any other permitted field | | Appends another header line with the same name; it does not
741
+ * replace the earlier line. |
742
+ *
743
+ * **Rejected fields:** `Authorization` and `Content-Length` are rejected case-insensitively and
744
+ * are not added. Use the website-login properties for supported HTTP authentication rather than
745
+ * attempting to add `Authorization` here.
746
+ *
747
+ * **Cross-host security:** Permitted fields such as `Cookie`, `Host`, and application-defined
748
+ * headers are reused for every destination contacted during the capture. Do not place a secret in
749
+ * a custom header unless it is safe to send to the primary host, every redirect target, and every
750
+ * third-party resource host.
751
+ *
752
+ * **Header syntax:** Raw CR or LF characters must not be placed in a header name or value.
753
+ * Header-splitting prevention should be treated as the caller's responsibility; this API does not
754
+ * document a validation guarantee.
755
+ *
756
+ * Custom headers persist until removed with {@link Mht.removeCustomHeader}, cleared with {@link
757
+ * Mht.clearCustomHeaders}, or the object is discarded. {@link Mht.restoreDefaults} does not clear
758
+ * them.
759
+ */
760
+ addCustomHeader(name: string, value: string): void
761
+
762
+ /**
763
+ * Adds the style-sheet URL in `url` to the persistent list of external CSS resources downloaded
764
+ * and embedded during conversion. This is normally unnecessary because Chilkat automatically
765
+ * discovers `<link rel="stylesheet">` references present in the static HTML.
766
+ *
767
+ * **When to use it:** Call this method when the application knows about a style sheet that is not
768
+ * referenced in the original HTML—for example, one that browser-side JavaScript would normally
769
+ * insert. Chilkat does not execute that JavaScript during capture.
770
+ *
771
+ * **Recursive CSS processing:** The downloaded style sheet is inlined and inspected for `@import`
772
+ * and `url(...)` references. Imported sheets are processed recursively, and relative references
773
+ * are resolved against the URL of the style sheet that contains them.
774
+ *
775
+ * **Persistent collection:** Entries remain configured across conversions. Duplicate URLs are
776
+ * accepted and are not deduplicated. There is no individual remove method; {@link
777
+ * Mht.restoreDefaults} clears the entire external-style-sheet list.
778
+ */
779
+ addExternalStyleSheet(url: string): void
780
+
781
+ /**
782
+ * Removes all HTTP request headers previously added with {@link Mht.addCustomHeader}.
783
+ * Automatically generated and built-in HTTP headers are not removed.
784
+ *
785
+ * The custom-header collection otherwise persists across conversions and is not cleared by {@link
786
+ * Mht.restoreDefaults}.
787
+ */
788
+ clearCustomHeaders(): void
789
+
790
+ /**
791
+ * Adds `pattern` to the persistent list of exclusion patterns used while gathering embeddable
792
+ * resources. Despite the historical method name, the test is applied to embeddable resources
793
+ * generally, not only to images. Each candidate is tested against its fully resolved reference:
794
+ * an absolute URL for web content or the resolved local path for a local resource.
795
+ *
796
+ * TestMatching rule
797
+ *
798
+ * | **Wildcard / glob** | | Case-insensitive match against the entire resolved reference. `*`
799
+ * matches zero or more characters, and `?` matches exactly one character. |
800
+ *
801
+ * | **Plain substring** | | Case-sensitive containment test anywhere within the resolved
802
+ * reference. |
803
+ *
804
+ * **Practical examples:** `*banner*` performs a case-insensitive contains-style match; `logo.png`
805
+ * performs a case-sensitive substring test; `*\/ads/*` can match a path; `*doubleclick*` can
806
+ * match a host; and `*.gif` can match an extension. The scheme, host, path, filename, query
807
+ * string, and fragment participate when present.
808
+ *
809
+ * **State and scope:** Patterns apply to local and HTTP/HTTPS resources. Multiple calls
810
+ * accumulate and are OR-ed; duplicates are accepted. There is no individual remove method. Call
811
+ * {@link Mht.restoreDefaults} to clear the exclusion list, or use a new `Mht` object.
812
+ */
813
+ excludeImagesMatching(pattern: string): void
814
+
815
+ /**
816
+ * Creates EML output from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath` and saves
817
+ * it to the destination path in `emlPath`. Style sheets and their CSS resources are captured.
818
+ * Images are embedded according to {@link Mht.embedImages} and {@link Mht.embedLocalOnly}.
819
+ * Scripts and framed documents are removed.
820
+ *
821
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
822
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
823
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
824
+ * Relative paths are resolved against the process current working directory, and the local file
825
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
826
+ * recognized scheme and is therefore treated as a local path.
827
+ *
828
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
829
+ * engine. It processes the original HTML source and statically referenced resources. Content
830
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
831
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
832
+ * when the saved archive is later opened; EML output removes scripts.
833
+ *
834
+ * **Return value:** Returns `true` on success and `false` on failure.
835
+ *
836
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
837
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
838
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
839
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
840
+ * conversion still reports success. This resilience applies only to dependent resources; failure
841
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
842
+ *
843
+ * **Destination file behavior:** Chilkat first generates the complete MIME output in memory and
844
+ * writes the destination only after generation succeeds. An existing destination file is
845
+ * truncated and replaced; data is never appended and no confirmation is requested. Parent
846
+ * directories are not created. Relative paths are resolved against the process current working
847
+ * directory. If generation fails, an existing destination file is left untouched. The final write
848
+ * is direct rather than atomic, so a write-time error such as a full disk or permission failure
849
+ * can leave a truncated or partially written file. A read-only or otherwise unwritable
850
+ * destination causes the method to return `false`. Using the same local file as both source and
851
+ * destination is mechanically allowed because the source is read first, but the subsequent write
852
+ * destroys the original HTML file. On Windows, this method also rejects destination paths
853
+ * containing characters that are invalid in Windows filenames, such as `?`, before generation
854
+ * begins.
855
+ *
856
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
857
+ * dependent resources. After the primary request redirects, relative page references are resolved
858
+ * against the final landing URL. Cookies received during the capture are retained and sent on
859
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
860
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
861
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
862
+ *
863
+ * **EML is an HTML-email draft:** The output adds the current RFC-822 `Date` and `X-Unsent: 1`,
864
+ * removes scripts, frames, and HTML comments, and contains an HTML root with related resources.
865
+ * It does not create a plain-text alternative, does not generate `Message-ID`, and does not
866
+ * automatically make a fully addressed, ready-to-send message. Load it into `Chilkat.Email` or a
867
+ * mail client and set the required addressing and subject information before sending.
868
+ *
869
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
870
+ * {@link Mht.getAndSaveEMLAsync}.
871
+ *
872
+ * @throws Error if the call fails (the message names the reason); the full log is in
873
+ * {@link Mht.lastErrorText}.
874
+ */
875
+ getAndSaveEML(urlOrHtmlFilepath: string, emlPath: string): void
876
+
877
+ /**
878
+ * Asynchronous form of {@link Mht.getAndSaveEML}: the same call on a native worker thread,
879
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
880
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
881
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
882
+ *
883
+ * The promise rejects with an Error if the call fails; the full log is in
884
+ * {@link Mht.lastErrorText}.
885
+ */
886
+ getAndSaveEMLAsync(urlOrHtmlFilepath: string, emlPath: string): Promise<void>
887
+
888
+ /**
889
+ * Creates MHT output from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath` and saves
890
+ * it to the destination path in `mhtPath`. Supported statically referenced resources are captured
891
+ * according to the current MHT properties.
892
+ *
893
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
894
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
895
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
896
+ * Relative paths are resolved against the process current working directory, and the local file
897
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
898
+ * recognized scheme and is therefore treated as a local path.
899
+ *
900
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
901
+ * engine. It processes the original HTML source and statically referenced resources. Content
902
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
903
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
904
+ * when the saved archive is later opened; EML output removes scripts.
905
+ *
906
+ * **Script output:** Script handling is controlled by {@link Mht.noScripts} and {@link
907
+ * Mht.preferMHTScripts}.
908
+ *
909
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
910
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
911
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
912
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
913
+ * conversion still reports success. This resilience applies only to dependent resources; failure
914
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
915
+ *
916
+ * **Destination file behavior:** Chilkat first generates the complete MIME output in memory and
917
+ * writes the destination only after generation succeeds. An existing destination file is
918
+ * truncated and replaced; data is never appended and no confirmation is requested. Parent
919
+ * directories are not created. Relative paths are resolved against the process current working
920
+ * directory. If generation fails, an existing destination file is left untouched. The final write
921
+ * is direct rather than atomic, so a write-time error such as a full disk or permission failure
922
+ * can leave a truncated or partially written file. A read-only or otherwise unwritable
923
+ * destination causes the method to return `false`. Using the same local file as both source and
924
+ * destination is mechanically allowed because the source is read first, but the subsequent write
925
+ * destroys the original HTML file. On Windows, this method also rejects destination paths
926
+ * containing characters that are invalid in Windows filenames, such as `?`, before generation
927
+ * begins.
928
+ *
929
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
930
+ * dependent resources. After the primary request redirects, relative page references are resolved
931
+ * against the final landing URL. Cookies received during the capture are retained and sent on
932
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
933
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
934
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
935
+ *
936
+ * **MHT MIME structure:** The result is a MIME document whose root is HTML (or XML) and whose
937
+ * successfully embedded resources are related parts. When resources are present, the message is
938
+ * normally `multipart/related`; when none are embedded, it can collapse to a single `text/html`
939
+ * part. MHT output omits the `Date` and `X-Unsent` headers and can preserve scripts, frames, and
940
+ * comments according to the script settings.
941
+ *
942
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
943
+ * {@link Mht.getAndSaveMHTAsync}.
944
+ *
945
+ * @throws Error if the call fails (the message names the reason); the full log is in
946
+ * {@link Mht.lastErrorText}.
947
+ */
948
+ getAndSaveMHT(urlOrHtmlFilepath: string, mhtPath: string): void
949
+
950
+ /**
951
+ * Asynchronous form of {@link Mht.getAndSaveMHT}: the same call on a native worker thread,
952
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
953
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
954
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
955
+ *
956
+ * The promise rejects with an Error if the call fails; the full log is in
957
+ * {@link Mht.lastErrorText}.
958
+ */
959
+ getAndSaveMHTAsync(urlOrHtmlFilepath: string, mhtPath: string): Promise<void>
960
+
961
+ /**
962
+ * Creates EML output from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath` and
963
+ * stores it as the ZIP entry named by `zipEntryFilename` inside the archive file in
964
+ * `zipFilename`. The ZIP is created if it does not exist; otherwise the new entry is appended.
965
+ * Style sheets are captured, images follow {@link Mht.embedImages} and {@link
966
+ * Mht.embedLocalOnly}, and scripts and frames are removed.
967
+ *
968
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
969
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
970
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
971
+ * Relative paths are resolved against the process current working directory, and the local file
972
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
973
+ * recognized scheme and is therefore treated as a local path.
974
+ *
975
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
976
+ * engine. It processes the original HTML source and statically referenced resources. Content
977
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
978
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
979
+ * when the saved archive is later opened; EML output removes scripts.
980
+ *
981
+ * **Argument order:** `urlOrHtmlFilepath` is the source, `zipEntryFilename` is the entry name
982
+ * inside the ZIP, and `zipFilename` is the ZIP file path.
983
+ *
984
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
985
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
986
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
987
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
988
+ * conversion still reports success. This resilience applies only to dependent resources; failure
989
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
990
+ *
991
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
992
+ * dependent resources. After the primary request redirects, relative page references are resolved
993
+ * against the final landing URL. Cookies received during the capture are retained and sent on
994
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
995
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
996
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
997
+ *
998
+ * **Entry-name collision:** If `zipEntryFilename` already exists in a valid opened ZIP archive,
999
+ * the method returns `false`. It neither replaces the existing entry nor creates a duplicate.
1000
+ *
1001
+ * **Archive handling:** A valid existing archive is loaded, the new entry is added, and the
1002
+ * entire archive is rewritten after capture succeeds. If the path does not exist, a new
1003
+ * unencrypted ZIP is created. If a file exists but cannot be opened as a valid ZIP, Chilkat
1004
+ * creates a new archive at that path, overwriting that file. Use forward slashes in
1005
+ * `zipEntryFilename` for entry subdirectories; explicit directory entries are unnecessary.
1006
+ *
1007
+ * **Failure and write safety:** A capture failure leaves a valid existing archive untouched. The
1008
+ * final archive write is not atomic and rewrites the complete ZIP, so a write-time I/O failure
1009
+ * can damage or partially replace the archive. Parent directories are not created. On Windows, an
1010
+ * output ZIP path containing invalid filename characters such as `?` is rejected.
1011
+ *
1012
+ * **EML is an HTML-email draft:** The output adds the current RFC-822 `Date` and `X-Unsent: 1`,
1013
+ * removes scripts, frames, and HTML comments, and contains an HTML root with related resources.
1014
+ * It does not create a plain-text alternative, does not generate `Message-ID`, and does not
1015
+ * automatically make a fully addressed, ready-to-send message. Load it into `Chilkat.Email` or a
1016
+ * mail client and set the required addressing and subject information before sending.
1017
+ *
1018
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1019
+ * {@link Mht.getAndZipEMLAsync}.
1020
+ *
1021
+ * @throws Error if the call fails (the message names the reason); the full log is in
1022
+ * {@link Mht.lastErrorText}.
1023
+ */
1024
+ getAndZipEML(urlOrHtmlFilepath: string, zipEntryFilename: string, zipFilename: string): void
1025
+
1026
+ /**
1027
+ * Asynchronous form of {@link Mht.getAndZipEML}: the same call on a native worker thread,
1028
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1029
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1030
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1031
+ *
1032
+ * The promise rejects with an Error if the call fails; the full log is in
1033
+ * {@link Mht.lastErrorText}.
1034
+ */
1035
+ getAndZipEMLAsync(urlOrHtmlFilepath: string, zipEntryFilename: string, zipFilename: string): Promise<void>
1036
+
1037
+ /**
1038
+ * Creates MHT output from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath` and
1039
+ * stores it as the ZIP entry named by `zipEntryFilename` inside the archive file in
1040
+ * `zipFilename`. The ZIP is created if it does not exist; otherwise the new entry is appended.
1041
+ * Supported statically referenced resources are captured according to the current properties.
1042
+ *
1043
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
1044
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
1045
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
1046
+ * Relative paths are resolved against the process current working directory, and the local file
1047
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
1048
+ * recognized scheme and is therefore treated as a local path.
1049
+ *
1050
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1051
+ * engine. It processes the original HTML source and statically referenced resources. Content
1052
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1053
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1054
+ * when the saved archive is later opened; EML output removes scripts.
1055
+ *
1056
+ * **Argument order:** `urlOrHtmlFilepath` is the source, `zipEntryFilename` is the entry name
1057
+ * inside the ZIP, and `zipFilename` is the ZIP file path.
1058
+ *
1059
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1060
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1061
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1062
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1063
+ * conversion still reports success. This resilience applies only to dependent resources; failure
1064
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
1065
+ *
1066
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
1067
+ * dependent resources. After the primary request redirects, relative page references are resolved
1068
+ * against the final landing URL. Cookies received during the capture are retained and sent on
1069
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
1070
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
1071
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
1072
+ *
1073
+ * **Entry-name collision:** If `zipEntryFilename` already exists in a valid opened ZIP archive,
1074
+ * the method returns `false`. It neither replaces the existing entry nor creates a duplicate.
1075
+ *
1076
+ * **Archive handling:** A valid existing archive is loaded, the new entry is added, and the
1077
+ * entire archive is rewritten after capture succeeds. If the path does not exist, a new
1078
+ * unencrypted ZIP is created. If a file exists but cannot be opened as a valid ZIP, Chilkat
1079
+ * creates a new archive at that path, overwriting that file. Use forward slashes in
1080
+ * `zipEntryFilename` for entry subdirectories; explicit directory entries are unnecessary.
1081
+ *
1082
+ * **Failure and write safety:** A capture failure leaves a valid existing archive untouched. The
1083
+ * final archive write is not atomic and rewrites the complete ZIP, so a write-time I/O failure
1084
+ * can damage or partially replace the archive. Parent directories are not created. On Windows, an
1085
+ * output ZIP path containing invalid filename characters such as `?` is rejected.
1086
+ *
1087
+ * **MHT MIME structure:** The result is a MIME document whose root is HTML (or XML) and whose
1088
+ * successfully embedded resources are related parts. When resources are present, the message is
1089
+ * normally `multipart/related`; when none are embedded, it can collapse to a single `text/html`
1090
+ * part. MHT output omits the `Date` and `X-Unsent` headers and can preserve scripts, frames, and
1091
+ * comments according to the script settings.
1092
+ *
1093
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1094
+ * {@link Mht.getAndZipMHTAsync}.
1095
+ *
1096
+ * @throws Error if the call fails (the message names the reason); the full log is in
1097
+ * {@link Mht.lastErrorText}.
1098
+ */
1099
+ getAndZipMHT(urlOrHtmlFilepath: string, zipEntryFilename: string, zipFilename: string): void
1100
+
1101
+ /**
1102
+ * Asynchronous form of {@link Mht.getAndZipMHT}: the same call on a native worker thread,
1103
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1104
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1105
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1106
+ *
1107
+ * The promise rejects with an Error if the call fails; the full log is in
1108
+ * {@link Mht.lastErrorText}.
1109
+ */
1110
+ getAndZipMHTAsync(urlOrHtmlFilepath: string, zipEntryFilename: string, zipFilename: string): Promise<void>
1111
+
1112
+ /**
1113
+ * Returns the cache-root directory at zero-based index `index`. Cache roots are added with {@link
1114
+ * Mht.addCacheRoot}, and their count is available from {@link Mht.numCacheRoots}.
1115
+ *
1116
+ * **Index and result handling:** Use an index from `0` through `NumCacheRoots - 1`. The returned
1117
+ * string is cleared when the call begins. If no cache root is configured or `index` is outside
1118
+ * the valid range, `LastMethodSuccess` is `false` and the returned string is empty. On success,
1119
+ * `LastMethodSuccess` is `true` and the returned string contains the root path. Check
1120
+ * `LastMethodSuccess`, not whether the returned string is empty; use `LastErrorText` for the
1121
+ * failure diagnostic.
1122
+ *
1123
+ * @throws Error if the call fails (the message names the reason); the full log is in
1124
+ * {@link Mht.lastErrorText}.
1125
+ */
1126
+ getCacheRoot(index: number): string
1127
+
1128
+ /**
1129
+ * Creates an EML MIME message from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath`
1130
+ * and returns the complete EML text in memory. Style sheets and their referenced CSS resources
1131
+ * are captured. Images are embedded according to {@link Mht.embedImages} and {@link
1132
+ * Mht.embedLocalOnly}. Scripts and framed documents are removed.
1133
+ *
1134
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
1135
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
1136
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
1137
+ * Relative paths are resolved against the process current working directory, and the local file
1138
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
1139
+ * recognized scheme and is therefore treated as a local path.
1140
+ *
1141
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1142
+ * engine. It processes the original HTML source and statically referenced resources. Content
1143
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1144
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1145
+ * when the saved archive is later opened; EML output removes scripts.
1146
+ *
1147
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
1148
+ * dependent resources. After the primary request redirects, relative page references are resolved
1149
+ * against the final landing URL. Cookies received during the capture are retained and sent on
1150
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
1151
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
1152
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
1153
+ *
1154
+ * **Memory use:** The complete MIME message is returned as a string. For large pages, {@link
1155
+ * Mht.getAndSaveEML} avoids keeping the final EML text solely in the return value.
1156
+ *
1157
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1158
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1159
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1160
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1161
+ * conversion still reports success. This resilience applies only to dependent resources; failure
1162
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
1163
+ *
1164
+ * **Check `LastMethodSuccess`:** The returned string is cleared when the call begins and may be
1165
+ * empty or partially populated if the method fails. A nonempty string does not prove success, and
1166
+ * an empty string should not be used as the failure test. Use `LastMethodSuccess` as the
1167
+ * authoritative result; when it is `false`, inspect `LastErrorText`. A failed call never returns
1168
+ * the previous call's string.
1169
+ *
1170
+ * **Saving the returned string:** The returned MIME document uses CRLF line endings and UTF-8
1171
+ * text without a byte-order mark. Preserve the text as opaque UTF-8 bytes without newline
1172
+ * translation or reflow. Raw non-ASCII text can occur. Prefer the corresponding file-writing
1173
+ * method when exact on-disk bytes are required.
1174
+ *
1175
+ * **EML is an HTML-email draft:** The output adds the current RFC-822 `Date` and `X-Unsent: 1`,
1176
+ * removes scripts, frames, and HTML comments, and contains an HTML root with related resources.
1177
+ * It does not create a plain-text alternative, does not generate `Message-ID`, and does not
1178
+ * automatically make a fully addressed, ready-to-send message. Load it into `Chilkat.Email` or a
1179
+ * mail client and set the required addressing and subject information before sending.
1180
+ *
1181
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1182
+ * {@link Mht.getEMLAsync}.
1183
+ *
1184
+ * @throws Error if the call fails (the message names the reason); the full log is in
1185
+ * {@link Mht.lastErrorText}.
1186
+ */
1187
+ getEML(urlOrHtmlFilepath: string): string
1188
+
1189
+ /**
1190
+ * Asynchronous form of {@link Mht.getEML}: the same call on a native worker thread,
1191
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1192
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1193
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1194
+ *
1195
+ * The promise rejects with an Error if the call fails; the full log is in
1196
+ * {@link Mht.lastErrorText}.
1197
+ */
1198
+ getEMLAsync(urlOrHtmlFilepath: string): Promise<string>
1199
+
1200
+ /**
1201
+ * Creates an MHT web archive from the HTTP/HTTPS page or local HTML file in `urlOrHtmlFilepath`
1202
+ * and returns the complete MHT MIME text in memory. Supported statically referenced resources are
1203
+ * captured according to the current properties.
1204
+ *
1205
+ * **How `urlOrHtmlFilepath` is classified:** Chilkat treats `urlOrHtmlFilepath` as a web URL only
1206
+ * when it begins, case-insensitively, with `http:` or `https:`. Every other value is treated as a
1207
+ * local file path. `file://` URLs are not supported; pass a plain filesystem path instead.
1208
+ * Relative paths are resolved against the process current working directory, and the local file
1209
+ * must already exist and be readable. A value such as `www.example.com/page.html` has no
1210
+ * recognized scheme and is therefore treated as a local path.
1211
+ *
1212
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1213
+ * engine. It processes the original HTML source and statically referenced resources. Content
1214
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1215
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1216
+ * when the saved archive is later opened; EML output removes scripts.
1217
+ *
1218
+ * **Redirects and capture cookies:** HTTP redirects are followed for the primary page and
1219
+ * dependent resources. After the primary request redirects, relative page references are resolved
1220
+ * against the final landing URL. Cookies received during the capture are retained and sent on
1221
+ * subsequent requests in that same capture, including redirect and dependent-resource requests.
1222
+ * The redirect limit, exact followed status codes, and HTTPS-to-HTTP downgrade policy are
1223
+ * governed by the underlying HTTP engine and are not configurable through `Mht`.
1224
+ *
1225
+ * **Memory use:** The complete archive is returned as a string. For large pages, {@link
1226
+ * Mht.getAndSaveMHT} writes the result directly to a file.
1227
+ *
1228
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1229
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1230
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1231
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1232
+ * conversion still reports success. This resilience applies only to dependent resources; failure
1233
+ * to fetch the primary URL or read the primary local HTML file fails the operation.
1234
+ *
1235
+ * **Check `LastMethodSuccess`:** The returned string is cleared when the call begins and may be
1236
+ * empty or partially populated if the method fails. A nonempty string does not prove success, and
1237
+ * an empty string should not be used as the failure test. Use `LastMethodSuccess` as the
1238
+ * authoritative result; when it is `false`, inspect `LastErrorText`. A failed call never returns
1239
+ * the previous call's string.
1240
+ *
1241
+ * **Saving the returned string:** The returned MIME document uses CRLF line endings and UTF-8
1242
+ * text without a byte-order mark. Preserve the text as opaque UTF-8 bytes without newline
1243
+ * translation or reflow. Raw non-ASCII text can occur. Prefer the corresponding file-writing
1244
+ * method when exact on-disk bytes are required.
1245
+ *
1246
+ * **MHT MIME structure:** The result is a MIME document whose root is HTML (or XML) and whose
1247
+ * successfully embedded resources are related parts. When resources are present, the message is
1248
+ * normally `multipart/related`; when none are embedded, it can collapse to a single `text/html`
1249
+ * part. MHT output omits the `Date` and `X-Unsent` headers and can preserve scripts, frames, and
1250
+ * comments according to the script settings.
1251
+ *
1252
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1253
+ * {@link Mht.getMHTAsync}.
1254
+ *
1255
+ * @throws Error if the call fails (the message names the reason); the full log is in
1256
+ * {@link Mht.lastErrorText}.
1257
+ */
1258
+ getMHT(urlOrHtmlFilepath: string): string
1259
+
1260
+ /**
1261
+ * Asynchronous form of {@link Mht.getMHT}: the same call on a native worker thread,
1262
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1263
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1264
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1265
+ *
1266
+ * The promise rejects with an Error if the call fails; the full log is in
1267
+ * {@link Mht.lastErrorText}.
1268
+ */
1269
+ getMHTAsync(urlOrHtmlFilepath: string): Promise<string>
1270
+
1271
+ /**
1272
+ * Creates an EML MIME message from the in-memory HTML string in `htmlText` and returns the
1273
+ * complete EML text. Style sheets and their CSS resources are captured. Images are embedded
1274
+ * according to {@link Mht.embedImages} and {@link Mht.embedLocalOnly}. Scripts and framed
1275
+ * documents are removed.
1276
+ *
1277
+ * **Relative references:** Set {@link Mht.baseUrl} when the HTML has no usable `<base href>` and
1278
+ * its relative resources should resolve against a web origin. An HTML `<base>` element takes
1279
+ * precedence. Without a usable base, unresolved relative resources are not captured and their
1280
+ * references remain relative.
1281
+ *
1282
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1283
+ * engine. It processes the original HTML source and statically referenced resources. Content
1284
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1285
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1286
+ * when the saved archive is later opened; EML output removes scripts.
1287
+ *
1288
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1289
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1290
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1291
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1292
+ * conversion still reports success, although the resulting MIME document is not fully
1293
+ * self-contained for that resource.
1294
+ *
1295
+ * **Check `LastMethodSuccess`:** The returned string is cleared when the call begins and may be
1296
+ * empty or partially populated if the method fails. A nonempty string does not prove success, and
1297
+ * an empty string should not be used as the failure test. Use `LastMethodSuccess` as the
1298
+ * authoritative result; when it is `false`, inspect `LastErrorText`. A failed call never returns
1299
+ * the previous call's string.
1300
+ *
1301
+ * **Redirecting dependent resources:** HTTP redirects encountered while downloading images, style
1302
+ * sheets, imported CSS, frames, or other supported resources are followed to the final content.
1303
+ * Cookies established during the conversion are retained for later requests in the same
1304
+ * conversion.
1305
+ *
1306
+ * **Saving the returned string:** The returned MIME document uses CRLF line endings and UTF-8
1307
+ * text without a byte-order mark. Preserve the text as opaque UTF-8 bytes without newline
1308
+ * translation or reflow. Raw non-ASCII text can occur. Prefer the corresponding file-writing
1309
+ * method when exact on-disk bytes are required.
1310
+ *
1311
+ * **EML is an HTML-email draft:** The output adds the current RFC-822 `Date` and `X-Unsent: 1`,
1312
+ * removes scripts, frames, and HTML comments, and contains an HTML root with related resources.
1313
+ * It does not create a plain-text alternative, does not generate `Message-ID`, and does not
1314
+ * automatically make a fully addressed, ready-to-send message. Load it into `Chilkat.Email` or a
1315
+ * mail client and set the required addressing and subject information before sending.
1316
+ *
1317
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1318
+ * {@link Mht.htmlToEMLAsync}.
1319
+ *
1320
+ * @throws Error if the call fails (the message names the reason); the full log is in
1321
+ * {@link Mht.lastErrorText}.
1322
+ */
1323
+ htmlToEML(htmlText: string): string
1324
+
1325
+ /**
1326
+ * Asynchronous form of {@link Mht.htmlToEML}: the same call on a native worker thread,
1327
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1328
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1329
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1330
+ *
1331
+ * The promise rejects with an Error if the call fails; the full log is in
1332
+ * {@link Mht.lastErrorText}.
1333
+ */
1334
+ htmlToEMLAsync(htmlText: string): Promise<string>
1335
+
1336
+ /**
1337
+ * Creates EML output from the in-memory HTML string in `html` and saves it to the file path in
1338
+ * `emlFilename`. Style sheets and their CSS resources are captured. Images are embedded according
1339
+ * to {@link Mht.embedImages} and {@link Mht.embedLocalOnly}. Scripts and framed documents are
1340
+ * removed.
1341
+ *
1342
+ * **Relative references:** Set {@link Mht.baseUrl} when the HTML has no usable `<base href>` and
1343
+ * its relative resources should resolve against a web origin. An HTML `<base>` element takes
1344
+ * precedence. Without a usable base, unresolved relative resources are not captured and their
1345
+ * references remain relative.
1346
+ *
1347
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1348
+ * engine. It processes the original HTML source and statically referenced resources. Content
1349
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1350
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1351
+ * when the saved archive is later opened; EML output removes scripts.
1352
+ *
1353
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1354
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1355
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1356
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1357
+ * conversion still reports success, although the resulting MIME document is not fully
1358
+ * self-contained for that resource.
1359
+ *
1360
+ * **Destination file behavior:** Chilkat first generates the complete MIME output in memory and
1361
+ * writes the destination only after generation succeeds. An existing destination file is
1362
+ * truncated and replaced; data is never appended and no confirmation is requested. Parent
1363
+ * directories are not created. Relative paths are resolved against the process current working
1364
+ * directory. If generation fails, an existing destination file is left untouched. The final write
1365
+ * is direct rather than atomic, so a write-time error such as a full disk or permission failure
1366
+ * can leave a truncated or partially written file. A read-only or otherwise unwritable
1367
+ * destination causes the method to return `false`.
1368
+ *
1369
+ * **Redirecting dependent resources:** HTTP redirects encountered while downloading supported
1370
+ * dependent resources are followed. Cookies established during the conversion are reused for
1371
+ * later requests in that same conversion.
1372
+ *
1373
+ * **EML is an HTML-email draft:** The output adds the current RFC-822 `Date` and `X-Unsent: 1`,
1374
+ * removes scripts, frames, and HTML comments, and contains an HTML root with related resources.
1375
+ * It does not create a plain-text alternative, does not generate `Message-ID`, and does not
1376
+ * automatically make a fully addressed, ready-to-send message. Load it into `Chilkat.Email` or a
1377
+ * mail client and set the required addressing and subject information before sending.
1378
+ *
1379
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1380
+ * {@link Mht.htmlToEMLFileAsync}.
1381
+ *
1382
+ * @throws Error if the call fails (the message names the reason); the full log is in
1383
+ * {@link Mht.lastErrorText}.
1384
+ */
1385
+ htmlToEMLFile(html: string, emlFilename: string): void
1386
+
1387
+ /**
1388
+ * Asynchronous form of {@link Mht.htmlToEMLFile}: the same call on a native worker thread,
1389
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1390
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1391
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1392
+ *
1393
+ * The promise rejects with an Error if the call fails; the full log is in
1394
+ * {@link Mht.lastErrorText}.
1395
+ */
1396
+ htmlToEMLFileAsync(html: string, emlFilename: string): Promise<void>
1397
+
1398
+ /**
1399
+ * Creates an MHT web archive from the in-memory HTML string in `htmlText` and returns the
1400
+ * complete MHT MIME text. Supported statically referenced resources are captured according to the
1401
+ * current properties.
1402
+ *
1403
+ * **Relative references:** Set {@link Mht.baseUrl} when the HTML has no usable `<base href>` and
1404
+ * its relative resources should resolve against a web origin. An HTML `<base>` element takes
1405
+ * precedence. Without a usable base, unresolved relative resources are not captured and their
1406
+ * references remain relative.
1407
+ *
1408
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1409
+ * engine. It processes the original HTML source and statically referenced resources. Content
1410
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1411
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1412
+ * when the saved archive is later opened; EML output removes scripts.
1413
+ *
1414
+ * **Scripts:** Script handling is controlled by {@link Mht.noScripts} and {@link
1415
+ * Mht.preferMHTScripts}.
1416
+ *
1417
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1418
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1419
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1420
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1421
+ * conversion still reports success, although the resulting MIME document is not fully
1422
+ * self-contained for that resource.
1423
+ *
1424
+ * **Check `LastMethodSuccess`:** The returned string is cleared when the call begins and may be
1425
+ * empty or partially populated if the method fails. A nonempty string does not prove success, and
1426
+ * an empty string should not be used as the failure test. Use `LastMethodSuccess` as the
1427
+ * authoritative result; when it is `false`, inspect `LastErrorText`. A failed call never returns
1428
+ * the previous call's string.
1429
+ *
1430
+ * **Redirecting dependent resources:** HTTP redirects encountered while downloading images, style
1431
+ * sheets, imported CSS, frames, or other supported resources are followed to the final content.
1432
+ * Cookies established during the conversion are retained for later requests in the same
1433
+ * conversion.
1434
+ *
1435
+ * **Saving the returned string:** The returned MIME document uses CRLF line endings and UTF-8
1436
+ * text without a byte-order mark. Preserve the text as opaque UTF-8 bytes without newline
1437
+ * translation or reflow. Raw non-ASCII text can occur. Prefer the corresponding file-writing
1438
+ * method when exact on-disk bytes are required.
1439
+ *
1440
+ * **MHT MIME structure:** The result is a MIME document whose root is HTML (or XML) and whose
1441
+ * successfully embedded resources are related parts. When resources are present, the message is
1442
+ * normally `multipart/related`; when none are embedded, it can collapse to a single `text/html`
1443
+ * part. MHT output omits the `Date` and `X-Unsent` headers and can preserve scripts, frames, and
1444
+ * comments according to the script settings.
1445
+ *
1446
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1447
+ * {@link Mht.htmlToMHTAsync}.
1448
+ *
1449
+ * @throws Error if the call fails (the message names the reason); the full log is in
1450
+ * {@link Mht.lastErrorText}.
1451
+ */
1452
+ htmlToMHT(htmlText: string): string
1453
+
1454
+ /**
1455
+ * Asynchronous form of {@link Mht.htmlToMHT}: the same call on a native worker thread,
1456
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1457
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1458
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1459
+ *
1460
+ * The promise rejects with an Error if the call fails; the full log is in
1461
+ * {@link Mht.lastErrorText}.
1462
+ */
1463
+ htmlToMHTAsync(htmlText: string): Promise<string>
1464
+
1465
+ /**
1466
+ * Creates MHT output from the in-memory HTML string in `html` and saves it to the file path in
1467
+ * `mhtFilename`. Supported statically referenced resources are captured according to the current
1468
+ * properties.
1469
+ *
1470
+ * **Relative references:** Set {@link Mht.baseUrl} when the HTML has no usable `<base href>` and
1471
+ * its relative resources should resolve against a web origin. An HTML `<base>` element takes
1472
+ * precedence. Without a usable base, unresolved relative resources are not captured and their
1473
+ * references remain relative.
1474
+ *
1475
+ * **Static HTML capture:** Chilkat does not execute JavaScript or behave as a browser rendering
1476
+ * engine. It processes the original HTML source and statically referenced resources. Content
1477
+ * created only after JavaScript runs—including AJAX, `fetch`, XHR, lazy-loaded content, or
1478
+ * framework-rendered DOM content—is not captured. MHT output can preserve scripts for execution
1479
+ * when the saved archive is later opened; EML output removes scripts.
1480
+ *
1481
+ * **Scripts:** Script handling is controlled by {@link Mht.noScripts} and {@link
1482
+ * Mht.preferMHTScripts}.
1483
+ *
1484
+ * **Dependent-resource failures:** If an image, style sheet, imported CSS file, frame, script, or
1485
+ * other dependent resource cannot be downloaded or included, Chilkat omits that MIME part,
1486
+ * creates no empty placeholder, restores the HTML reference to the resource's original absolute
1487
+ * URL, records the problem in `LastErrorText` or the diagnostic log, and continues. The overall
1488
+ * conversion still reports success, although the resulting MIME document is not fully
1489
+ * self-contained for that resource.
1490
+ *
1491
+ * **Destination file behavior:** Chilkat first generates the complete MIME output in memory and
1492
+ * writes the destination only after generation succeeds. An existing destination file is
1493
+ * truncated and replaced; data is never appended and no confirmation is requested. Parent
1494
+ * directories are not created. Relative paths are resolved against the process current working
1495
+ * directory. If generation fails, an existing destination file is left untouched. The final write
1496
+ * is direct rather than atomic, so a write-time error such as a full disk or permission failure
1497
+ * can leave a truncated or partially written file. A read-only or otherwise unwritable
1498
+ * destination causes the method to return `false`.
1499
+ *
1500
+ * **Redirecting dependent resources:** HTTP redirects encountered while downloading supported
1501
+ * dependent resources are followed. Cookies established during the conversion are reused for
1502
+ * later requests in that same conversion.
1503
+ *
1504
+ * **MHT MIME structure:** The result is a MIME document whose root is HTML (or XML) and whose
1505
+ * successfully embedded resources are related parts. When resources are present, the message is
1506
+ * normally `multipart/related`; when none are embedded, it can collapse to a single `text/html`
1507
+ * part. MHT output omits the `Date` and `X-Unsent` headers and can preserve scripts, frames, and
1508
+ * comments according to the script settings.
1509
+ *
1510
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1511
+ * {@link Mht.htmlToMHTFileAsync}.
1512
+ *
1513
+ * @throws Error if the call fails (the message names the reason); the full log is in
1514
+ * {@link Mht.lastErrorText}.
1515
+ */
1516
+ htmlToMHTFile(html: string, mhtFilename: string): void
1517
+
1518
+ /**
1519
+ * Asynchronous form of {@link Mht.htmlToMHTFile}: the same call on a native worker thread,
1520
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1521
+ * except {@link Mht.abort} (which cancels it) and the {@link Mht.onPercentDone} /
1522
+ * {@link Mht.onProgressInfo} callbacks, which report progress while it runs.
1523
+ *
1524
+ * The promise rejects with an Error if the call fails; the full log is in
1525
+ * {@link Mht.lastErrorText}.
1526
+ */
1527
+ htmlToMHTFileAsync(html: string, mhtFilename: string): Promise<void>
1528
+
1529
+ /**
1530
+ * Removes custom HTTP request headers having the field name in `name`. Supply the name without a
1531
+ * trailing colon. Header names are matched case-insensitively.
1532
+ *
1533
+ * **No matching field:** Calling this method for a name that is not present is a harmless no-op
1534
+ * and does not report an error.
1535
+ *
1536
+ * Use {@link Mht.clearCustomHeaders} to remove every custom header at once.
1537
+ */
1538
+ removeCustomHeader(name: string): void
1539
+
1540
+ /**
1541
+ * Restores a limited set of MHT/EML conversion settings to their defaults and clears two
1542
+ * method-added collections.
1543
+ *
1544
+ * Reset by this methodResult
1545
+ *
1546
+ * | `PreferMHTScripts` | | Restored to `true`. |
1547
+ *
1548
+ * | `EmbedImages` | | Restored to `true`. |
1549
+ *
1550
+ * | `EmbedLocalOnly` | | Restored to `false`. |
1551
+ *
1552
+ * | `NoScripts` and related internal script-removal state | | Restored to the normal
1553
+ * script-enabled MHT behavior. |
1554
+ *
1555
+ * | External style sheets added by `AddExternalStyleSheet` | | The entire list is cleared. |
1556
+ *
1557
+ * | Exclusion patterns added by `ExcludeImagesMatching` | | The entire list is cleared. |
1558
+ *
1559
+ * **Not reset:** This method does not clear custom headers, cache roots, `BaseUrl`, `UseCids`,
1560
+ * `UseInline`, `UseFilename`, credentials, proxy settings, or other HTTP-related properties.
1561
+ * Remove custom headers with {@link Mht.removeCustomHeader} or {@link Mht.clearCustomHeaders}.
1562
+ * Cache roots can be cleared only by using a new `Mht` object.
1563
+ */
1564
+ restoreDefaults(): void
1565
+
1566
+ /**
1567
+ * Extracts MHT data from `mhtFilename`. `mhtFilename` may be either a local MHT file path or the
1568
+ * literal MHT MIME text; Chilkat distinguishes the two by detecting MIME headers in the supplied
1569
+ * value. `unpackDir` specifies the unpack directory, `htmlFilename` specifies the main HTML
1570
+ * filename, and `partsSubDir` specifies the related-parts subdirectory used in normal unpacking.
1571
+ *
1572
+ * **Defaults and file creation:** If `unpackDir` is empty, the unpack directory defaults to `.`
1573
+ * (the process current working directory). If `partsSubDir` is empty, the related-parts
1574
+ * subdirectory defaults to `html_parts`. Chilkat creates the parts subdirectory beneath the
1575
+ * unpack directory when needed. The main HTML file and extracted parts overwrite existing files
1576
+ * having the same names. An empty MHT input or an empty `htmlFilename` HTML filename is an error
1577
+ * and causes the method to return `false`.
1578
+ *
1579
+ * **Unpack options:** Set {@link Mht.unpackDirect} to preserve relative `Content-Location` paths
1580
+ * without rewriting HTML; in that mode `partsSubDir` is ignored. {@link Mht.unpackUseRelPaths}
1581
+ * controls relative versus absolute references in normal mode.
1582
+ *
1583
+ * **Write behavior:** Extraction writes directly to the target files rather than using an atomic
1584
+ * temporary-file replacement. A write-time I/O failure can therefore leave partially written
1585
+ * output.
1586
+ *
1587
+ * **Untrusted archives:** Extract untrusted MHT input into an isolated directory and inspect the
1588
+ * resulting files before opening or publishing them.
1589
+ *
1590
+ * **Required MIME structure:** Normal unpacking requires a `multipart/related` message containing
1591
+ * a primary HTML body. If either is missing, the method returns `false`. When several HTML-like
1592
+ * parts exist, the primary HTML part is selected and the others are treated as related resources.
1593
+ *
1594
+ * **Path containment in normal mode:** Before writing a related part, Chilkat removes `..` path
1595
+ * segments, drops leading slashes, strips Windows drive prefixes, normalizes UNC-style paths to
1596
+ * relative paths, and keeps the result beneath the unpack directory. Degenerate names such as `.`
1597
+ * and `..` become `_`; on Windows, `*` and `?` are replaced with `_`. This is targeted
1598
+ * sanitization, not a guarantee that every platform-specific illegal name is transformed.
1599
+ *
1600
+ * **Name collisions:** Parts that would receive the same filename during one unpack operation are
1601
+ * made unique with numeric suffixes such as `name_1.ext`. Existing files left by an earlier run
1602
+ * are overwritten.
1603
+ *
1604
+ * **Direct mode:** When {@link Mht.unpackDirect} is `true`, the method is intended for MHT data
1605
+ * whose `Content-Location` values are already relative paths. A part whose location begins with
1606
+ * `http://`, `https://`, or `file:/` is logged and not written. Use normal mode for web-captured
1607
+ * MHT data.
1608
+ *
1609
+ * @throws Error if the call fails (the message names the reason); the full log is in
1610
+ * {@link Mht.lastErrorText}.
1611
+ */
1612
+ unpackMHT(mhtFilename: string, unpackDir: string, htmlFilename: string, partsSubDir: string): void
1613
+
1614
+ /**
1615
+ * Extracts MHT data from `mhtString`. Despite the historical method name, `mhtString` may be
1616
+ * either literal MHT MIME text or a local MHT file path; Chilkat distinguishes the two by
1617
+ * detecting MIME headers in the supplied value. `unpackDir` specifies the unpack directory,
1618
+ * `htmlFilename` specifies the main HTML filename, and `partsSubDir` specifies the related-parts
1619
+ * subdirectory used in normal unpacking.
1620
+ *
1621
+ * **Defaults and file creation:** If `unpackDir` is empty, the unpack directory defaults to `.`
1622
+ * (the process current working directory). If `partsSubDir` is empty, the related-parts
1623
+ * subdirectory defaults to `html_parts`. Chilkat creates the parts subdirectory beneath the
1624
+ * unpack directory when needed. Existing files having the same names are overwritten. An empty
1625
+ * MHT input or an empty `htmlFilename` HTML filename is an error and causes the method to return
1626
+ * `false`.
1627
+ *
1628
+ * **Direct mode:** When {@link Mht.unpackDirect} is `true`, `partsSubDir` is ignored and relative
1629
+ * `Content-Location` paths are used directly beneath the unpack directory. Otherwise, {@link
1630
+ * Mht.unpackUseRelPaths} controls relative versus absolute references in the rewritten HTML.
1631
+ *
1632
+ * **Write behavior:** Extraction writes directly to the target files rather than using an atomic
1633
+ * temporary-file replacement. A write-time I/O failure can therefore leave partially written
1634
+ * output.
1635
+ *
1636
+ * **Required MIME structure:** Normal unpacking requires a `multipart/related` message containing
1637
+ * a primary HTML body. If either is missing, the method returns `false`. When several HTML-like
1638
+ * parts exist, the primary HTML part is selected and the others are treated as related resources.
1639
+ *
1640
+ * **Path containment in normal mode:** Before writing a related part, Chilkat removes `..` path
1641
+ * segments, drops leading slashes, strips Windows drive prefixes, normalizes UNC-style paths to
1642
+ * relative paths, and keeps the result beneath the unpack directory. Degenerate names such as `.`
1643
+ * and `..` become `_`; on Windows, `*` and `?` are replaced with `_`. This is targeted
1644
+ * sanitization, not a guarantee that every platform-specific illegal name is transformed.
1645
+ *
1646
+ * **Name collisions:** Parts that would receive the same filename during one unpack operation are
1647
+ * made unique with numeric suffixes such as `name_1.ext`. Existing files left by an earlier run
1648
+ * are overwritten.
1649
+ *
1650
+ * **Direct mode:** When {@link Mht.unpackDirect} is `true`, the method is intended for MHT data
1651
+ * whose `Content-Location` values are already relative paths. A part whose location begins with
1652
+ * `http://`, `https://`, or `file:/` is logged and not written. Use normal mode for web-captured
1653
+ * MHT data.
1654
+ *
1655
+ * @throws Error if the call fails (the message names the reason); the full log is in
1656
+ * {@link Mht.lastErrorText}.
1657
+ */
1658
+ unpackMHTString(mhtString: string, unpackDir: string, htmlFilename: string, partsSubDir: string): void
1659
+
1660
+ // ---- Events (ReactNativeGen_DESIGN.md §6) ----
1661
+
1662
+ /**
1663
+ * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
1664
+ * can measure progress. Runs on the JavaScript thread, so it is only useful with the
1665
+ * `...Async` methods (during a synchronous call the thread is busy and the events arrive
1666
+ * after it returns). Assign `undefined` to remove.
1667
+ */
1668
+ onPercentDone?: (pctDone: number) => void
1669
+
1670
+ /**
1671
+ * Called with a name/value pair of progress information while a long-running method runs
1672
+ * (what is reported depends on the class and method). Runs on the JavaScript thread; see
1673
+ * {@link Mht.onPercentDone}. Assign `undefined` to remove.
1674
+ */
1675
+ onProgressInfo?: (name: string, value: string) => void
1676
+
1677
+ /**
1678
+ * Requests that the pending `...Async` call on this object stop at its next progress check.
1679
+ * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
1680
+ * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
1681
+ * for a responsive cancel. Harmless when nothing is pending.
1682
+ */
1683
+ abort(): void
1684
+ }