@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,3571 @@
1
+ // Generated by ReactNativeNs.RnGenerator -- do not edit.
2
+ import type { HybridObject } from 'react-native-nitro-modules'
3
+ import type { BinData } from './BinData.nitro'
4
+ import type { Cert } from './Cert.nitro'
5
+ import type { Email } from './Email.nitro'
6
+ import type { EmailBundle } from './EmailBundle.nitro'
7
+ import type { JsonObject } from './JsonObject.nitro'
8
+ import type { PrivateKey } from './PrivateKey.nitro'
9
+ import type { SecureString } from './SecureString.nitro'
10
+ import type { Socket } from './Socket.nitro'
11
+ import type { Ssh } from './Ssh.nitro'
12
+ import type { SshKey } from './SshKey.nitro'
13
+ import type { StringArray } from './StringArray.nitro'
14
+ import type { StringBuilder } from './StringBuilder.nitro'
15
+ import type { StringTable } from './StringTable.nitro'
16
+ import type { XmlCertVault } from './XmlCertVault.nitro'
17
+
18
+ /**
19
+ * Send, receive, secure, and troubleshoot email with SMTP and POP3.
20
+ *
21
+ * `MailMan` is a full-featured email client class for
22
+ * applications that need SMTP sending and POP3 receiving. It supports secure
23
+ * authentication, MIME rendering, attachments, S/MIME signing and encryption,
24
+ * OAuth2, TLS/STARTTLS, proxy and SSH tunnel routing, POP3 download and delete
25
+ * workflows, delivery status notifications, and detailed diagnostics for
26
+ * troubleshooting mail server communication.
27
+ *
28
+ * **SMTP sending**
29
+ *
30
+ * Send email messages, MIME content, bundles of messages, and signed or
31
+ * encrypted S/MIME mail through SMTP servers.
32
+ *
33
+ * **POP3 receiving**
34
+ *
35
+ * Connect to POP3 mailboxes, list messages, download email, retrieve
36
+ * headers, and control when messages are deleted from the server.
37
+ *
38
+ * **Secure authentication**
39
+ *
40
+ * Use passwords, OAuth2 access tokens, TLS, STARTTLS, client certificates,
41
+ * and secret-backed credentials where appropriate.
42
+ *
43
+ * **MIME and attachments**
44
+ *
45
+ * Render, send, retrieve, and process MIME messages, including HTML bodies,
46
+ * alternative bodies, embedded images, and file attachments.
47
+ *
48
+ * **S/MIME support**
49
+ *
50
+ * Work with certificates and private keys to sign, verify, encrypt, and
51
+ * decrypt email messages.
52
+ *
53
+ * **Diagnostics and routing**
54
+ *
55
+ * Troubleshoot SMTP and POP3 sessions with detailed logs, status codes,
56
+ * server responses, proxy settings, and SSH tunnel support.
57
+ *
58
+ * **Common pattern:**
59
+ * Configure the SMTP or POP3 server settings, choose the security and
60
+ * authentication method, send or retrieve messages, then inspect server status,
61
+ * response text, and `LastErrorText` when troubleshooting provider-
62
+ * specific behavior.
63
+ *
64
+ * For an extended overview, see
65
+ * [MailMan Class Overview](https://www.chilkatsoft.com/mailman_class_overview.asp).
66
+ *
67
+ * Each `MailMan` instance owns a native Chilkat object. It is released when the JavaScript object
68
+ * is
69
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
70
+ * Create one with `new MailMan()`.
71
+ *
72
+ * Methods that can take a while (network, files, compression, key generation) also have an
73
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
74
+ * rendering. While such a call is pending, every other call on this object throws, except
75
+ * {@link MailMan.abort} and assigning {@link MailMan.onPercentDone} / {@link
76
+ * MailMan.onProgressInfo}.
77
+ */
78
+ export interface MailMan extends HybridObject<{ ios: 'c++', android: 'c++' }> {
79
+ // ---- Properties ----
80
+
81
+ /**
82
+ * Provides HTML-formatted information about the last called method or property. If a method call
83
+ * fails or behaves unexpectedly, check this property for details. Note that information is
84
+ * available regardless of the method call's success.
85
+ *
86
+ * This property is read-only.
87
+ */
88
+ readonly lastErrorHtml: string
89
+
90
+ /**
91
+ * Provides plain text information about the last called method or property. If a method call
92
+ * fails or behaves unexpectedly, check this property for details. Note that information is
93
+ * available regardless of the method call's success.
94
+ *
95
+ * This property is read-only.
96
+ */
97
+ readonly lastErrorText: string
98
+
99
+ /**
100
+ * Provides XML-formatted information about the last called method or property. If a method call
101
+ * fails or behaves unexpectedly, check this property for details. Note that information is
102
+ * available regardless of the method call's success.
103
+ *
104
+ * This property is read-only.
105
+ */
106
+ readonly lastErrorXml: string
107
+
108
+ /**
109
+ * Version of the component/library, such as "10.1.0"
110
+ *
111
+ * This property is read-only.
112
+ */
113
+ readonly version: string
114
+
115
+ /**
116
+ * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
117
+ * call to the specified file. This logging helps identify the context and history of Chilkat
118
+ * calls leading up to any crash or hang, aiding in debugging.
119
+ *
120
+ * Enabling the VerboseLogging property provides more detailed information.
121
+ *
122
+ * This property is mainly used for debugging rare instances where a Chilkat method call causes a
123
+ * hang or crash, which should generally not happen.
124
+ *
125
+ * Possible causes of hangs include:
126
+ *
127
+ * - A timeout property set to 0, indicating an infinite timeout.
128
+ *
129
+ * - A hang occurring within an event callback in the application code.
130
+ *
131
+ * - An internal bug in the Chilkat code causing the hang.
132
+ */
133
+ debugLogFilePath: string
134
+
135
+ /**
136
+ * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
137
+ * contain more verbose information. The default value is `false`. Verbose logging should only be
138
+ * used for debugging. The potentially large quantity of logged information may adversely affect
139
+ * peformance.
140
+ */
141
+ verboseLogging: boolean
142
+
143
+ /**
144
+ * Indicates the success or failure of the most recent method call: `true` means success, `false`
145
+ * means failure. This property remains unchanged by property setters or getters. This method is
146
+ * present to address challenges in checking for null or Nothing returns in certain programming
147
+ * languages. Note: This property does not apply to methods that return integer values or to
148
+ * boolean-returning methods where the boolean does not indicate success or failure.
149
+ */
150
+ lastMethodSuccess: boolean
151
+
152
+ /**
153
+ * Set this property to `_TRUE_` to request that the currently running
154
+ * operation be aborted.
155
+ *
156
+ * This applies to methods that may take time to complete, such as methods that
157
+ * perform network communication or lengthy file operations. Methods that always
158
+ * complete quickly are generally not affected.
159
+ *
160
+ * If no method is currently running, the property is automatically reset to
161
+ * `_FALSE_` when the next method call begins. When an abort actually
162
+ * occurs, Chilkat resets this property to `_FALSE_`.
163
+ *
164
+ * Both synchronous and asynchronous method calls can be aborted. A synchronous
165
+ * method can be aborted by setting this property from another thread.
166
+ */
167
+ abortCurrent: boolean
168
+
169
+ /**
170
+ * Determines whether an email should be sent when one or more recipients are
171
+ * rejected by the SMTP server.
172
+ *
173
+ * The default value is `_FALSE_`, which means Chilkat continues sending
174
+ * even if some recipients are rejected.
175
+ *
176
+ * When set to `_TRUE_`, the email is not sent to any recipients if the
177
+ * SMTP server rejects any recipient address.
178
+ *
179
+ * **Important:** This property only works when SMTP pipelining is
180
+ * disabled. Because {@link MailMan.smtpPipelining} is `_TRUE_` by default,
181
+ * set `SmtpPipelining = _FALSE_` when all-or-none behavior is required.
182
+ *
183
+ * **Note:** SMTP servers do not always verify recipient addresses.
184
+ * Even when they do, the server can usually verify only addresses within domains
185
+ * it controls.
186
+ */
187
+ allOrNone: boolean
188
+
189
+ /**
190
+ * Controls whether Chilkat automatically selects the SMTP and POP3 TLS mode from
191
+ * a standard port number when a connection is prepared.
192
+ *
193
+ * - SMTP port `465`: implicit TLS (`0 = _TRUE_`).
194
+ *
195
+ * - SMTP port `587`: explicit TLS using `STARTTLS`.
196
+ *
197
+ * - SMTP port `25`: no TLS is implied.
198
+ *
199
+ * - POP3 port `995`: implicit TLS (`1 = _TRUE_`).
200
+ *
201
+ * - POP3 port `110`: no TLS is implied.
202
+ *
203
+ * The default value is `_TRUE_`. For these standard ports, Chilkat sets
204
+ * the related TLS properties to a consistent combination before connecting, so
205
+ * conflicting implicit and explicit TLS settings do not remain in effect.
206
+ *
207
+ * If the configured port is nonstandard, AutoFix does not change the TLS
208
+ * properties. The application must set the desired implicit, required-explicit,
209
+ * opportunistic-explicit, or unencrypted mode explicitly.
210
+ *
211
+ * **Important:** AutoFix is applied when Chilkat prepares the
212
+ * connection. Assigning a port number does not immediately rewrite the visible
213
+ * property values.
214
+ */
215
+ autoFix: boolean
216
+
217
+ /**
218
+ * Determines whether Chilkat automatically generates a unique
219
+ * `Message-ID` header when an email is sent.
220
+ *
221
+ * The default behavior is to generate a new unique `Message-ID` at
222
+ * send time. This allows the same `Email` object to be reused without
223
+ * accidentally sending duplicate message IDs.
224
+ *
225
+ * If duplicate message IDs are used, some SMTP servers may treat the message as
226
+ * a duplicate and discard it.
227
+ *
228
+ * When automatic generation is enabled, calling
229
+ * `GetHeaderField("Message-ID")` before sending will not necessarily
230
+ * show the actual message ID that Chilkat sends.
231
+ *
232
+ * Set this property to `_FALSE_` to prevent Chilkat from automatically
233
+ * generating the `Message-ID` header.
234
+ */
235
+ autoGenMessageId: boolean
236
+
237
+ /**
238
+ * When `_TRUE_`, Chilkat automatically sends the SMTP
239
+ * `RSET` command before sending a new email over an already-open SMTP
240
+ * connection.
241
+ *
242
+ * This helps ensure the SMTP session is in a clean state before the next email
243
+ * is sent.
244
+ *
245
+ * The default value is `_FALSE_`.
246
+ *
247
+ * **Note:** This property only applies when reusing an existing SMTP
248
+ * connection.
249
+ */
250
+ autoSmtpRset: boolean
251
+
252
+ /**
253
+ * Determines whether Chilkat automatically unwraps digitally signed or encrypted
254
+ * email when the message is downloaded or loaded from MIME.
255
+ *
256
+ * The default value is `_TRUE_`. When enabled, Chilkat verifies
257
+ * signatures and decrypts encrypted content when possible. The results are made
258
+ * available through the email object's security-related properties and methods.
259
+ *
260
+ * Set this property to `_FALSE_` if you want signed or encrypted
261
+ * attachments, such as `.p7m` or `.p7s` files, to remain as
262
+ * ordinary attachments.
263
+ *
264
+ * **Important:** Signature verification and decryption must occur
265
+ * when the original MIME is first loaded. After MIME is parsed into Chilkat's
266
+ * internal email object format, the exact original MIME bytes are no longer
267
+ * available, and the signature can no longer be verified.
268
+ */
269
+ autoUnwrapSecurity: boolean
270
+
271
+ /**
272
+ * Sets the local IP address to use when connecting from a computer that has
273
+ * multiple network interfaces or multiple IP addresses.
274
+ *
275
+ * For most computers, this property should be left unset. Chilkat will
276
+ * automatically use the default local IP address.
277
+ *
278
+ * The value should be a numeric IP address, such as
279
+ * `165.164.55.124`, not a hostname.
280
+ */
281
+ clientIpAddress: string
282
+
283
+ /**
284
+ * Contains a numeric code describing the result of the last connection attempt.
285
+ * This applies to the last connection made, or attempted, by any method.
286
+ *
287
+ * CodeMeaning
288
+ *
289
+ * | `0` | | Success. |
290
+ *
291
+ * | `1` | | Empty hostname. |
292
+ *
293
+ * | `2` | | DNS lookup failed. |
294
+ *
295
+ * | `3` | | DNS timeout. |
296
+ *
297
+ * | `4` | | Aborted by the application. |
298
+ *
299
+ * | `5` | | Internal failure. |
300
+ *
301
+ * | `6` | | Connection timed out. |
302
+ *
303
+ * | `7` | | Connection rejected, or failed for another reason. |
304
+ *
305
+ * | `100` | | TLS internal error. |
306
+ *
307
+ * | `101` | | Failed to send the TLS client hello. |
308
+ *
309
+ * | `102` | | Unexpected TLS handshake message. |
310
+ *
311
+ * | `103` | | Failed to read the TLS server hello. |
312
+ *
313
+ * | `104` | | No server certificate was received. |
314
+ *
315
+ * | `105` | | Unexpected TLS protocol version. |
316
+ *
317
+ * | `106` | | Server certificate verification failed. |
318
+ *
319
+ * | `107` | | Unacceptable TLS protocol version. |
320
+ *
321
+ * | `109` | | Failed to read TLS handshake messages. |
322
+ *
323
+ * | `110` | | Failed to send client certificate handshake message. |
324
+ *
325
+ * | `111` | | Failed to send client key exchange handshake message. |
326
+ *
327
+ * | `112` | | Client certificate private key is not accessible. |
328
+ *
329
+ * | `113` | | Failed to send client certificate verify handshake message. |
330
+ *
331
+ * | `114` | | Failed to send change cipher spec handshake message. |
332
+ *
333
+ * | `115` | | Failed to send finished handshake message. |
334
+ *
335
+ * | `116` | | The server's finished message is invalid. |
336
+ *
337
+ * This property is read-only.
338
+ */
339
+ readonly connectFailReason: number
340
+
341
+ /**
342
+ * The maximum number of seconds to wait while attempting to connect to an SMTP
343
+ * or POP3 server.
344
+ *
345
+ * The default value is `30` seconds.
346
+ */
347
+ connectTimeout: number
348
+
349
+ /**
350
+ * The `DsnEnvid` property specifies the SMTP DSN
351
+ * `ENVID` value, which is an arbitrary identifier attached to the
352
+ * SMTP envelope. The same value is typically returned in DSN responses so the
353
+ * sending application can correlate delivery notifications with the original
354
+ * outbound email.
355
+ *
356
+ * Common choices for `DsnEnvid` include:
357
+ *
358
+ * -
359
+ * An internal message ID:
360
+ * `MSG-10004521`
361
+ *
362
+ * -
363
+ * A GUID or UUID:
364
+ * `550e8400-e29b-41d4-a716-446655440000`
365
+ *
366
+ * -
367
+ * An order or transaction number:
368
+ * `ORDER-847291`
369
+ *
370
+ * -
371
+ * A timestamp-based identifier:
372
+ * `MAIL-20260515-153045-001`
373
+ *
374
+ * -
375
+ * A composite identifier combining application, customer, and message IDs:
376
+ * `billing|cust-9182|invoice-44381`
377
+ *
378
+ * The value should uniquely identify the outbound email within your application.
379
+ * It does not need to match the MIME `Message-ID` header, although
380
+ * some applications choose to use the same identifier for both.
381
+ *
382
+ * **About `SMTP DSN`**
383
+ *
384
+ * SMTP **DSN** means **Delivery Status Notification**.
385
+ * It is an optional SMTP service extension defined by RFC 3461 that allows the
386
+ * sender to request delivery-status reports from the SMTP server.
387
+ *
388
+ * DSN allows an application to request notifications such as:
389
+ *
390
+ * - Successful delivery
391
+ *
392
+ * - Delivery failure
393
+ *
394
+ * - Delayed delivery
395
+ *
396
+ * It also allows the sender to specify whether the returned notification should
397
+ * include the full original message or only the message headers.
398
+ *
399
+ * In `MailMan`, DSN behavior is controlled using:
400
+ *
401
+ * - `DsnEnvid` — sets the SMTP `ENVID` envelope identifier.
402
+ *
403
+ * - {@link MailMan.dsnNotify} — controls when notifications are requested, such as `SUCCESS`,
404
+ * `FAILURE`, `DELAY`, or `NEVER`.
405
+ *
406
+ * - {@link MailMan.dsnRet} — controls whether DSN responses include the full message or only
407
+ * headers.
408
+ *
409
+ * DSN is an optional SMTP extension and is not supported by all SMTP servers.
410
+ * A server supports DSN only if it advertises the `DSN` capability in
411
+ * response to the SMTP `EHLO` command.
412
+ *
413
+ * The {@link MailMan.isSmtpDsnCapable} method can be used to determine whether the
414
+ * SMTP server supports DSN.
415
+ *
416
+ * Even when DSN is supported, some SMTP servers or downstream mail systems may
417
+ * ignore or partially honor DSN requests.
418
+ */
419
+ dsnEnvid: string
420
+
421
+ /**
422
+ * Sets the SMTP DSN `NOTIFY` parameter used when sending email.
423
+ *
424
+ * The value may be left empty, set to `NEVER`, or set to a
425
+ * comma-separated combination of `SUCCESS`, `FAILURE`, and
426
+ * `DELAY`.
427
+ */
428
+ dsnNotify: string
429
+
430
+ /**
431
+ * Sets the SMTP DSN `RET` parameter used when sending email.
432
+ *
433
+ * The value may be left empty, set to `FULL` to request the full
434
+ * message in DSN notifications, or set to `HDRS` to request only the
435
+ * message headers.
436
+ */
437
+ dsnRet: string
438
+
439
+ /**
440
+ * When `_TRUE_`, Chilkat embeds the signing certificate chain in signed
441
+ * email.
442
+ *
443
+ * Certificates are included up to, but not including, the root certificate. If
444
+ * {@link MailMan.includeRootCert} is also `_TRUE_`, the root CA certificate
445
+ * is included as well.
446
+ *
447
+ * The default value is `_FALSE_`
448
+ */
449
+ embedCertChain: boolean
450
+
451
+ /**
452
+ * Specifies a filter expression applied by methods such as
453
+ * `LoadXmlFile`, `LoadXmlString`, `LoadMbx`,
454
+ * `CopyMail`, and `TransferMail`.
455
+ *
456
+ * When a filter is present, only emails matching the expression are returned.
457
+ * For `TransferMail`, only matching emails are removed from the mail
458
+ * server.
459
+ *
460
+ * Example expressions:
461
+ *
462
+ * `Body like "mortgage rates*"`
463
+ *
464
+ * `Subject contains "update" and From contains "chilkat"`
465
+ *
466
+ * `To = "info@chilkatsoft.com"`
467
+ *
468
+ * Rules for filter expressions:
469
+ *
470
+ * - Any MIME header field name may be used. Header names are case-insensitive.
471
+ *
472
+ * - Literal strings are enclosed in double quotes.
473
+ *
474
+ * - String matching is case-insensitive.
475
+ *
476
+ * - The `*` wildcard matches zero or more characters.
477
+ *
478
+ * - Parentheses may be used to control precedence.
479
+ *
480
+ * - Logical operators are `AND`, `OR`, and `NOT`.
481
+ *
482
+ * - String comparison operators include `CONTAINS` and `LIKE`.
483
+ *
484
+ * **Note:** Filtering works on text strings only, not dates or
485
+ * numbers.
486
+ */
487
+ filter: string
488
+
489
+ /**
490
+ * Sets the interval, in milliseconds, between `AbortCheck`
491
+ * event callbacks.
492
+ *
493
+ * This allows an application to periodically decide whether a long-running
494
+ * operation should be aborted.
495
+ *
496
+ * The default value is `0`, which means no `AbortCheck`
497
+ * callbacks are generated.
498
+ */
499
+ heartbeatMs: number
500
+
501
+ /**
502
+ * Sets the hostname sent in the SMTP `EHLO` or
503
+ * `HELO` command.
504
+ *
505
+ * The default value is an empty string, which causes Chilkat to use the local
506
+ * computer's hostname.
507
+ */
508
+ heloHostname: string
509
+
510
+ /**
511
+ * Sets the authentication method used when the configured HTTP proxy requires credentials.
512
+ *
513
+ * Valid values are `Basic` and `NTLM`. Leave this property empty when the proxy does not require
514
+ * authentication.
515
+ */
516
+ httpProxyAuthMethod: string
517
+
518
+ /**
519
+ * Sets the optional Windows domain used for NTLM authentication with an HTTP proxy.
520
+ *
521
+ * This property is ignored for Basic proxy authentication and may be left empty when no NTLM
522
+ * domain is required.
523
+ */
524
+ httpProxyDomain: string
525
+
526
+ /**
527
+ * Sets the hostname or IP address of the HTTP proxy used for SMTP and POP3 connections.
528
+ *
529
+ * Leave this property empty to connect directly without an HTTP proxy.
530
+ */
531
+ httpProxyHostname: string
532
+
533
+ /**
534
+ * Sets the password used to authenticate with the configured HTTP proxy.
535
+ *
536
+ * This property is used together with {@link MailMan.httpProxyUsername} and, for NTLM
537
+ * authentication, may also be used with {@link MailMan.httpProxyDomain}.
538
+ */
539
+ httpProxyPassword: string
540
+
541
+ /**
542
+ * Sets the TCP port of the HTTP proxy.
543
+ *
544
+ * Common proxy ports include `8080` and `3128`. The value is used only when {@link
545
+ * MailMan.httpProxyHostname} is set.
546
+ */
547
+ httpProxyPort: number
548
+
549
+ /**
550
+ * Sets the username used to authenticate with the configured HTTP proxy.
551
+ *
552
+ * This property is used only when the proxy requires authentication.
553
+ */
554
+ httpProxyUsername: string
555
+
556
+ /**
557
+ * Determines whether pending POP3 deletion marks are committed automatically
558
+ * after a successful delete operation or full-message retrieval performed with
559
+ * `keepOnServer = _FALSE_`.
560
+ *
561
+ * The default value is `_TRUE_`. Chilkat sends `DELE` as each
562
+ * message is processed. After the complete operation succeeds, Chilkat sends
563
+ * `QUIT`, commits the deletions, and closes the POP3 session. The next
564
+ * POP3 method automatically reconnects and establishes a new session.
565
+ *
566
+ * When set to `_FALSE_`, Chilkat sends `DELE` but leaves the
567
+ * session open and the deletions uncommitted. Call
568
+ * {@link MailMan.pop3EndSession} to send `QUIT`
569
+ * and commit them. Calling {@link MailMan.pop3Reset}, calling
570
+ * {@link MailMan.pop3EndSessionNoQuit}, or losing
571
+ * the POP3 connection before `QUIT` causes the server to forget the
572
+ * pending deletion marks.
573
+ *
574
+ * Header-only or partial-message retrieval never marks a message for deletion,
575
+ * regardless of this property or the value of `keepOnServer`.
576
+ */
577
+ immediateDelete: boolean
578
+
579
+ /**
580
+ * Determines whether the root CA certificate is included in the S/MIME signature
581
+ * of a signed email.
582
+ *
583
+ * This property only applies when {@link MailMan.embedCertChain} is
584
+ * `_TRUE_`.
585
+ */
586
+ includeRootCert: boolean
587
+
588
+ /**
589
+ * Returns `_TRUE_` if Chilkat believes the POP3 connection is still
590
+ * open.
591
+ *
592
+ * Accessing this property does not send any command to the POP3 server. If the
593
+ * server has disconnected but Chilkat has not yet attempted further
594
+ * communication, this property may still return `_TRUE_`.
595
+ *
596
+ * To verify that the POP3 connection is actually alive, call
597
+ * {@link MailMan.pop3Noop}.
598
+ *
599
+ * This property is read-only.
600
+ */
601
+ readonly isPop3Connected: boolean
602
+
603
+ /**
604
+ * Returns `_TRUE_` if Chilkat believes the SMTP connection is still
605
+ * open.
606
+ *
607
+ * Accessing this property does not communicate with the SMTP server. A lost
608
+ * connection may not be detected until the next SMTP command is sent.
609
+ *
610
+ * To verify that the SMTP connection is actually alive, call
611
+ * {@link MailMan.smtpNoop}.
612
+ *
613
+ * This property is read-only.
614
+ */
615
+ readonly isSmtpConnected: boolean
616
+
617
+ /**
618
+ * Contains the SMTP failure status code returned by the server for the most recent SMTP
619
+ * operation.
620
+ *
621
+ * This property is nonzero only when Chilkat successfully connected, began an SMTP session, and
622
+ * then received a status code indicating failure. Such failures are generally reported by `4xx`
623
+ * or `5xx` replies.
624
+ *
625
+ * - **4xx** — Temporary failure. Retrying later may succeed.
626
+ *
627
+ * - **5xx** — Permanent failure. The request was rejected and usually requires a change before
628
+ * retrying.
629
+ *
630
+ * A value of `0` means that no SMTP failure status code was received. For example, the operation
631
+ * may have failed before an SMTP session was established. Use {@link MailMan.smtpFailReason} and
632
+ * `LastErrorText` for additional diagnostic information.
633
+ *
634
+ * This property is read-only.
635
+ */
636
+ readonly lastSmtpStatus: number
637
+
638
+ /**
639
+ * Specifies a local file path where Chilkat writes each message exactly as it was
640
+ * received from the POP3 server.
641
+ *
642
+ * This is useful for debugging problems involving MIME structure, encodings,
643
+ * attachments, or server behavior.
644
+ */
645
+ logMailReceivedFilename: string
646
+
647
+ /**
648
+ * Specifies a local file path where Chilkat writes the exact MIME message sent to the
649
+ * SMTP server.
650
+ *
651
+ * This is useful for inspecting the final
652
+ * MIME produced by Chilkat.
653
+ */
654
+ logMailSentFilename: string
655
+
656
+ /**
657
+ * Sets the POP3 server hostname or IP address.
658
+ *
659
+ * Do not include `http://` or `https://`. The value should
660
+ * be a hostname such as `pop.example.com` or an IPv4/IPv6 address.
661
+ */
662
+ mailHost: string
663
+
664
+ /**
665
+ * Sets the POP3 server port number.
666
+ *
667
+ * The default value is `110`.
668
+ *
669
+ * The standard POP3 ports and their associated
670
+ * `MailMan` property settings are described below.
671
+ *
672
+ * **Port 995 — POP3 over Implicit SSL/TLS**
673
+ *
674
+ * Uses implicit SSL/TLS, meaning the TLS connection is established
675
+ * immediately when the TCP connection is opened.
676
+ *
677
+ * ```
678
+ * mailman.MailPort = 995;
679
+ * mailman.PopSsl = true;
680
+ * ```
681
+ *
682
+ * **Port 110 — Standard Unencrypted POP3**
683
+ *
684
+ * Uses a normal unencrypted POP3 connection.
685
+ *
686
+ * ```
687
+ * mailman.MailPort = 110;
688
+ * mailman.PopSsl = false;
689
+ * mailman.Pop3Stls = false;
690
+ * mailman.Pop3StlsIfPossible = false;
691
+ * ```
692
+ *
693
+ * **Port 110 — POP3 with Explicit TLS via STLS**
694
+ *
695
+ * The connection begins unencrypted and is upgraded to TLS using the POP3
696
+ * `STLS` command.
697
+ *
698
+ * ```
699
+ * mailman.MailPort = 110;
700
+ * mailman.PopSsl = false;
701
+ * mailman.Pop3Stls = true;
702
+ * ```
703
+ *
704
+ * **Port 110 — Opportunistic STLS**
705
+ *
706
+ * Attempts to upgrade the connection to TLS using `STLS` if the
707
+ * POP3 server supports it. Otherwise, the connection remains unencrypted.
708
+ *
709
+ * ```
710
+ * mailman.MailPort = 110;
711
+ * mailman.PopSsl = false;
712
+ * mailman.Pop3StlsIfPossible = true;
713
+ * ```
714
+ *
715
+ * **Important:** {@link MailMan.popSsl} and
716
+ * {@link MailMan.pop3Stls} represent two different approaches to TLS security:
717
+ *
718
+ * -
719
+ * `PopSsl = true` means the connection begins as SSL/TLS from the
720
+ * very start (implicit TLS).
721
+ *
722
+ * -
723
+ * `Pop3Stls = true` means the connection begins unencrypted and is
724
+ * later upgraded to TLS using the POP3 `STLS` command (explicit
725
+ * TLS).
726
+ *
727
+ * These two approaches are mutually exclusive and should not both be enabled
728
+ * at the same time.
729
+ *
730
+ * Modern POP3 servers most commonly use either:
731
+ *
732
+ * - `995` with `PopSsl = true`, or
733
+ *
734
+ * - `110` with `Pop3Stls = true`.
735
+ */
736
+ mailPort: number
737
+
738
+ /**
739
+ * Limits the number of messages retrieved from the POP3 server. The following
740
+ * methods honor this property:
741
+ *
742
+ * - `GetAllHeaders`
743
+ *
744
+ * - `GetHeaders`
745
+ *
746
+ * - {@link MailMan.fetchAll}
747
+ *
748
+ * - {@link MailMan.fetchRange}
749
+ *
750
+ * The default value is `0`, which means no limit.
751
+ *
752
+ * For `FetchAll`, a positive value selects the newest messages in the
753
+ * mailbox. For example, when `MaxCount = 2`, the two newest messages are
754
+ * retrieved and returned in normal mailbox order, with the older of the two first.
755
+ */
756
+ maxCount: number
757
+
758
+ /**
759
+ * Sets the OAuth2 access token used for POP3 or SMTP XOAUTH2 authentication.
760
+ *
761
+ * When this property is set, Chilkat uses the `AUTH XOAUTH2` authentication mechanism when it is
762
+ * supported by the server.
763
+ *
764
+ * **For POP3 XOAUTH2 authentication:**
765
+ * {@link MailMan.popPassword} should be left empty, or explicitly set to the empty string.
766
+ *
767
+ * **For SMTP XOAUTH2 authentication:**
768
+ * {@link MailMan.smtpPassword} should be left unset, or set to the empty string.
769
+ *
770
+ * The access token is sent as a bearer token during the `AUTH XOAUTH2` authentication exchange.
771
+ */
772
+ oAuth2AccessToken: string
773
+
774
+ /**
775
+ * Controls the MIME format used for digitally signed email.
776
+ *
777
+ * When set to `_FALSE_`, Chilkat creates a
778
+ * `multipart/signed` email. In this format, the original email
779
+ * content remains visible as a normal MIME body part, and the digital
780
+ * signature is included as a separate MIME part.
781
+ *
782
+ * The top-level MIME `Content-Type` header will look similar to:
783
+ *
784
+ * ```
785
+ * Content-Type: multipart/signed;
786
+ * protocol="application/pkcs7-signature";
787
+ * micalg=sha-256;
788
+ * boundary="------------040808030405050402070604"
789
+ * ```
790
+ *
791
+ * This is commonly referred to as a detached signature because the signed
792
+ * content exists separately from the signature itself.
793
+ *
794
+ * When set to `_TRUE_`, Chilkat creates an opaque signed email
795
+ * using PKCS#7 signed-data format. In this case, the original MIME content is
796
+ * encapsulated inside the PKCS#7 signature structure.
797
+ *
798
+ * The top-level MIME `Content-Type` header will look similar to:
799
+ *
800
+ * ```
801
+ * Content-Type: application/pkcs7-mime;
802
+ * smime-type="signed-data";
803
+ * name="smime.p7m"; micalg=sha-256
804
+ * ```
805
+ *
806
+ * This format is historically known as opaque signing because the original
807
+ * message content is wrapped inside the PKCS#7 signed object and is not
808
+ * directly visible as ordinary MIME body parts.
809
+ *
810
+ * The default value is `_TRUE_`.
811
+ */
812
+ opaqueSigning: boolean
813
+
814
+ /**
815
+ * Sets the filename used in the `Content-Disposition` header
816
+ * when sending a PKCS#7 encrypted email.
817
+ *
818
+ * The default value is `smime.p7m`.
819
+ */
820
+ p7mEncryptAttachFilename: string
821
+
822
+ /**
823
+ * Sets the filename used in the `Content-Disposition` header
824
+ * when sending an opaque signed PKCS#7 email.
825
+ *
826
+ * The default value is `smime.p7m`.
827
+ */
828
+ p7mSigAttachFilename: string
829
+
830
+ /**
831
+ * Sets the filename used in the `Content-Disposition` header
832
+ * when sending a signed email with a detached PKCS#7 signature.
833
+ *
834
+ * The default value is `smime.p7s`.
835
+ */
836
+ p7sSigAttachFilename: string
837
+
838
+ /**
839
+ * This property is only valid in programming environments and languages that
840
+ * allow for event callbacks.
841
+ *
842
+ * Sets the value that represents 100% completion for
843
+ * `PercentDone` event callbacks.
844
+ *
845
+ * The default value is `100`, meaning progress values range from
846
+ * `0` to `100`. Setting this property to a larger value
847
+ * provides finer granularity. For example, setting
848
+ * `PercentDoneScale = 1000` allows progress to be reported in
849
+ * tenths of a percent.
850
+ *
851
+ * For example, if `PercentDoneScale = 1000`, then a callback value
852
+ * of `453` represents 45.3% complete.
853
+ *
854
+ * The value is clamped to a minimum of `10` and a maximum of
855
+ * `100000`.
856
+ */
857
+ percentDoneScale: number
858
+
859
+ /**
860
+ * Determines whether SPA, also known as NTLM authentication, is used for POP3.
861
+ *
862
+ * Set this property to `_TRUE_` to use SPA authentication. No other
863
+ * programming changes are required.
864
+ *
865
+ * The default value is `_FALSE_`.
866
+ *
867
+ * **Note:** If SPA/NTLM authentication fails, set
868
+ * `Global.DefaultNtlmVersion = 1` and retry.
869
+ */
870
+ pop3SPA: boolean
871
+
872
+ /**
873
+ * Returns `0` when no POP3 session is active.
874
+ *
875
+ * Otherwise, returns a positive integer that increments each time a new POP3
876
+ * session is established. This can be used to detect whether a new session has
877
+ * started.
878
+ *
879
+ * This property is read-only.
880
+ */
881
+ readonly pop3SessionId: number
882
+
883
+ /**
884
+ * Provides the accumulated raw POP3 commands sent to the server and the raw
885
+ * responses received from the server.
886
+ *
887
+ * This property is read-only. To clear it, call
888
+ * {@link MailMan.clearPop3SessionLog}.
889
+ *
890
+ * This property is read-only.
891
+ */
892
+ readonly pop3SessionLog: string
893
+
894
+ /**
895
+ * Indicates whether the POP3 server certificate chain was successfully verified
896
+ * during the most recent SSL/TLS POP3 connection.
897
+ *
898
+ * This property reports certificate-chain verification only. It does not report
899
+ * hostname matching or public key pinning. When either of those checks is
900
+ * required, a mismatch causes the connection itself to fail.
901
+ *
902
+ * This property is meaningful only after an SSL/TLS POP3 connection attempt.
903
+ *
904
+ * This property is read-only.
905
+ */
906
+ readonly pop3SslServerCertVerified: boolean
907
+
908
+ /**
909
+ * Determines whether Chilkat requires the POP3 connection to be upgraded to TLS
910
+ * using the `STLS` command.
911
+ *
912
+ * When set to `_TRUE_`, Chilkat initially connects without encryption
913
+ * and then sends `STLS` before authenticating. The connection fails if
914
+ * the server does not support the required upgrade.
915
+ *
916
+ * {@link MailMan.popSsl} takes precedence. If implicit TLS is
917
+ * enabled, this property does not cause an additional explicit TLS upgrade.
918
+ *
919
+ * The default value is `_FALSE_`. Use
920
+ * {@link MailMan.pop3StlsIfPossible} when the upgrade
921
+ * should be attempted only when the server advertises support.
922
+ */
923
+ pop3Stls: boolean
924
+
925
+ /**
926
+ * Sets the POP3 password.
927
+ *
928
+ * On Windows, if {@link MailMan.pop3SPA} is enabled, both {@link MailMan.popUsername} and
929
+ * `PopPassword` may be set to `"default"` to use the
930
+ * credentials of the current logged-on Windows user.
931
+ */
932
+ popPassword: string
933
+
934
+ /**
935
+ * Sets the POP3 password as Base64-encoded data instead of plain text.
936
+ *
937
+ * MailMan decodes the Base64 value and uses the resulting bytes as the POP3 password. This
938
+ * property is useful when an application already stores or receives the password in Base64 form;
939
+ * Base64 encoding by itself does not provide encryption.
940
+ */
941
+ popPasswordBase64: string
942
+
943
+ /**
944
+ * Determines whether implicit SSL/TLS is used when connecting to the POP3 server.
945
+ *
946
+ * When set to `_TRUE_`, the TLS connection is established immediately
947
+ * when the TCP connection is opened. Implicit POP3 TLS commonly uses port
948
+ * `995`.
949
+ *
950
+ * Implicit TLS takes precedence over explicit TLS. Therefore, when
951
+ * `PopSsl = _TRUE_`, the settings in
952
+ * {@link MailMan.pop3Stls} and
953
+ * {@link MailMan.pop3StlsIfPossible} do not cause a
954
+ * separate `STLS` upgrade.
955
+ *
956
+ * The default value is `_FALSE_`. When
957
+ * {@link MailMan.autoFix} is enabled, a standard POP3 port can
958
+ * cause Chilkat to select the appropriate TLS mode automatically before
959
+ * connecting.
960
+ */
961
+ popSsl: boolean
962
+
963
+ /**
964
+ * Sets the POP3 login name.
965
+ *
966
+ * On Windows, if {@link MailMan.pop3SPA} is enabled, both `PopUsername` and
967
+ * {@link MailMan.popPassword} may be set to `"default"` to use the
968
+ * credentials of the current logged-on Windows user.
969
+ */
970
+ popUsername: string
971
+
972
+ /**
973
+ * Determines whether IPv6 is preferred over IPv4 when both are available for a
974
+ * hostname.
975
+ *
976
+ * The default value is `_FALSE_`, which means IPv4 is preferred.
977
+ */
978
+ preferIpv6: boolean
979
+
980
+ /**
981
+ * Sets the maximum number of seconds to wait when the SMTP or POP3 server
982
+ * stops responding.
983
+ *
984
+ * The default value is `30` seconds.
985
+ */
986
+ readTimeout: number
987
+
988
+ /**
989
+ * Determines whether Chilkat requires the SMTP or POP3 server certificate chain
990
+ * to be successfully verified for an SSL/TLS connection.
991
+ *
992
+ * When set to `_TRUE_`, Chilkat rejects the connection if the certificate
993
+ * is expired, is not yet valid, or its chain/signature cannot be verified to a
994
+ * trusted root.
995
+ *
996
+ * Certificate-chain verification is separate from hostname matching and public
997
+ * key pinning. {@link MailMan.requireHostnameMatch}
998
+ * is enforced independently, even when this property is `_FALSE_`.
999
+ * {@link MailMan.tlsPinSet} supplements, rather than replaces,
1000
+ * certificate verification.
1001
+ *
1002
+ * The default value is `_FALSE_`. This property applies only to SSL/TLS
1003
+ * connections.
1004
+ */
1005
+ requireSslCertVerify: boolean
1006
+
1007
+ /**
1008
+ * Determines whether the email's `Date` header is reset to the current
1009
+ * date and time when an email is loaded.
1010
+ *
1011
+ * This applies to methods such as `LoadMbx`, `LoadEml`,
1012
+ * `LoadMime`, `LoadXml`, and `LoadXmlString`.
1013
+ *
1014
+ * The default value is `_FALSE_`.
1015
+ */
1016
+ resetDateOnLoad: boolean
1017
+
1018
+ /**
1019
+ * Sets the buffer size used by the underlying TCP/IP socket when sending
1020
+ * data.
1021
+ *
1022
+ * The default value is `32767`.
1023
+ */
1024
+ sendBufferSize: number
1025
+
1026
+ /**
1027
+ * Sets the maximum message size, in bytes, for POP3 operations that can download
1028
+ * one or more complete emails. It applies to any method capable of downloading a
1029
+ * full email and does not restrict header-only or partial-body retrieval.
1030
+ *
1031
+ * The default value is `0`, which means no size limit.
1032
+ *
1033
+ * For multi-message retrieval, a message larger than the limit is omitted from the
1034
+ * result. No placeholder `Email` is added for the skipped message, and
1035
+ * skipping an oversized message does not by itself cause the retrieval method to
1036
+ * fail.
1037
+ */
1038
+ sizeLimit: number
1039
+
1040
+ /**
1041
+ * Sets the SMTP authentication method to use.
1042
+ *
1043
+ * This property should usually be left empty so Chilkat can automatically
1044
+ * choose the most secure method advertised by the SMTP server.
1045
+ *
1046
+ * If the server does not advertise authentication methods, or if a specific
1047
+ * method must be forced, set this property to one of:
1048
+ * `NONE`, `LOGIN`, `PLAIN`,
1049
+ * `CRAM-MD5`, or `NTLM`.
1050
+ *
1051
+ * **Note:** If NTLM authentication fails, set
1052
+ * `Global.DefaultNtlmVersion = 1` and retry.
1053
+ */
1054
+ smtpAuthMethod: string
1055
+
1056
+ /**
1057
+ * Contains a keyword describing the result or failure reason for the last SMTP
1058
+ * operation.
1059
+ *
1060
+ * `Success`: The method succeeded.
1061
+ *
1062
+ * `Failed`: A general failure occurred.
1063
+ *
1064
+ * `NoValidRecipients`: The SMTP server rejected all recipients.
1065
+ *
1066
+ * `NoRecipients`: No To, CC, or BCC recipients were provided.
1067
+ *
1068
+ * `SomeBadRecipients`: {@link MailMan.allOrNone} is `true` and some recipients were rejected.
1069
+ *
1070
+ * `Aborted`: The application aborted the operation.
1071
+ *
1072
+ * `NoFrom`: No FROM address was provided.
1073
+ *
1074
+ * `FromFailure`: The server rejected the `MAIL FROM` command.
1075
+ *
1076
+ * `NoCredentials`: Required credentials were not provided.
1077
+ *
1078
+ * `AuthFailure`: SMTP authentication failed.
1079
+ *
1080
+ * `DataFailure`: The server returned an error in response to `DATA`.
1081
+ *
1082
+ * `NoSmtpHostname`: No SMTP hostname or IP address was provided.
1083
+ *
1084
+ * `StartTlsFailed`: Failed to upgrade the connection using STARTTLS.
1085
+ *
1086
+ * `ConnectFailed`: Could not establish the TCP or TLS connection.
1087
+ *
1088
+ * `GreetingError`: The SMTP server returned an error in the initial greeting.
1089
+ *
1090
+ * `ConnectionLost`: The SMTP connection was lost during the operation.
1091
+ *
1092
+ * `Timeout`: A socket read or write timeout occurred.
1093
+ *
1094
+ * `RenderFailed`: The email could not be rendered for sending.
1095
+ *
1096
+ * `NotUnlocked`: `UnlockBundle` was not called on at least one MailMan instance.
1097
+ *
1098
+ * `InternalFailure`: An internal failure occurred and should be reported to Chilkat support.
1099
+ *
1100
+ * This property is read-only.
1101
+ */
1102
+ readonly smtpFailReason: string
1103
+
1104
+ /**
1105
+ * Sets the SMTP server hostname or IP address.
1106
+ *
1107
+ * Do not include `http://` or `https://`. The value may be
1108
+ * a hostname, IPv4 address, or IPv6 address.
1109
+ */
1110
+ smtpHost: string
1111
+
1112
+ /**
1113
+ * Sets the Windows domain to use when logging in to an SMTP server with
1114
+ * NTLM authentication.
1115
+ *
1116
+ * Leave this property empty if no domain is required.
1117
+ */
1118
+ smtpLoginDomain: string
1119
+
1120
+ /**
1121
+ * Sets the password used for SMTP authentication.
1122
+ *
1123
+ * Chilkat supports
1124
+ * SMTP authentication methods such as `LOGIN`, `PLAIN`,
1125
+ * `CRAM-MD5`, and `NTLM`, and normally chooses the most
1126
+ * secure available method automatically.
1127
+ *
1128
+ * If NTLM authentication is used, {@link MailMan.smtpUsername} and
1129
+ * `SmtpPassword` may be set to the keyword `"default"` to use the
1130
+ * current Windows logged-on credentials.
1131
+ */
1132
+ smtpPassword: string
1133
+
1134
+ /**
1135
+ * Determines whether SMTP pipelining is used when the server advertises support
1136
+ * for it.
1137
+ *
1138
+ * The default value is `_TRUE_`.
1139
+ *
1140
+ * Set this property to `_FALSE_` to prevent SMTP pipelining. This is
1141
+ * required when using {@link MailMan.allOrNone}.
1142
+ */
1143
+ smtpPipelining: boolean
1144
+
1145
+ /**
1146
+ * Sets the SMTP server port.
1147
+ *
1148
+ * The default value is `25`. If using implicit SSL/TLS with
1149
+ * `SmtpSsl = _TRUE_`, the common port is `465`.
1150
+ */
1151
+ smtpPort: number
1152
+
1153
+ /**
1154
+ * Provides the accumulated raw SMTP commands sent to the server and raw
1155
+ * responses received from the server.
1156
+ *
1157
+ * This property is read-only. To clear it, call
1158
+ * {@link MailMan.clearSmtpSessionLog}.
1159
+ *
1160
+ * This property is read-only.
1161
+ */
1162
+ readonly smtpSessionLog: string
1163
+
1164
+ /**
1165
+ * Determines whether Chilkat uses implicit SSL/TLS when connecting to the SMTP
1166
+ * server.
1167
+ *
1168
+ * When set to `_TRUE_`, the TLS connection is established immediately
1169
+ * when the TCP connection is opened. Implicit SMTP TLS commonly uses port
1170
+ * `465`.
1171
+ *
1172
+ * Implicit TLS takes precedence over explicit TLS. Therefore, when
1173
+ * `SmtpSsl = _TRUE_`, the settings in
1174
+ * {@link MailMan.startTLS} and
1175
+ * {@link MailMan.startTLSifPossible} do not cause a
1176
+ * separate `STARTTLS` upgrade.
1177
+ *
1178
+ * The default value is `_FALSE_`. When
1179
+ * {@link MailMan.autoFix} is enabled, a standard SMTP port can
1180
+ * cause Chilkat to select the appropriate TLS mode automatically before
1181
+ * connecting.
1182
+ */
1183
+ smtpSsl: boolean
1184
+
1185
+ /**
1186
+ * Indicates whether the SMTP server certificate chain was successfully verified
1187
+ * during the most recent SSL/TLS SMTP connection.
1188
+ *
1189
+ * This property reports certificate-chain verification only. It does not report
1190
+ * hostname matching or public key pinning. When either of those checks is
1191
+ * required, a mismatch causes the connection itself to fail.
1192
+ *
1193
+ * This property is meaningful only after an SSL/TLS SMTP connection attempt.
1194
+ *
1195
+ * This property is read-only.
1196
+ */
1197
+ readonly smtpSslServerCertVerified: boolean
1198
+
1199
+ /**
1200
+ * Sets the username used for SMTP authentication.
1201
+ *
1202
+ * If {@link MailMan.smtpAuthMethod} is `NTLM`,
1203
+ * `SmtpUsername` and {@link MailMan.smtpPassword} may be set to the keyword
1204
+ * `"default"` to use the current Windows logged-on credentials.
1205
+ */
1206
+ smtpUsername: string
1207
+
1208
+ /**
1209
+ * Sets the socket receive buffer size.
1210
+ *
1211
+ * The default value is `4194304`.
1212
+ *
1213
+ * This property should normally be left unchanged. It may be increased if
1214
+ * download performance is slow. Values should preferably be multiples of
1215
+ * `4096`.
1216
+ */
1217
+ soRcvBuf: number
1218
+
1219
+ /**
1220
+ * Sets the socket send buffer size.
1221
+ *
1222
+ * The default value is `262144`.
1223
+ *
1224
+ * This property should normally be left unchanged. It may be increased if
1225
+ * upload performance is slow. Testing values such as `512K` or
1226
+ * `1MB` is reasonable. Values should preferably be multiples of
1227
+ * `4096`.
1228
+ */
1229
+ soSndBuf: number
1230
+
1231
+ /**
1232
+ * Sets the SOCKS4 or SOCKS5 proxy hostname or IPv4 address.
1233
+ *
1234
+ * This property is used only when {@link MailMan.socksVersion} is set to
1235
+ * `4` or `5`.
1236
+ */
1237
+ socksHostname: string
1238
+
1239
+ /**
1240
+ * Sets the SOCKS5 proxy password, if authentication is required.
1241
+ *
1242
+ * SOCKS4 does not use passwords, so this property applies only to SOCKS5.
1243
+ */
1244
+ socksPassword: string
1245
+
1246
+ /**
1247
+ * Sets the SOCKS proxy port.
1248
+ *
1249
+ * The default value is `1080`. This property applies only when
1250
+ * {@link MailMan.socksVersion} is set to `4` or `5`.
1251
+ */
1252
+ socksPort: number
1253
+
1254
+ /**
1255
+ * Sets the SOCKS4 or SOCKS5 proxy username.
1256
+ *
1257
+ * This property is used only when {@link MailMan.socksVersion} is set to
1258
+ * `4` or `5`.
1259
+ */
1260
+ socksUsername: string
1261
+
1262
+ /**
1263
+ * Specifies whether a SOCKS proxy is used.
1264
+ *
1265
+ * - `0` — no SOCKS proxy is used. This is the default.
1266
+ *
1267
+ * - `4` — connect through a SOCKS4 proxy.
1268
+ *
1269
+ * - `5` — connect through a SOCKS5 proxy.
1270
+ */
1271
+ socksVersion: number
1272
+
1273
+ /**
1274
+ * Sets the TLS cipher suites Chilkat is allowed to offer when establishing
1275
+ * SSL/TLS connections.
1276
+ *
1277
+ * The default value is an empty string, meaning Chilkat may offer all
1278
+ * implemented cipher suites. To restrict the allowed ciphers, set this property
1279
+ * to a comma-separated list of cipher suite names, ordered by preference.
1280
+ *
1281
+ * The cipher suites supported by Chilkat are:
1282
+ *
1283
+ * **TLS 1.3 Cipher Suites**
1284
+ *
1285
+ * - `TLS_AES_128_GCM_SHA256`
1286
+ *
1287
+ * - `TLS_CHACHA20_POLY1305_SHA256`
1288
+ *
1289
+ * - `TLS_AES_256_GCM_SHA384`
1290
+ *
1291
+ * **ChaCha20-Poly1305 Cipher Suites**
1292
+ *
1293
+ * - `TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256`
1294
+ *
1295
+ * - `TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256`
1296
+ *
1297
+ * - `TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256`
1298
+ *
1299
+ * **AES-GCM Cipher Suites**
1300
+ *
1301
+ * - `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256`
1302
+ *
1303
+ * - `TLS_DHE_RSA_WITH_AES_128_GCM_SHA256`
1304
+ *
1305
+ * - `TLS_RSA_WITH_AES_128_GCM_SHA256`
1306
+ *
1307
+ * - `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`
1308
+ *
1309
+ * - `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384`
1310
+ *
1311
+ * - `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384`
1312
+ *
1313
+ * - `TLS_RSA_WITH_AES_256_GCM_SHA384`
1314
+ *
1315
+ * - `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384`
1316
+ *
1317
+ * **AES-128 CBC Cipher Suites**
1318
+ *
1319
+ * - `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA`
1320
+ *
1321
+ * - `TLS_DHE_RSA_WITH_AES_128_CBC_SHA`
1322
+ *
1323
+ * - `TLS_RSA_WITH_AES_128_CBC_SHA`
1324
+ *
1325
+ * - `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`
1326
+ *
1327
+ * - `TLS_DHE_RSA_WITH_AES_128_CBC_SHA256`
1328
+ *
1329
+ * - `TLS_RSA_WITH_AES_128_CBC_SHA256`
1330
+ *
1331
+ * - `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA`
1332
+ *
1333
+ * - `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256`
1334
+ *
1335
+ * **AES-256 CBC Cipher Suites**
1336
+ *
1337
+ * - `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA`
1338
+ *
1339
+ * - `TLS_DHE_RSA_WITH_AES_256_CBC_SHA`
1340
+ *
1341
+ * - `TLS_RSA_WITH_AES_256_CBC_SHA`
1342
+ *
1343
+ * - `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256`
1344
+ *
1345
+ * - `TLS_RSA_WITH_AES_256_CBC_SHA256`
1346
+ *
1347
+ * - `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384`
1348
+ *
1349
+ * - `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA`
1350
+ *
1351
+ * - `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384`
1352
+ *
1353
+ * **Important:** The client offers a list of allowed cipher suites,
1354
+ * but the server chooses the final cipher suite from that list.
1355
+ *
1356
+ * This property can also include special keywords:
1357
+ *
1358
+ * - `rsa1024` — reject server certificates with RSA keys smaller than 1024 bits.
1359
+ *
1360
+ * - `rsa2048` — reject server certificates with RSA keys smaller than 2048 bits.
1361
+ *
1362
+ * - `secure-renegotiation` — require secure renegotiation as defined by RFC 5746.
1363
+ *
1364
+ * - `best-practices` — use Chilkat's current best-practice cipher policy.
1365
+ *
1366
+ * The `best-practices` setting currently requires RSA server keys of
1367
+ * at least 1024 bits, requires secure renegotiation, and disallows RC4, DES,
1368
+ * and 3DES ciphers.
1369
+ *
1370
+ * Example:
1371
+ *
1372
+ * `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024,
1373
+ * secure-renegotiation`
1374
+ */
1375
+ sslAllowedCiphers: string
1376
+
1377
+ /**
1378
+ * Selects the SSL/TLS protocol version used for secure SMTP and POP3
1379
+ * connections.
1380
+ *
1381
+ * Possible values include:
1382
+ *
1383
+ * - `default`
1384
+ *
1385
+ * - `TLS 1.3`
1386
+ *
1387
+ * - `TLS 1.2`
1388
+ *
1389
+ * - `TLS 1.1`
1390
+ *
1391
+ * - `TLS 1.0`
1392
+ *
1393
+ * - `SSL 3.0`
1394
+ *
1395
+ * - `TLS 1.3 or higher`
1396
+ *
1397
+ * - `TLS 1.2 or higher`
1398
+ *
1399
+ * - `TLS 1.1 or higher`
1400
+ *
1401
+ * - `TLS 1.0 or higher`
1402
+ *
1403
+ * The default value is `default`, which allows Chilkat to choose the
1404
+ * protocol dynamically based on the server's requirements.
1405
+ *
1406
+ * Choosing an exact protocol version can cause the connection to fail unless
1407
+ * that exact version is negotiated. In most cases, using an
1408
+ * `or higher` setting is preferable.
1409
+ */
1410
+ sslProtocol: string
1411
+
1412
+ /**
1413
+ * Determines whether Chilkat requires SMTP `STARTTLS`.
1414
+ *
1415
+ * When set to `_TRUE_`, Chilkat connects to the SMTP server normally and
1416
+ * then sends the `STARTTLS` command to upgrade the connection to TLS
1417
+ * before authenticating and sending email. The connection fails if the server
1418
+ * does not support the required upgrade.
1419
+ *
1420
+ * {@link MailMan.smtpSsl} takes precedence. If implicit TLS is
1421
+ * enabled, this property does not cause an additional explicit TLS upgrade.
1422
+ *
1423
+ * The default value is `_FALSE_`. Use
1424
+ * {@link MailMan.startTLSifPossible} when the upgrade
1425
+ * should be attempted only when the server advertises support.
1426
+ *
1427
+ * This property applies to SMTP only, not POP3.
1428
+ */
1429
+ startTLS: boolean
1430
+
1431
+ /**
1432
+ * Contains the current or most recently negotiated TLS cipher suite.
1433
+ *
1434
+ * If no TLS connection has been established, or if the TLS connection attempt
1435
+ * failed, this property is empty.
1436
+ *
1437
+ * Example value:
1438
+ *
1439
+ * `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256`
1440
+ *
1441
+ * This property is read-only.
1442
+ */
1443
+ readonly tlsCipherSuite: string
1444
+
1445
+ /**
1446
+ * Sets the expected Subject Public Key Info (SPKI) fingerprints for TLS public
1447
+ * key pinning.
1448
+ *
1449
+ * During the TLS handshake, Chilkat compares the server certificate's public key
1450
+ * fingerprint against this pin set. If none of the pins match, the connection
1451
+ * fails.
1452
+ *
1453
+ * Pinning supplements normal certificate-chain verification; it does not replace
1454
+ * it. A matching pin does not by itself make an expired or otherwise invalid
1455
+ * certificate acceptable.
1456
+ *
1457
+ * The format is:
1458
+ *
1459
+ * `hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...`
1460
+ *
1461
+ * Example with one SHA-256 Base64 pin:
1462
+ *
1463
+ * `sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE=`
1464
+ *
1465
+ * Example with two SHA-256 Base64 pins:
1466
+ *
1467
+ * `sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=,
1468
+ * 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs=`
1469
+ *
1470
+ * Supported hash algorithms include `sha1`, `sha256`,
1471
+ * `sha384`, `sha512`, `md2`, `md5`,
1472
+ * `haval`, `ripemd128`, `ripemd160`,
1473
+ * `ripemd256`, and `ripemd320`.
1474
+ *
1475
+ * Supported encodings include `base64`, `hex`, and other
1476
+ * Chilkat-supported encodings.
1477
+ */
1478
+ tlsPinSet: string
1479
+
1480
+ /**
1481
+ * Contains the current or most recently negotiated TLS protocol version.
1482
+ *
1483
+ * If no TLS connection has been established, or if the TLS connection attempt
1484
+ * failed, this property is empty.
1485
+ *
1486
+ * Possible values include `SSL 3.0`, `TLS 1.0`,
1487
+ * `TLS 1.1`, `TLS 1.2`, and `TLS 1.3`.
1488
+ *
1489
+ * This property is read-only.
1490
+ */
1491
+ readonly tlsVersion: string
1492
+
1493
+ /**
1494
+ * Determines whether Chilkat automatically uses APOP authentication when the POP3
1495
+ * server supports it.
1496
+ *
1497
+ * The default value is `_FALSE_`.
1498
+ */
1499
+ useApop: boolean
1500
+
1501
+ /**
1502
+ * Determines whether Chilkat attempts SMTP `STARTTLS` when the server
1503
+ * advertises support for it.
1504
+ *
1505
+ * If the server supports `STARTTLS`, the connection is upgraded to TLS.
1506
+ * Otherwise, the connection remains unencrypted.
1507
+ *
1508
+ * {@link MailMan.smtpSsl} takes precedence. If implicit TLS is
1509
+ * enabled, no separate `STARTTLS` upgrade is attempted. Use
1510
+ * `1 = _TRUE_` instead when encryption is
1511
+ * required and the connection should fail if explicit TLS is unavailable.
1512
+ *
1513
+ * The default value is `_TRUE_`. This property applies to SMTP only, not
1514
+ * POP3.
1515
+ */
1516
+ startTLSifPossible: boolean
1517
+
1518
+ /**
1519
+ * Provides a comma-separated list of uncommon option keywords.
1520
+ *
1521
+ * This property defaults to an empty string and should normally remain empty.
1522
+ *
1523
+ * -
1524
+ * `ProtectFromVpn` — introduced in v9.5.0.80. On Android, bypasses
1525
+ * any installed or active VPN.
1526
+ *
1527
+ * -
1528
+ * `SmtpLoginAnsi` — introduced in v9.5.0.97. Causes SMTP login and
1529
+ * password strings containing non-ASCII characters to be sent using ANSI
1530
+ * encoding instead of UTF-8. This restores the older Chilkat behavior for SMTP
1531
+ * servers that expect ANSI credentials.
1532
+ */
1533
+ uncommonOptions: string
1534
+
1535
+ /**
1536
+ * Provides the text associated with the most recent SMTP reply received from the server.
1537
+ *
1538
+ * Use this property together with {@link MailMan.lastSmtpStatus} when diagnosing an SMTP failure
1539
+ * or interpreting a server-specific response.
1540
+ *
1541
+ * This property is read-only.
1542
+ */
1543
+ readonly lastSmtpStatusMsg: string
1544
+
1545
+ /**
1546
+ * Determines whether Chilkat attempts POP3 `STLS` when the server
1547
+ * advertises support for it.
1548
+ *
1549
+ * If the server supports `STLS`, the connection is upgraded to TLS.
1550
+ * Otherwise, the connection remains unencrypted.
1551
+ *
1552
+ * {@link MailMan.popSsl} takes precedence. If implicit TLS is
1553
+ * enabled, no separate `STLS` upgrade is attempted. Use
1554
+ * `1 = _TRUE_` instead when encryption is
1555
+ * required and the connection should fail if explicit TLS is unavailable.
1556
+ *
1557
+ * The default value is `_FALSE_`.
1558
+ */
1559
+ pop3StlsIfPossible: boolean
1560
+
1561
+ /**
1562
+ * Sets the SMTP envelope sender address used in the
1563
+ * `MAIL FROM` command.
1564
+ *
1565
+ * This address receives bounce messages and identifies the originator of the
1566
+ * SMTP transaction. It may differ from the `From` MIME header.
1567
+ *
1568
+ * If left empty, Chilkat uses the email address from the message's
1569
+ * `From` header.
1570
+ *
1571
+ * SMTP servers may reject the envelope sender based on DNS, SPF, or other
1572
+ * server policy checks.
1573
+ */
1574
+ smtpMailFrom: string
1575
+
1576
+ /**
1577
+ * Enables automatic resolution of passwords and credentials from secure local
1578
+ * storage.
1579
+ *
1580
+ * When set to `_TRUE_`, supported properties and methods can accept a
1581
+ * Chilkat secret specification string instead of a literal password. Secret
1582
+ * specification strings begin with `!!`.
1583
+ *
1584
+ * Chilkat resolves secrets from:
1585
+ *
1586
+ * - Windows Credential Manager on Windows.
1587
+ *
1588
+ * - Apple Keychain on macOS.
1589
+ *
1590
+ * The secret specification format is: `!![appName|]service[|domain]|username`
1591
+ *
1592
+ * This applies to {@link MailMan.popPassword}, {@link MailMan.smtpPassword},
1593
+ * {@link MailMan.httpProxyPassword}, {@link MailMan.socksPassword},
1594
+ * {@link MailMan.popPasswordBase64}, and {@link MailMan.sshAuthenticatePw}.
1595
+ *
1596
+ * The default value is `_FALSE_`.
1597
+ */
1598
+ enableSecrets: boolean
1599
+
1600
+ /**
1601
+ * Determines whether the hostname used for the TLS connection must match a name
1602
+ * in the server certificate's Subject Alternative Name (SAN) extension.
1603
+ *
1604
+ * The comparison is made against the SNI hostname sent in the TLS handshake.
1605
+ * MailMan normally uses the configured server hostname. When connecting by IP
1606
+ * address or through an alternate endpoint, set
1607
+ * {@link MailMan.sniHostname} to the expected DNS hostname.
1608
+ *
1609
+ * Hostname matching is enforced independently of
1610
+ * {@link MailMan.requireSslCertVerify}. Therefore,
1611
+ * it still occurs when certificate-chain verification is not required.
1612
+ *
1613
+ * The default value is `_FALSE_`.
1614
+ */
1615
+ requireHostnameMatch: boolean
1616
+
1617
+ /**
1618
+ * Specifies the DNS hostname sent in the Server Name Indication (SNI) extension of the TLS
1619
+ * handshake for SMTP and POP3 connections.
1620
+ *
1621
+ * Normally this property is left empty. In that case, MailMan uses {@link MailMan.smtpHost} for
1622
+ * SMTP connections and {@link MailMan.mailHost} for POP3 connections.
1623
+ *
1624
+ * Set this property when connecting by IP address or through an alternate endpoint while the
1625
+ * server's TLS certificate and virtual-host configuration use a DNS hostname. The value is also
1626
+ * used for certificate hostname comparison when {@link MailMan.requireHostnameMatch} is `_TRUE_`.
1627
+ *
1628
+ * The default value is the empty string.
1629
+ */
1630
+ sniHostname: string
1631
+
1632
+ // ---- Methods ----
1633
+
1634
+ /**
1635
+ * Adds a PFX/PKCS#12 file to the MailMan object's internal list of sources used for locating
1636
+ * certificates and private keys.
1637
+ * The `ARG1` argument is the path to a `.pfx` or `.p12` file.
1638
+ *
1639
+ * The added PFX source is searched when Chilkat needs a certificate and private key
1640
+ * for operations such as:
1641
+ *
1642
+ * - Decrypting S/MIME encrypted email
1643
+ *
1644
+ * - Creating digitally signed email
1645
+ *
1646
+ * Multiple PFX sources can be added by calling this method once for each PFX.
1647
+ *
1648
+ * On Windows, the registry-based Windows certificate stores are automatically searched
1649
+ * when locating certificates and private keys. Therefore, if the required certificate
1650
+ * and private key are already installed in the Windows certificate store, explicitly
1651
+ * adding a PFX source is often unnecessary.
1652
+ *
1653
+ * On macOS, the Apple Keychain is also searched automatically. If the required
1654
+ * certificate and private key are already available in the Apple Keychain, it is
1655
+ * likewise unnecessary to explicitly add a PFX source.
1656
+ *
1657
+ * The `ARG2` argument specifies the password required to open the PFX.
1658
+ *
1659
+ * @throws Error if the call fails (the message names the reason); the full log is in
1660
+ * {@link MailMan.lastErrorText}.
1661
+ */
1662
+ addPfxSourceFile(pfxFilePath: string, password: string): void
1663
+
1664
+ /**
1665
+ * Returns the number of messages currently available in the POP3 mailbox. Returns
1666
+ * `-1` if an error occurs.
1667
+ *
1668
+ * If no POP3 session is active, Chilkat connects and authenticates automatically.
1669
+ * After a successful call, the POP3 session remains open and can be reused by
1670
+ * subsequent POP3 methods. Call {@link MailMan.pop3EndSession}
1671
+ * or {@link MailMan.pop3EndSessionNoQuit} to end it.
1672
+ *
1673
+ * If this method fails, use {@link MailMan.verifyPopConnection}
1674
+ * to test basic connectivity and {@link MailMan.verifyPopLogin}
1675
+ * to test authentication.
1676
+ *
1677
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1678
+ * {@link MailMan.checkMailAsync}.
1679
+ */
1680
+ checkMail(): number
1681
+
1682
+ /**
1683
+ * Asynchronous form of {@link MailMan.checkMail}: the same call on a native worker thread,
1684
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1685
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1686
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1687
+ */
1688
+ checkMailAsync(): Promise<number>
1689
+
1690
+ /**
1691
+ * Clears the current contents of the {@link MailMan.pop3SessionLog} property.
1692
+ */
1693
+ clearPop3SessionLog(): void
1694
+
1695
+ /**
1696
+ * Clears the current contents of the {@link MailMan.smtpSessionLog} property.
1697
+ */
1698
+ clearSmtpSessionLog(): void
1699
+
1700
+ /**
1701
+ * Explicitly closes the current SMTP connection. Before closing the socket connection, Chilkat
1702
+ * sends the SMTP
1703
+ * `QUIT` command to the server.
1704
+ *
1705
+ * Calling this method is optional in most applications. The MailMan object automatically opens an
1706
+ * SMTP connection when an
1707
+ * email-sending method is called and no connection is already open. The connection is then kept
1708
+ * open so subsequent sends
1709
+ * can reuse it. For example, if an application calls {@link MailMan.sendEmail} ten times, the
1710
+ * first call opens the SMTP
1711
+ * connection, and the following calls send over the same connection.
1712
+ *
1713
+ * If an SMTP-related property changes, such as the hostname, username, password, port, or SSL/TLS
1714
+ * settings, the existing
1715
+ * connection is closed and a new connection is established the next time an email-sending method
1716
+ * is called.
1717
+ *
1718
+ * The SMTP connection is also closed automatically when the MailMan object is destroyed.
1719
+ *
1720
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1721
+ * {@link MailMan.closeSmtpConnectionAsync}.
1722
+ *
1723
+ * @throws Error if the call fails (the message names the reason); the full log is in
1724
+ * {@link MailMan.lastErrorText}.
1725
+ */
1726
+ closeSmtpConnection(): void
1727
+
1728
+ /**
1729
+ * Asynchronous form of {@link MailMan.closeSmtpConnection}: the same call on a native worker
1730
+ * thread,
1731
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1732
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1733
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1734
+ *
1735
+ * The promise rejects with an Error if the call fails; the full log is in
1736
+ * {@link MailMan.lastErrorText}.
1737
+ */
1738
+ closeSmtpConnectionAsync(): Promise<void>
1739
+
1740
+ /**
1741
+ * Deletes POP3 messages by using the UIDLs stored in the `X-UIDL`
1742
+ * headers of the `Email` objects in `emailBundle`. An email that does not contain
1743
+ * an `X-UIDL` header is skipped.
1744
+ *
1745
+ * Chilkat processes the bundle and marks each located message with
1746
+ * `DELE`. If a connection failure occurs before processing is complete,
1747
+ * the POP3 session is lost and all uncommitted deletion marks are forgotten.
1748
+ *
1749
+ * If {@link MailMan.immediateDelete} is
1750
+ * `_TRUE_`, which is the default, Chilkat sends a single
1751
+ * `QUIT` after the entire bundle has been processed. This commits all
1752
+ * deletion marks and closes the POP3 session. If it is `_FALSE_`, the
1753
+ * marks remain pending until the application calls
1754
+ * {@link MailMan.pop3EndSession}.
1755
+ *
1756
+ * When making multiple deletion calls, it is usually more efficient to set
1757
+ * `ImmediateDelete` to `_FALSE_`, perform all deletion
1758
+ * operations, and call `Pop3EndSession` once at the end.
1759
+ *
1760
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1761
+ * {@link MailMan.deleteBundleAsync}.
1762
+ *
1763
+ * @throws Error if the call fails (the message names the reason); the full log is in
1764
+ * {@link MailMan.lastErrorText}.
1765
+ */
1766
+ deleteBundle(emailBundle: EmailBundle): void
1767
+
1768
+ /**
1769
+ * Asynchronous form of {@link MailMan.deleteBundle}: the same call on a native worker thread,
1770
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1771
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1772
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1773
+ *
1774
+ * The promise rejects with an Error if the call fails; the full log is in
1775
+ * {@link MailMan.lastErrorText}.
1776
+ */
1777
+ deleteBundleAsync(emailBundle: EmailBundle): Promise<void>
1778
+
1779
+ /**
1780
+ * Marks an email for deletion by its POP3 message number.
1781
+ *
1782
+ * **Important:** Message numbers are specific to a single POP3 session and can change from one
1783
+ * session to
1784
+ * the next. For example, if a mailbox contains ten messages, they are numbered `1` through `10`.
1785
+ * If message `1` is deleted and a new POP3 session is opened, the remaining messages are
1786
+ * renumbered
1787
+ * `1` through `9`.
1788
+ *
1789
+ * A POP3 session must already be established before this method is called, either explicitly by
1790
+ * calling
1791
+ * {@link MailMan.pop3BeginSession} or implicitly by calling another method that opens the
1792
+ * session. This method does not
1793
+ * automatically begin a new session because doing so could change the message numbers and cause
1794
+ * the application to delete
1795
+ * a different message than intended.
1796
+ *
1797
+ * This method only marks the message for deletion. The message is not removed from the POP3
1798
+ * mailbox until the session is
1799
+ * ended by calling {@link MailMan.pop3EndSession}, which sends the `QUIT` command.
1800
+ *
1801
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1802
+ * {@link MailMan.deleteByMsgnumAsync}.
1803
+ *
1804
+ * @throws Error if the call fails (the message names the reason); the full log is in
1805
+ * {@link MailMan.lastErrorText}.
1806
+ */
1807
+ deleteByMsgnum(msgnum: number): void
1808
+
1809
+ /**
1810
+ * Asynchronous form of {@link MailMan.deleteByMsgnum}: the same call on a native worker thread,
1811
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1812
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1813
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1814
+ *
1815
+ * The promise rejects with an Error if the call fails; the full log is in
1816
+ * {@link MailMan.lastErrorText}.
1817
+ */
1818
+ deleteByMsgnumAsync(msgnum: number): Promise<void>
1819
+
1820
+ /**
1821
+ * Marks the POP3 message identified by the UIDL in `uidl` for deletion. UIDLs are
1822
+ * preferred over message numbers because they remain stable across sessions while
1823
+ * the message remains in the mailbox.
1824
+ *
1825
+ * If {@link MailMan.immediateDelete} is
1826
+ * `_TRUE_`, which is the default, Chilkat sends `QUIT`, commits
1827
+ * the deletion, and closes the session before returning. If it is
1828
+ * `_FALSE_`, the message is only marked with `DELE`; call
1829
+ * {@link MailMan.pop3EndSession} to commit all pending
1830
+ * deletions.
1831
+ *
1832
+ * {@link MailMan.pop3Reset} or
1833
+ * {@link MailMan.pop3EndSessionNoQuit} cancels
1834
+ * uncommitted deletion marks.
1835
+ *
1836
+ * If no POP3 session is active, Chilkat connects and authenticates automatically.
1837
+ *
1838
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1839
+ * {@link MailMan.deleteByUidlAsync}.
1840
+ *
1841
+ * @throws Error if the call fails (the message names the reason); the full log is in
1842
+ * {@link MailMan.lastErrorText}.
1843
+ */
1844
+ deleteByUidl(uidl: string): void
1845
+
1846
+ /**
1847
+ * Asynchronous form of {@link MailMan.deleteByUidl}: the same call on a native worker thread,
1848
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1849
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1850
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1851
+ *
1852
+ * The promise rejects with an Error if the call fails; the full log is in
1853
+ * {@link MailMan.lastErrorText}.
1854
+ */
1855
+ deleteByUidlAsync(uidl: string): Promise<void>
1856
+
1857
+ /**
1858
+ * Deletes a POP3 message by using the UIDL stored in the `X-UIDL`
1859
+ * header of the `Email` in `email`. If `email` does not contain an
1860
+ * `X-UIDL` header, the method fails.
1861
+ *
1862
+ * If no POP3 session is active, Chilkat connects and authenticates automatically.
1863
+ * The UIDL is used to locate the corresponding message in the current mailbox.
1864
+ *
1865
+ * If {@link MailMan.immediateDelete} is
1866
+ * `_TRUE_`, which is the default, Chilkat marks the message for deletion,
1867
+ * sends `QUIT` to commit the deletion, and closes the POP3 session before
1868
+ * returning. If it is `_FALSE_`, the message is marked with
1869
+ * `DELE` and the deletion remains pending until
1870
+ * {@link MailMan.pop3EndSession} sends
1871
+ * `QUIT`.
1872
+ *
1873
+ * {@link MailMan.pop3Reset} or
1874
+ * {@link MailMan.pop3EndSessionNoQuit} cancels
1875
+ * uncommitted deletion marks. Uncommitted marks are also forgotten if the POP3
1876
+ * connection is lost before `QUIT` is sent.
1877
+ *
1878
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1879
+ * {@link MailMan.deleteEmailAsync}.
1880
+ *
1881
+ * @throws Error if the call fails (the message names the reason); the full log is in
1882
+ * {@link MailMan.lastErrorText}.
1883
+ */
1884
+ deleteEmail(email: Email): void
1885
+
1886
+ /**
1887
+ * Asynchronous form of {@link MailMan.deleteEmail}: the same call on a native worker thread,
1888
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1889
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1890
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1891
+ *
1892
+ * The promise rejects with an Error if the call fails; the full log is in
1893
+ * {@link MailMan.lastErrorText}.
1894
+ */
1895
+ deleteEmailAsync(email: Email): Promise<void>
1896
+
1897
+ /**
1898
+ * Returns the number of emails currently available in the POP3 mailbox. Returns `-1` if an error
1899
+ * occurs.
1900
+ *
1901
+ * This method is functionally identical to {@link MailMan.checkMail}.
1902
+ *
1903
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1904
+ * {@link MailMan.getMailboxCountAsync}.
1905
+ */
1906
+ getMailboxCount(): number
1907
+
1908
+ /**
1909
+ * Asynchronous form of {@link MailMan.getMailboxCount}: the same call on a native worker thread,
1910
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1911
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1912
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1913
+ */
1914
+ getMailboxCountAsync(): Promise<number>
1915
+
1916
+ /**
1917
+ * Returns an XML document containing information about the messages currently stored in the POP3
1918
+ * mailbox.
1919
+ *
1920
+ * The XML includes the UIDL and size, in bytes, for each message in the mailbox. This is useful
1921
+ * for scanning mailbox
1922
+ * state without downloading the full messages.
1923
+ *
1924
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1925
+ * {@link MailMan.getMailboxInfoXmlAsync}.
1926
+ *
1927
+ * @throws Error if the call fails (the message names the reason); the full log is in
1928
+ * {@link MailMan.lastErrorText}.
1929
+ */
1930
+ getMailboxInfoXml(): string
1931
+
1932
+ /**
1933
+ * Asynchronous form of {@link MailMan.getMailboxInfoXml}: the same call on a native worker
1934
+ * thread,
1935
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1936
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1937
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1938
+ *
1939
+ * The promise rejects with an Error if the call fails; the full log is in
1940
+ * {@link MailMan.lastErrorText}.
1941
+ */
1942
+ getMailboxInfoXmlAsync(): Promise<string>
1943
+
1944
+ /**
1945
+ * Returns the total combined size, in bytes, of all messages currently stored in
1946
+ * the POP3 mailbox. This is also known as the POP3 maildrop size.
1947
+ *
1948
+ * If no POP3 session is active, Chilkat connects and authenticates automatically.
1949
+ * After a successful call, the session remains open for reuse by subsequent POP3
1950
+ * methods.
1951
+ *
1952
+ * Returns `-1` on failure.
1953
+ *
1954
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1955
+ * {@link MailMan.getMailboxSizeAsync}.
1956
+ */
1957
+ getMailboxSize(): number
1958
+
1959
+ /**
1960
+ * Asynchronous form of {@link MailMan.getMailboxSize}: the same call on a native worker thread,
1961
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1962
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1963
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1964
+ */
1965
+ getMailboxSizeAsync(): Promise<number>
1966
+
1967
+ /**
1968
+ * Returns the size, in bytes, of the email on the POP3 server identified by `ARG1`. The size
1969
+ * includes the full
1970
+ * message content, including attachments.
1971
+ *
1972
+ * Returns `-1` if an error occurs.
1973
+ *
1974
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1975
+ * {@link MailMan.getSizeByUidlAsync}.
1976
+ */
1977
+ getSizeByUidl(uidl: string): number
1978
+
1979
+ /**
1980
+ * Asynchronous form of {@link MailMan.getSizeByUidl}: the same call on a native worker thread,
1981
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1982
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
1983
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
1984
+ */
1985
+ getSizeByUidlAsync(uidl: string): Promise<number>
1986
+
1987
+ /**
1988
+ * Contacts the SMTP server and determines whether it supports the DSN, or Delivery Status
1989
+ * Notification, extension defined
1990
+ * by RFC 3461.
1991
+ *
1992
+ * DSN support is used with properties such as {@link MailMan.dsnEnvid}, {@link
1993
+ * MailMan.dsnNotify}, and {@link MailMan.dsnRet}.
1994
+ * Returns `_TRUE_` if the SMTP server advertises DSN support, otherwise returns `_FALSE_`.
1995
+ *
1996
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1997
+ * {@link MailMan.isSmtpDsnCapableAsync}.
1998
+ */
1999
+ isSmtpDsnCapable(): boolean
2000
+
2001
+ /**
2002
+ * Asynchronous form of {@link MailMan.isSmtpDsnCapable}: the same call on a native worker thread,
2003
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2004
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2005
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2006
+ */
2007
+ isSmtpDsnCapableAsync(): Promise<boolean>
2008
+
2009
+ /**
2010
+ * Explicitly opens a connection to the SMTP server and authenticates if a username and password,
2011
+ * OAuth2 token, or other
2012
+ * applicable authentication settings have been provided.
2013
+ *
2014
+ * Calling this method is optional. Email-sending methods such as {@link MailMan.sendEmail}
2015
+ * automatically open and authenticate
2016
+ * the SMTP connection when needed.
2017
+ *
2018
+ * This method is equivalent to calling {@link MailMan.smtpConnect} followed by {@link
2019
+ * MailMan.smtpAuthenticate}.
2020
+ *
2021
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2022
+ * {@link MailMan.openSmtpConnectionAsync}.
2023
+ *
2024
+ * @throws Error if the call fails (the message names the reason); the full log is in
2025
+ * {@link MailMan.lastErrorText}.
2026
+ */
2027
+ openSmtpConnection(): void
2028
+
2029
+ /**
2030
+ * Asynchronous form of {@link MailMan.openSmtpConnection}: the same call on a native worker
2031
+ * thread,
2032
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2033
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2034
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2035
+ *
2036
+ * The promise rejects with an Error if the call fails; the full log is in
2037
+ * {@link MailMan.lastErrorText}.
2038
+ */
2039
+ openSmtpConnectionAsync(): Promise<void>
2040
+
2041
+ /**
2042
+ * Authenticates with the POP3 server using the current POP3 property settings, such as {@link
2043
+ * MailMan.popUsername},
2044
+ * {@link MailMan.popPassword}, and any authentication-related options.
2045
+ *
2046
+ * This method should be called only after a successful call to {@link MailMan.pop3Connect}. The
2047
+ * {@link MailMan.pop3BeginSession}
2048
+ * method performs both steps and is equivalent to calling {@link MailMan.pop3Connect} followed by
2049
+ * `Pop3Authenticate`.
2050
+ *
2051
+ * Calling this method is optional in most applications because POP3 methods that communicate with
2052
+ * the server automatically
2053
+ * connect and authenticate if no authenticated session is already open.
2054
+ *
2055
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2056
+ * {@link MailMan.pop3AuthenticateAsync}.
2057
+ *
2058
+ * @throws Error if the call fails (the message names the reason); the full log is in
2059
+ * {@link MailMan.lastErrorText}.
2060
+ */
2061
+ pop3Authenticate(): void
2062
+
2063
+ /**
2064
+ * Asynchronous form of {@link MailMan.pop3Authenticate}: the same call on a native worker thread,
2065
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2066
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2067
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2068
+ *
2069
+ * The promise rejects with an Error if the call fails; the full log is in
2070
+ * {@link MailMan.lastErrorText}.
2071
+ */
2072
+ pop3AuthenticateAsync(): Promise<void>
2073
+
2074
+ /**
2075
+ * Explicitly begins a POP3 session by connecting to the POP3 server and authenticating using the
2076
+ * current POP3 property
2077
+ * settings.
2078
+ *
2079
+ * Calling this method is optional. Any method that requires an established POP3 session
2080
+ * automatically connects and logs in
2081
+ * if a session is not already open.
2082
+ *
2083
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2084
+ * {@link MailMan.pop3BeginSessionAsync}.
2085
+ *
2086
+ * @throws Error if the call fails (the message names the reason); the full log is in
2087
+ * {@link MailMan.lastErrorText}.
2088
+ */
2089
+ pop3BeginSession(): void
2090
+
2091
+ /**
2092
+ * Asynchronous form of {@link MailMan.pop3BeginSession}: the same call on a native worker thread,
2093
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2094
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2095
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2096
+ *
2097
+ * The promise rejects with an Error if the call fails; the full log is in
2098
+ * {@link MailMan.lastErrorText}.
2099
+ */
2100
+ pop3BeginSessionAsync(): Promise<void>
2101
+
2102
+ /**
2103
+ * Explicitly connects to the POP3 server. If SSL/TLS is required by the current property
2104
+ * settings, the secure TLS channel
2105
+ * is established as part of this call. This method receives the server's initial greeting but
2106
+ * does not authenticate.
2107
+ *
2108
+ * After `Pop3Connect` succeeds, call {@link MailMan.pop3Authenticate} to log in. The {@link
2109
+ * MailMan.pop3BeginSession}
2110
+ * method performs both steps and is equivalent to calling `Pop3Connect` followed by
2111
+ * {@link MailMan.pop3Authenticate}.
2112
+ *
2113
+ * Calling this method is optional in most applications because POP3 methods that communicate with
2114
+ * the server automatically
2115
+ * connect and authenticate if no authenticated session is already open. When finished with the
2116
+ * POP3 server, call
2117
+ * {@link MailMan.pop3EndSession} or {@link MailMan.pop3EndSessionNoQuit} to disconnect.
2118
+ *
2119
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2120
+ * {@link MailMan.pop3ConnectAsync}.
2121
+ *
2122
+ * @throws Error if the call fails (the message names the reason); the full log is in
2123
+ * {@link MailMan.lastErrorText}.
2124
+ */
2125
+ pop3Connect(): void
2126
+
2127
+ /**
2128
+ * Asynchronous form of {@link MailMan.pop3Connect}: the same call on a native worker thread,
2129
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2130
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2131
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2132
+ *
2133
+ * The promise rejects with an Error if the call fails; the full log is in
2134
+ * {@link MailMan.lastErrorText}.
2135
+ */
2136
+ pop3ConnectAsync(): Promise<void>
2137
+
2138
+ /**
2139
+ * Sends the POP3 `QUIT` command and closes the current POP3 connection.
2140
+ *
2141
+ * Any messages marked for deletion during the session are permanently deleted when
2142
+ * the server accepts `QUIT`. After the session ends,
2143
+ * {@link MailMan.isPop3Connected} is
2144
+ * `_FALSE_` and {@link MailMan.pop3SessionId}
2145
+ * returns `0`.
2146
+ *
2147
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2148
+ * {@link MailMan.pop3EndSessionAsync}.
2149
+ *
2150
+ * @throws Error if the call fails (the message names the reason); the full log is in
2151
+ * {@link MailMan.lastErrorText}.
2152
+ */
2153
+ pop3EndSession(): void
2154
+
2155
+ /**
2156
+ * Asynchronous form of {@link MailMan.pop3EndSession}: the same call on a native worker thread,
2157
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2158
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2159
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2160
+ *
2161
+ * The promise rejects with an Error if the call fails; the full log is in
2162
+ * {@link MailMan.lastErrorText}.
2163
+ */
2164
+ pop3EndSessionAsync(): Promise<void>
2165
+
2166
+ /**
2167
+ * Closes the POP3 connection without sending the `QUIT` command.
2168
+ *
2169
+ * Pending deletion marks are not committed. Messages marked with `DELE`
2170
+ * during the session remain in the mailbox after reconnecting.
2171
+ *
2172
+ * Use {@link MailMan.pop3EndSession} when pending
2173
+ * deletions should be finalized.
2174
+ *
2175
+ * This method should always return `_TRUE_`.
2176
+ *
2177
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2178
+ * {@link MailMan.pop3EndSessionNoQuitAsync}.
2179
+ *
2180
+ * @throws Error if the call fails (the message names the reason); the full log is in
2181
+ * {@link MailMan.lastErrorText}.
2182
+ */
2183
+ pop3EndSessionNoQuit(): void
2184
+
2185
+ /**
2186
+ * Asynchronous form of {@link MailMan.pop3EndSessionNoQuit}: the same call on a native worker
2187
+ * thread,
2188
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2189
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2190
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2191
+ *
2192
+ * The promise rejects with an Error if the call fails; the full log is in
2193
+ * {@link MailMan.lastErrorText}.
2194
+ */
2195
+ pop3EndSessionNoQuitAsync(): Promise<void>
2196
+
2197
+ /**
2198
+ * Sends a POP3 `NOOP` command to the server.
2199
+ *
2200
+ * This can be useful for keeping a POP3 session alive or for verifying that the current POP3
2201
+ * connection is still open and
2202
+ * functioning.
2203
+ *
2204
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2205
+ * {@link MailMan.pop3NoopAsync}.
2206
+ *
2207
+ * @throws Error if the call fails (the message names the reason); the full log is in
2208
+ * {@link MailMan.lastErrorText}.
2209
+ */
2210
+ pop3Noop(): void
2211
+
2212
+ /**
2213
+ * Asynchronous form of {@link MailMan.pop3Noop}: the same call on a native worker thread,
2214
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2215
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2216
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2217
+ *
2218
+ * The promise rejects with an Error if the call fails; the full log is in
2219
+ * {@link MailMan.lastErrorText}.
2220
+ */
2221
+ pop3NoopAsync(): Promise<void>
2222
+
2223
+ /**
2224
+ * Sends the POP3 `RSET` command to the server.
2225
+ *
2226
+ * Any messages marked for deletion during the current session are unmarked and
2227
+ * remain in the mailbox. The POP3 session remains open after a successful reset.
2228
+ *
2229
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2230
+ * {@link MailMan.pop3ResetAsync}.
2231
+ *
2232
+ * @throws Error if the call fails (the message names the reason); the full log is in
2233
+ * {@link MailMan.lastErrorText}.
2234
+ */
2235
+ pop3Reset(): void
2236
+
2237
+ /**
2238
+ * Asynchronous form of {@link MailMan.pop3Reset}: the same call on a native worker thread,
2239
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2240
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2241
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2242
+ *
2243
+ * The promise rejects with an Error if the call fails; the full log is in
2244
+ * {@link MailMan.lastErrorText}.
2245
+ */
2246
+ pop3ResetAsync(): Promise<void>
2247
+
2248
+ /**
2249
+ * Sends a raw command to the POP3 server and returns the server's response.
2250
+ *
2251
+ * If `ARG1` contains non-US-ASCII characters, `ARG2` specifies the character set used to encode
2252
+ * the command before it is sent. Examples include `utf-8`, `ansi`, `iso-8859-1`, and
2253
+ * `Shift_JIS`.
2254
+ *
2255
+ * This method is intended for advanced use, diagnostics, or issuing POP3 commands not directly
2256
+ * exposed by higher-level
2257
+ * MailMan methods.
2258
+ *
2259
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2260
+ * {@link MailMan.pop3SendRawCommandAsync}.
2261
+ *
2262
+ * @throws Error if the call fails (the message names the reason); the full log is in
2263
+ * {@link MailMan.lastErrorText}.
2264
+ */
2265
+ pop3SendRawCommand(command: string, charset: string): string
2266
+
2267
+ /**
2268
+ * Asynchronous form of {@link MailMan.pop3SendRawCommand}: the same call on a native worker
2269
+ * thread,
2270
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2271
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2272
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2273
+ *
2274
+ * The promise rejects with an Error if the call fails; the full log is in
2275
+ * {@link MailMan.lastErrorText}.
2276
+ */
2277
+ pop3SendRawCommandAsync(command: string, charset: string): Promise<string>
2278
+
2279
+ /**
2280
+ * Sends a simple email to a single recipient without requiring the application to explicitly
2281
+ * create an `Email`
2282
+ * object.
2283
+ *
2284
+ * The `ARG1` argument is the sender address, `ARG2` is the recipient address,
2285
+ * `ARG3` is the message subject, `ARG4` is the plain-text body, and `ARG5` is the
2286
+ * SMTP server hostname.
2287
+ *
2288
+ * This method is convenient for simple cases. For attachments, HTML email, CC/BCC recipients,
2289
+ * alternate bodies, signing,
2290
+ * encryption, or more control over headers and SMTP behavior, create an `Email` object and use
2291
+ * {@link MailMan.sendEmail} instead.
2292
+ *
2293
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2294
+ * {@link MailMan.quickSendAsync}.
2295
+ *
2296
+ * @throws Error if the call fails (the message names the reason); the full log is in
2297
+ * {@link MailMan.lastErrorText}.
2298
+ */
2299
+ quickSend(fromAddr: string, toAddr: string, subject: string, body: string, smtpServer: string): void
2300
+
2301
+ /**
2302
+ * Asynchronous form of {@link MailMan.quickSend}: the same call on a native worker thread,
2303
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2304
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2305
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2306
+ *
2307
+ * The promise rejects with an Error if the call fails; the full log is in
2308
+ * {@link MailMan.lastErrorText}.
2309
+ */
2310
+ quickSendAsync(fromAddr: string, toAddr: string, subject: string, body: string, smtpServer: string): Promise<void>
2311
+
2312
+ /**
2313
+ * Renders the `Email` in `email` as the MIME text that would be sent to the
2314
+ * SMTP server, without actually sending the email.
2315
+ *
2316
+ * Rendering uses the current MailMan and `Email` settings and may include
2317
+ * MIME formatting, header encoding, replacement-pattern substitution, digital
2318
+ * signing, encryption, and other transformations required before transmission.
2319
+ *
2320
+ * This method does not modify `email`. Values generated as part of rendering are
2321
+ * produced for the returned MIME and are not written back to the supplied
2322
+ * `Email`. Repeated calls are not guaranteed to produce byte-for-byte
2323
+ * identical MIME.
2324
+ *
2325
+ * By default, a `Bcc` header present in `email` is included in the rendered
2326
+ * MIME. Add `NoBccHeader` to the `Email` object's
2327
+ * `UncommonOptions` property to omit the `Bcc` header from the
2328
+ * MIME.
2329
+ *
2330
+ * Conceptually, {@link MailMan.sendEmail} performs this
2331
+ * rendering step and then sends the resulting MIME.
2332
+ *
2333
+ * **Note:** If the MIME may contain 8-bit or binary data, use
2334
+ * `RenderToMimeBytes` or
2335
+ * {@link MailMan.renderToMimeBd}. Returning binary MIME
2336
+ * as a string can corrupt bytes that are not valid text.
2337
+ *
2338
+ * @throws Error if the call fails (the message names the reason); the full log is in
2339
+ * {@link MailMan.lastErrorText}.
2340
+ */
2341
+ renderToMime(email: Email): string
2342
+
2343
+ /**
2344
+ * Sends each email in `ARG1`. This is equivalent to calling {@link MailMan.sendEmail} once for
2345
+ * each email in the
2346
+ * bundle.
2347
+ *
2348
+ * If an error occurs while sending one email, Chilkat continues attempting to send the remaining
2349
+ * emails unless a fatal
2350
+ * error occurs that requires the send operation to stop.
2351
+ *
2352
+ * Because it can be difficult or impossible to programmatically determine exactly which emails
2353
+ * succeeded and which failed
2354
+ * after a bundle send, applications that need detailed per-message status should loop through the
2355
+ * bundle and call
2356
+ * {@link MailMan.sendEmail} for each message individually.
2357
+ *
2358
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2359
+ * {@link MailMan.sendBundleAsync}.
2360
+ *
2361
+ * @throws Error if the call fails (the message names the reason); the full log is in
2362
+ * {@link MailMan.lastErrorText}.
2363
+ */
2364
+ sendBundle(bundle: EmailBundle): void
2365
+
2366
+ /**
2367
+ * Asynchronous form of {@link MailMan.sendBundle}: the same call on a native worker thread,
2368
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2369
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2370
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2371
+ *
2372
+ * The promise rejects with an Error if the call fails; the full log is in
2373
+ * {@link MailMan.lastErrorText}.
2374
+ */
2375
+ sendBundleAsync(bundle: EmailBundle): Promise<void>
2376
+
2377
+ /**
2378
+ * Sends a single email through the configured SMTP server.
2379
+ *
2380
+ * Chilkat automatically opens the SMTP connection when needed. After the email is sent, the
2381
+ * connection remains open so a
2382
+ * subsequent call to `SendEmail` or another email-sending method can reuse the same SMTP
2383
+ * connection. If an
2384
+ * SMTP-related property changes, such as {@link MailMan.smtpHost}, {@link MailMan.smtpUsername},
2385
+ * password, port, or SSL/TLS
2386
+ * settings, Chilkat automatically closes the existing connection and establishes a new one using
2387
+ * the updated settings on
2388
+ * the next send.
2389
+ *
2390
+ * **Important:** Some SMTP servers do not complete final delivery processing until the SMTP
2391
+ * connection is
2392
+ * closed. In these cases, call {@link MailMan.closeSmtpConnection} after sending. Most SMTP
2393
+ * servers process the message
2394
+ * immediately, so explicitly closing the connection is usually not required.
2395
+ *
2396
+ * By default, a `Bcc` header in `email` is included in the MIME sent to the
2397
+ * SMTP server. To prevent Bcc addresses from appearing in the MIME header, add
2398
+ * `NoBccHeader` to the `Email` object's
2399
+ * `UncommonOptions` property.
2400
+ *
2401
+ * After sending, additional information about the SMTP transaction may be available by calling
2402
+ * {@link MailMan.getLastJsonData}.
2403
+ *
2404
+ * If this method fails, examine {@link MailMan.smtpFailReason} and {@link
2405
+ * MailMan.lastSmtpStatus}. The latter is nonzero only when Chilkat established an SMTP session
2406
+ * and received a failure status code from the server.
2407
+ *
2408
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2409
+ * {@link MailMan.sendEmailAsync}.
2410
+ *
2411
+ * @throws Error if the call fails (the message names the reason); the full log is in
2412
+ * {@link MailMan.lastErrorText}.
2413
+ */
2414
+ sendEmail(email: Email): void
2415
+
2416
+ /**
2417
+ * Asynchronous form of {@link MailMan.sendEmail}: the same call on a native worker thread,
2418
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2419
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2420
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2421
+ *
2422
+ * The promise rejects with an Error if the call fails; the full log is in
2423
+ * {@link MailMan.lastErrorText}.
2424
+ */
2425
+ sendEmailAsync(email: Email): Promise<void>
2426
+
2427
+ /**
2428
+ * Sends an email from caller-supplied MIME text. The MIME source in `ARG3` is passed to the SMTP
2429
+ * server
2430
+ * as the message content.
2431
+ *
2432
+ * This method provides complete control over the MIME that is sent. It is useful when the
2433
+ * application already has a fully
2434
+ * formed MIME message, or when the MIME was created externally and should not be rebuilt from an
2435
+ * `Email` object.
2436
+ *
2437
+ * The `ARG1` argument is the SMTP reverse-path address used in the `MAIL FROM` command. This is
2438
+ * where bounced email and non-delivery reports are normally delivered. It can be different from
2439
+ * the `From`
2440
+ * header in the MIME.
2441
+ *
2442
+ * `recipients` is a comma-separated list of plain email addresses used in SMTP
2443
+ * `RCPT TO` commands. Do not include display names or formatted mailbox
2444
+ * syntax; supply only addresses such as `alice@example.com,bob@example.com`.
2445
+ *
2446
+ * If this method fails, examine {@link MailMan.smtpFailReason} and {@link
2447
+ * MailMan.lastSmtpStatus}. The latter is nonzero only when Chilkat established an SMTP session
2448
+ * and received a failure status code from the server.
2449
+ *
2450
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2451
+ * {@link MailMan.sendMimeAsync}.
2452
+ *
2453
+ * @throws Error if the call fails (the message names the reason); the full log is in
2454
+ * {@link MailMan.lastErrorText}.
2455
+ */
2456
+ sendMime(fromAddr: string, recipients: string, mimeSource: string): void
2457
+
2458
+ /**
2459
+ * Asynchronous form of {@link MailMan.sendMime}: the same call on a native worker thread,
2460
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2461
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2462
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2463
+ *
2464
+ * The promise rejects with an Error if the call fails; the full log is in
2465
+ * {@link MailMan.lastErrorText}.
2466
+ */
2467
+ sendMimeAsync(fromAddr: string, recipients: string, mimeSource: string): Promise<void>
2468
+
2469
+ /**
2470
+ * Explicitly specifies the certificate to use when decrypting encrypted email.
2471
+ *
2472
+ * The certificate must correspond to the recipient certificate used to encrypt the message, and
2473
+ * the associated private key
2474
+ * must be available to Chilkat through the certificate itself, an added PFX source, an XML
2475
+ * certificate vault, or the
2476
+ * platform certificate store where applicable.
2477
+ *
2478
+ * @throws Error if the call fails (the message names the reason); the full log is in
2479
+ * {@link MailMan.lastErrorText}.
2480
+ */
2481
+ setDecryptCert(cert: Cert): void
2482
+
2483
+ /**
2484
+ * Explicitly specifies both the certificate and its associated private key to use when decrypting
2485
+ * S/MIME encrypted email.
2486
+ *
2487
+ * In most cases, it is simpler to call {@link MailMan.addPfxSourceFile} or `AddPfxSourceData` to
2488
+ * provide the
2489
+ * certificate and private key together in a PFX/PKCS#12 source. On Windows, if the certificate
2490
+ * and private key are already
2491
+ * installed in the default certificate store, no explicit setup may be needed because MailMan
2492
+ * automatically searches the
2493
+ * Windows certificate stores.
2494
+ *
2495
+ * @throws Error if the call fails (the message names the reason); the full log is in
2496
+ * {@link MailMan.lastErrorText}.
2497
+ */
2498
+ setDecryptCert2(cert: Cert, privateKey: PrivateKey): void
2499
+
2500
+ /**
2501
+ * Sets the client-side certificate to use for SSL/TLS connections.
2502
+ *
2503
+ * This is typically not required. Most SSL/TLS connections authenticate the server only, while
2504
+ * the client remains
2505
+ * unauthenticated at the TLS layer. Use this method only when the SMTP or POP3 server requires
2506
+ * TLS client certificate
2507
+ * authentication.
2508
+ *
2509
+ * @throws Error if the call fails (the message names the reason); the full log is in
2510
+ * {@link MailMan.lastErrorText}.
2511
+ */
2512
+ setSslClientCert(cert: Cert): void
2513
+
2514
+ /**
2515
+ * Sets the client-side certificate to use for SSL/TLS connections, loading it from PEM data or
2516
+ * from a PEM file.
2517
+ *
2518
+ * The `ARG1` argument may contain PEM text or the path to a PEM file. The
2519
+ * `ARG2` argument supplies the password if the PEM private key is encrypted.
2520
+ *
2521
+ * TLS client certificates are typically required only when the server uses mutual TLS. Most SMTP
2522
+ * and POP3 SSL/TLS
2523
+ * connections do not require a client certificate.
2524
+ *
2525
+ * @throws Error if the call fails (the message names the reason); the full log is in
2526
+ * {@link MailMan.lastErrorText}.
2527
+ */
2528
+ setSslClientCertPem(pemDataOrFilename: string, pemPassword: string): void
2529
+
2530
+ /**
2531
+ * Sets the client-side certificate to use for SSL/TLS connections, loading it from a PFX/PKCS#12
2532
+ * file.
2533
+ *
2534
+ * The `ARG1` argument is the path to the PFX file, and `ARG2` is the password required
2535
+ * to open it.
2536
+ *
2537
+ * TLS client certificates are typically required only when the server uses mutual TLS. Most SMTP
2538
+ * and POP3 SSL/TLS
2539
+ * connections do not require a client certificate.
2540
+ *
2541
+ * @throws Error if the call fails (the message names the reason); the full log is in
2542
+ * {@link MailMan.lastErrorText}.
2543
+ */
2544
+ setSslClientCertPfx(pfxPath: string, pfxPassword: string): void
2545
+
2546
+ /**
2547
+ * Authenticates with the SMTP server using the current SMTP property settings, such as {@link
2548
+ * MailMan.smtpUsername},
2549
+ * {@link MailMan.smtpPassword}, OAuth2 token settings, and other authentication-related options.
2550
+ *
2551
+ * This method should be called only after a successful call to {@link MailMan.smtpConnect}. The
2552
+ * {@link MailMan.openSmtpConnection} method performs both steps and is equivalent to calling
2553
+ * {@link MailMan.smtpConnect}
2554
+ * followed by `SmtpAuthenticate`.
2555
+ *
2556
+ * Calling this method is optional in most applications because SMTP methods that communicate with
2557
+ * the server, such as
2558
+ * {@link MailMan.sendEmail}, automatically connect and authenticate if no authenticated SMTP
2559
+ * connection is already open.
2560
+ *
2561
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2562
+ * {@link MailMan.smtpAuthenticateAsync}.
2563
+ *
2564
+ * @throws Error if the call fails (the message names the reason); the full log is in
2565
+ * {@link MailMan.lastErrorText}.
2566
+ */
2567
+ smtpAuthenticate(): void
2568
+
2569
+ /**
2570
+ * Asynchronous form of {@link MailMan.smtpAuthenticate}: the same call on a native worker thread,
2571
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2572
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2573
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2574
+ *
2575
+ * The promise rejects with an Error if the call fails; the full log is in
2576
+ * {@link MailMan.lastErrorText}.
2577
+ */
2578
+ smtpAuthenticateAsync(): Promise<void>
2579
+
2580
+ /**
2581
+ * Explicitly connects to the SMTP server. If SSL/TLS is required by the current property
2582
+ * settings, the secure TLS channel
2583
+ * is established as part of this call. This method receives the server's initial greeting but
2584
+ * does not authenticate.
2585
+ *
2586
+ * After `SmtpConnect` succeeds, call {@link MailMan.smtpAuthenticate} to authenticate. The
2587
+ * {@link MailMan.openSmtpConnection} method performs both steps and is equivalent to calling
2588
+ * `SmtpConnect`
2589
+ * followed by {@link MailMan.smtpAuthenticate}.
2590
+ *
2591
+ * Calling this method is optional in most applications because SMTP methods that communicate with
2592
+ * the server, such as
2593
+ * {@link MailMan.sendEmail}, automatically connect and authenticate if no authenticated SMTP
2594
+ * connection is already open.
2595
+ *
2596
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2597
+ * {@link MailMan.smtpConnectAsync}.
2598
+ *
2599
+ * @throws Error if the call fails (the message names the reason); the full log is in
2600
+ * {@link MailMan.lastErrorText}.
2601
+ */
2602
+ smtpConnect(): void
2603
+
2604
+ /**
2605
+ * Asynchronous form of {@link MailMan.smtpConnect}: the same call on a native worker thread,
2606
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2607
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2608
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2609
+ *
2610
+ * The promise rejects with an Error if the call fails; the full log is in
2611
+ * {@link MailMan.lastErrorText}.
2612
+ */
2613
+ smtpConnectAsync(): Promise<void>
2614
+
2615
+ /**
2616
+ * Sends an SMTP `NOOP` command to the server.
2617
+ *
2618
+ * This can be useful for testing whether the SMTP connection is working and still valid. If an
2619
+ * SMTP connection is not
2620
+ * already open, `SmtpNoop` automatically establishes the connection using the current SMTP
2621
+ * property settings.
2622
+ *
2623
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2624
+ * {@link MailMan.smtpNoopAsync}.
2625
+ *
2626
+ * @throws Error if the call fails (the message names the reason); the full log is in
2627
+ * {@link MailMan.lastErrorText}.
2628
+ */
2629
+ smtpNoop(): void
2630
+
2631
+ /**
2632
+ * Asynchronous form of {@link MailMan.smtpNoop}: the same call on a native worker thread,
2633
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2634
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2635
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2636
+ *
2637
+ * The promise rejects with an Error if the call fails; the full log is in
2638
+ * {@link MailMan.lastErrorText}.
2639
+ */
2640
+ smtpNoopAsync(): Promise<void>
2641
+
2642
+ /**
2643
+ * Sends an SMTP `RSET` command to the server.
2644
+ *
2645
+ * The `RSET` command resets the server-side state of the current SMTP transaction so the
2646
+ * connection can be used
2647
+ * to begin a new mail transaction. This method is rarely needed. It would normally only be useful
2648
+ * if a mail-sending method
2649
+ * failed and left the SMTP connection open in a non-initial state, a situation that should
2650
+ * generally not occur with the
2651
+ * Chilkat MailMan object.
2652
+ *
2653
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2654
+ * {@link MailMan.smtpResetAsync}.
2655
+ *
2656
+ * @throws Error if the call fails (the message names the reason); the full log is in
2657
+ * {@link MailMan.lastErrorText}.
2658
+ */
2659
+ smtpReset(): void
2660
+
2661
+ /**
2662
+ * Asynchronous form of {@link MailMan.smtpReset}: the same call on a native worker thread,
2663
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2664
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2665
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2666
+ *
2667
+ * The promise rejects with an Error if the call fails; the full log is in
2668
+ * {@link MailMan.lastErrorText}.
2669
+ */
2670
+ smtpResetAsync(): Promise<void>
2671
+
2672
+ /**
2673
+ * Sends a raw command to the SMTP server and returns the server's response.
2674
+ *
2675
+ * If `ARG1` contains non-US-ASCII characters, `ARG2` specifies the character set used to encode
2676
+ * the command before it is sent. Examples include `utf-8`, `ansi`, `iso-8859-1`, and
2677
+ * `Shift_JIS`.
2678
+ *
2679
+ * If `ARG3` is `_TRUE_`, the response is returned in Base64-encoded form. If
2680
+ * `ARG3` is `_FALSE_`, the raw response text is returned.
2681
+ *
2682
+ * This method is intended for advanced use, diagnostics, or issuing SMTP commands not directly
2683
+ * exposed by higher-level
2684
+ * MailMan methods.
2685
+ *
2686
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2687
+ * {@link MailMan.smtpSendRawCommandAsync}.
2688
+ *
2689
+ * @throws Error if the call fails (the message names the reason); the full log is in
2690
+ * {@link MailMan.lastErrorText}.
2691
+ */
2692
+ smtpSendRawCommand(command: string, charset: string, bEncodeBase64: boolean): string
2693
+
2694
+ /**
2695
+ * Asynchronous form of {@link MailMan.smtpSendRawCommand}: the same call on a native worker
2696
+ * thread,
2697
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2698
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2699
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2700
+ *
2701
+ * The promise rejects with an Error if the call fails; the full log is in
2702
+ * {@link MailMan.lastErrorText}.
2703
+ */
2704
+ smtpSendRawCommandAsync(command: string, charset: string, bEncodeBase64: boolean): Promise<string>
2705
+
2706
+ /**
2707
+ * Authenticates with the SSH server using public-key authentication after an SSH tunnel has been
2708
+ * opened.
2709
+ *
2710
+ * The `ARG1` argument is the SSH account name. The `ARG2` argument is the
2711
+ * `SshKey` containing the private key used for authentication. The matching public key
2712
+ * must already be installed for the SSH account on the server.
2713
+ *
2714
+ * An SSH tunneling session begins by calling {@link MailMan.sshOpenTunnel} to connect to the SSH
2715
+ * server, followed by either
2716
+ * `SshAuthenticatePk` or {@link MailMan.sshAuthenticatePw} to authenticate.
2717
+ *
2718
+ * After the SSH tunnel is established and authenticated, MailMan's underlying SMTP or POP3
2719
+ * communication uses the SSH
2720
+ * tunnel. No other programming changes are required beyond the initial tunnel setup calls.
2721
+ *
2722
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2723
+ * {@link MailMan.sshAuthenticatePkAsync}.
2724
+ *
2725
+ * @throws Error if the call fails (the message names the reason); the full log is in
2726
+ * {@link MailMan.lastErrorText}.
2727
+ */
2728
+ sshAuthenticatePk(sshLogin: string, privKey: SshKey): void
2729
+
2730
+ /**
2731
+ * Asynchronous form of {@link MailMan.sshAuthenticatePk}: the same call on a native worker
2732
+ * thread,
2733
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2734
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2735
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2736
+ *
2737
+ * The promise rejects with an Error if the call fails; the full log is in
2738
+ * {@link MailMan.lastErrorText}.
2739
+ */
2740
+ sshAuthenticatePkAsync(sshLogin: string, privKey: SshKey): Promise<void>
2741
+
2742
+ /**
2743
+ * Authenticates with the SSH server using an SSH username and password after an SSH tunnel has
2744
+ * been opened.
2745
+ *
2746
+ * The `ARG1` argument is the SSH account name, and `ARG2` is the corresponding SSH
2747
+ * password.
2748
+ *
2749
+ * An SSH tunneling session begins by calling {@link MailMan.sshOpenTunnel} to connect to the SSH
2750
+ * server, followed by either
2751
+ * `SshAuthenticatePw` or {@link MailMan.sshAuthenticatePk} to authenticate.
2752
+ *
2753
+ * After the SSH tunnel is established and authenticated, MailMan's underlying SMTP or POP3
2754
+ * communication uses the SSH
2755
+ * tunnel. No other programming changes are required beyond the initial tunnel setup calls.
2756
+ *
2757
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2758
+ * {@link MailMan.sshAuthenticatePwAsync}.
2759
+ *
2760
+ * @throws Error if the call fails (the message names the reason); the full log is in
2761
+ * {@link MailMan.lastErrorText}.
2762
+ */
2763
+ sshAuthenticatePw(sshLogin: string, sshPassword: string): void
2764
+
2765
+ /**
2766
+ * Asynchronous form of {@link MailMan.sshAuthenticatePw}: the same call on a native worker
2767
+ * thread,
2768
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2769
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2770
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2771
+ *
2772
+ * The promise rejects with an Error if the call fails; the full log is in
2773
+ * {@link MailMan.lastErrorText}.
2774
+ */
2775
+ sshAuthenticatePwAsync(sshLogin: string, sshPassword: string): Promise<void>
2776
+
2777
+ /**
2778
+ * Closes the SSH tunnel used for SMTP or POP3 communication.
2779
+ *
2780
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2781
+ * {@link MailMan.sshCloseTunnelAsync}.
2782
+ *
2783
+ * @throws Error if the call fails (the message names the reason); the full log is in
2784
+ * {@link MailMan.lastErrorText}.
2785
+ */
2786
+ sshCloseTunnel(): void
2787
+
2788
+ /**
2789
+ * Asynchronous form of {@link MailMan.sshCloseTunnel}: the same call on a native worker thread,
2790
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2791
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2792
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2793
+ *
2794
+ * The promise rejects with an Error if the call fails; the full log is in
2795
+ * {@link MailMan.lastErrorText}.
2796
+ */
2797
+ sshCloseTunnelAsync(): Promise<void>
2798
+
2799
+ /**
2800
+ * Connects to an SSH server and opens an SSH tunnel for MailMan's SMTP or POP3 connections.
2801
+ *
2802
+ * The `ARG1` argument is the hostname or IP address of the SSH server. The `ARG2` argument
2803
+ * is the SSH port, typically `22`.
2804
+ *
2805
+ * An SSH tunneling session begins by calling `SshOpenTunnel`, followed by either
2806
+ * {@link MailMan.sshAuthenticatePw} or {@link MailMan.sshAuthenticatePk} to authenticate.
2807
+ *
2808
+ * After the SSH tunnel is established and authenticated, MailMan's underlying SMTP or POP3
2809
+ * communication uses the SSH
2810
+ * tunnel. No other programming changes are required beyond the initial tunnel setup calls.
2811
+ *
2812
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2813
+ * {@link MailMan.sshOpenTunnelAsync}.
2814
+ *
2815
+ * @throws Error if the call fails (the message names the reason); the full log is in
2816
+ * {@link MailMan.lastErrorText}.
2817
+ */
2818
+ sshOpenTunnel(sshHostname: string, sshPort: number): void
2819
+
2820
+ /**
2821
+ * Asynchronous form of {@link MailMan.sshOpenTunnel}: the same call on a native worker thread,
2822
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2823
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2824
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2825
+ *
2826
+ * The promise rejects with an Error if the call fails; the full log is in
2827
+ * {@link MailMan.lastErrorText}.
2828
+ */
2829
+ sshOpenTunnelAsync(sshHostname: string, sshPort: number): Promise<void>
2830
+
2831
+ /**
2832
+ * Provides an XML certificate vault to be searched for certificates and private keys when MailMan
2833
+ * performs operations such
2834
+ * as encryption, decryption, signing, or signature verification.
2835
+ *
2836
+ * Unlike PFX sources added with `AddPfxSourceData`, {@link MailMan.addPfxSourceBd}, or
2837
+ * {@link MailMan.addPfxSourceFile}, only one XML certificate vault can be used at a time. If
2838
+ * `UseCertVault` is
2839
+ * called more than once, the most recent vault replaces the previously supplied vault.
2840
+ *
2841
+ * @throws Error if the call fails (the message names the reason); the full log is in
2842
+ * {@link MailMan.lastErrorText}.
2843
+ */
2844
+ useCertVault(vault: XmlCertVault): void
2845
+
2846
+ /**
2847
+ * Configures MailMan to use an existing SSH tunnel provided by the `Ssh` object in `ssh` for SMTP
2848
+ * and POP3 connections.
2849
+ *
2850
+ * This method is similar to {@link MailMan.useSshTunnel}, except the SSH tunnel is supplied in
2851
+ * `ssh`
2852
+ * rather than a `Socket` object.
2853
+ *
2854
+ * Sharing an existing SSH tunnel is useful when multiple objects need to communicate through the
2855
+ * same SSH connection. SSH
2856
+ * supports multiple logical channels within one tunnel, so SMTP and POP3 connections can exist
2857
+ * simultaneously as separate
2858
+ * SSH channels.
2859
+ *
2860
+ * @throws Error if the call fails (the message names the reason); the full log is in
2861
+ * {@link MailMan.lastErrorText}.
2862
+ */
2863
+ useSsh(ssh: Ssh): void
2864
+
2865
+ /**
2866
+ * Configures MailMan to use an existing SSH tunnel provided by a `Socket` object for SMTP and
2867
+ * POP3 connections.
2868
+ *
2869
+ * Sharing an existing SSH tunnel is useful when multiple objects need to communicate through the
2870
+ * same SSH connection. SSH
2871
+ * supports multiple logical channels within one tunnel, so SMTP and POP3 connections can exist
2872
+ * simultaneously as separate
2873
+ * SSH channels.
2874
+ *
2875
+ * @throws Error if the call fails (the message names the reason); the full log is in
2876
+ * {@link MailMan.lastErrorText}.
2877
+ */
2878
+ useSshTunnel(tunnel: Socket): void
2879
+
2880
+ /**
2881
+ * Tests whether a TCP/IP connection can be established with the configured POP3 server.
2882
+ *
2883
+ * This method verifies connectivity only. It does not prove that POP3 authentication will
2884
+ * succeed. Use
2885
+ * {@link MailMan.verifyPopLogin} to test both connection and login.
2886
+ *
2887
+ * Returns `_TRUE_` if the connection can be established, otherwise returns `_FALSE_`.
2888
+ *
2889
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2890
+ * {@link MailMan.verifyPopConnectionAsync}.
2891
+ */
2892
+ verifyPopConnection(): boolean
2893
+
2894
+ /**
2895
+ * Asynchronous form of {@link MailMan.verifyPopConnection}: the same call on a native worker
2896
+ * thread,
2897
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2898
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2899
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2900
+ */
2901
+ verifyPopConnectionAsync(): Promise<boolean>
2902
+
2903
+ /**
2904
+ * Tests whether Chilkat can connect to the configured POP3 server and successfully log in using
2905
+ * the current POP3
2906
+ * authentication settings.
2907
+ *
2908
+ * Use this method to diagnose whether POP3 credentials and authentication settings are correct.
2909
+ * If only the TCP/IP
2910
+ * connection needs to be tested, use {@link MailMan.verifyPopConnection}.
2911
+ *
2912
+ * Returns `_TRUE_` if the connection and login succeed, otherwise returns `_FALSE_`.
2913
+ *
2914
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2915
+ * {@link MailMan.verifyPopLoginAsync}.
2916
+ */
2917
+ verifyPopLogin(): boolean
2918
+
2919
+ /**
2920
+ * Asynchronous form of {@link MailMan.verifyPopLogin}: the same call on a native worker thread,
2921
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2922
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2923
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2924
+ */
2925
+ verifyPopLoginAsync(): Promise<boolean>
2926
+
2927
+ /**
2928
+ * Begins the SMTP send process for `ARG1`, sends the recipient addresses to the SMTP server, and
2929
+ * then aborts
2930
+ * before sending the message content. Recipient addresses rejected by the SMTP server are
2931
+ * returned in `ARG2`.
2932
+ *
2933
+ * This method can help identify addresses the SMTP server rejects during the SMTP `RCPT TO`
2934
+ * stage. However, it
2935
+ * cannot guarantee that all accepted addresses are valid. SMTP servers often accept addresses
2936
+ * outside their own domains
2937
+ * and only later discover delivery failures when relaying or delivering to the final destination.
2938
+ *
2939
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2940
+ * {@link MailMan.verifyRecipsAsync}.
2941
+ *
2942
+ * @throws Error if the call fails (the message names the reason); the full log is in
2943
+ * {@link MailMan.lastErrorText}.
2944
+ */
2945
+ verifyRecips(email: Email, badAddrs: StringArray): void
2946
+
2947
+ /**
2948
+ * Asynchronous form of {@link MailMan.verifyRecips}: the same call on a native worker thread,
2949
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2950
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2951
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2952
+ *
2953
+ * The promise rejects with an Error if the call fails; the full log is in
2954
+ * {@link MailMan.lastErrorText}.
2955
+ */
2956
+ verifyRecipsAsync(email: Email, badAddrs: StringArray): Promise<void>
2957
+
2958
+ /**
2959
+ * Tests whether a TCP/IP connection can be established with the configured SMTP server.
2960
+ *
2961
+ * This method verifies connectivity only. It does not prove that SMTP authentication will
2962
+ * succeed. Use
2963
+ * {@link MailMan.verifySmtpLogin} to test both connection and login.
2964
+ *
2965
+ * Returns `_TRUE_` if the connection can be established, otherwise returns `_FALSE_`.
2966
+ *
2967
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2968
+ * {@link MailMan.verifySmtpConnectionAsync}.
2969
+ */
2970
+ verifySmtpConnection(): boolean
2971
+
2972
+ /**
2973
+ * Asynchronous form of {@link MailMan.verifySmtpConnection}: the same call on a native worker
2974
+ * thread,
2975
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2976
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
2977
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
2978
+ */
2979
+ verifySmtpConnectionAsync(): Promise<boolean>
2980
+
2981
+ /**
2982
+ * Tests whether Chilkat can connect to the configured SMTP server and successfully authenticate
2983
+ * using the current SMTP
2984
+ * authentication settings.
2985
+ *
2986
+ * Use this method to diagnose whether SMTP credentials and authentication settings are correct.
2987
+ * If only the TCP/IP
2988
+ * connection needs to be tested, use {@link MailMan.verifySmtpConnection}.
2989
+ *
2990
+ * Returns `_TRUE_` if the connection and login succeed, otherwise returns `_FALSE_`.
2991
+ *
2992
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2993
+ * {@link MailMan.verifySmtpLoginAsync}.
2994
+ */
2995
+ verifySmtpLogin(): boolean
2996
+
2997
+ /**
2998
+ * Asynchronous form of {@link MailMan.verifySmtpLogin}: the same call on a native worker thread,
2999
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3000
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3001
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3002
+ */
3003
+ verifySmtpLoginAsync(): Promise<boolean>
3004
+
3005
+ /**
3006
+ * Renders the `Email` in `email` as MIME text and appends the result to `renderedMime`.
3007
+ *
3008
+ * This method is the `StringBuilder` version of
3009
+ * {@link MailMan.renderToMime}. Rendering does not modify
3010
+ * `email`; values generated for the rendered MIME are not written back to the
3011
+ * supplied `Email`.
3012
+ *
3013
+ * **Note:** If the MIME may contain 8-bit or binary content, use
3014
+ * `RenderToMimeBytes` or
3015
+ * {@link MailMan.renderToMimeBd} instead. Returning
3016
+ * binary MIME as text can corrupt data that is not valid text.
3017
+ *
3018
+ * @throws Error if the call fails (the message names the reason); the full log is in
3019
+ * {@link MailMan.lastErrorText}.
3020
+ */
3021
+ renderToMimeSb(email: Email, renderedMime: StringBuilder): void
3022
+
3023
+ /**
3024
+ * Renders the `Email` in `email` as MIME bytes and appends the result to
3025
+ * `renderedMime`.
3026
+ *
3027
+ * This method is the `BinData` version of
3028
+ * `RenderToMimeBytes`. It is useful
3029
+ * when the rendered MIME must be preserved as bytes, especially when it may
3030
+ * contain 8-bit or binary MIME content.
3031
+ *
3032
+ * Rendering does not modify `email`. Values generated for the rendered MIME are not
3033
+ * written back to the supplied `Email`.
3034
+ *
3035
+ * @throws Error if the call fails (the message names the reason); the full log is in
3036
+ * {@link MailMan.lastErrorText}.
3037
+ */
3038
+ renderToMimeBd(email: Email, renderedMime: BinData): void
3039
+
3040
+ /**
3041
+ * Sets the POP3 or SMTP password from a `SecureString`.
3042
+ *
3043
+ * The `ARG1` argument specifies which password is being set. Use `pop3` to set the POP3 password,
3044
+ * which is equivalent to setting the {@link MailMan.popPassword} property. Use `smtp` to set the
3045
+ * SMTP password,
3046
+ * which is equivalent to setting the {@link MailMan.smtpPassword} property.
3047
+ *
3048
+ * @throws Error if the call fails (the message names the reason); the full log is in
3049
+ * {@link MailMan.lastErrorText}.
3050
+ */
3051
+ setPassword(protocolName: string, password: SecureString): void
3052
+
3053
+ /**
3054
+ * Sends an email from caller-supplied MIME bytes contained in `ARG3`.
3055
+ *
3056
+ * This method is the `BinData` version of `SendMimeBytes`. It is useful when the MIME must be
3057
+ * sent
3058
+ * exactly as bytes, such as when it contains binary MIME content, 8bit encodings, or a
3059
+ * DKIM/DomainKey signature where byte
3060
+ * preservation matters.
3061
+ *
3062
+ * `fromAddr` is the SMTP reverse-path address used in the `MAIL FROM` command.
3063
+ * `recipients` is a comma-separated list of plain email addresses used in SMTP
3064
+ * `RCPT TO` commands. Do not include display names or formatted mailbox
3065
+ * syntax in `recipients`.
3066
+ *
3067
+ * If this method fails, examine {@link MailMan.smtpFailReason} and {@link
3068
+ * MailMan.lastSmtpStatus}. The latter is nonzero only when Chilkat established an SMTP session
3069
+ * and received a failure status code from the server.
3070
+ *
3071
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3072
+ * {@link MailMan.sendMimeBdAsync}.
3073
+ *
3074
+ * @throws Error if the call fails (the message names the reason); the full log is in
3075
+ * {@link MailMan.lastErrorText}.
3076
+ */
3077
+ sendMimeBd(fromAddr: string, recipients: string, mimeData: BinData): void
3078
+
3079
+ /**
3080
+ * Asynchronous form of {@link MailMan.sendMimeBd}: the same call on a native worker thread,
3081
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3082
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3083
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3084
+ *
3085
+ * The promise rejects with an Error if the call fails; the full log is in
3086
+ * {@link MailMan.lastErrorText}.
3087
+ */
3088
+ sendMimeBdAsync(fromAddr: string, recipients: string, mimeData: BinData): Promise<void>
3089
+
3090
+ /**
3091
+ * Fetches an email from the POP3 server by UIDL and stores the raw MIME source
3092
+ * bytes in `mimeData`.
3093
+ *
3094
+ * Chilkat clears the existing contents of `mimeData` before attempting the download. If
3095
+ * the method succeeds, `mimeData` contains the downloaded MIME bytes. If it fails, `mimeData`
3096
+ * remains empty.
3097
+ *
3098
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3099
+ * {@link MailMan.fetchMimeBdAsync}.
3100
+ *
3101
+ * @throws Error if the call fails (the message names the reason); the full log is in
3102
+ * {@link MailMan.lastErrorText}.
3103
+ */
3104
+ fetchMimeBd(uidl: string, mimeData: BinData): void
3105
+
3106
+ /**
3107
+ * Asynchronous form of {@link MailMan.fetchMimeBd}: the same call on a native worker thread,
3108
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3109
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3110
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3111
+ *
3112
+ * The promise rejects with an Error if the call fails; the full log is in
3113
+ * {@link MailMan.lastErrorText}.
3114
+ */
3115
+ fetchMimeBdAsync(uidl: string, mimeData: BinData): Promise<void>
3116
+
3117
+ /**
3118
+ * Copies into `json` any structured JSON details produced by the immediately preceding method
3119
+ * call.
3120
+ *
3121
+ * Not every MailMan method produces JSON details. Call this method immediately after the
3122
+ * operation of interest so the returned information corresponds to that operation.
3123
+ */
3124
+ getLastJsonData(json: JsonObject): void
3125
+
3126
+ /**
3127
+ * Gets the digital certificate presented by the SMTP or POP3 server for the current SSL/TLS
3128
+ * connection and stores it in
3129
+ * `ARG2`.
3130
+ *
3131
+ * If `ARG1` is `_TRUE_`, Chilkat returns the certificate for the SMTP connection. If
3132
+ * `ARG1` is `_FALSE_`, Chilkat returns the certificate for the POP3 connection.
3133
+ *
3134
+ * This method applies only when the current connection uses SSL/TLS.
3135
+ *
3136
+ * @throws Error if the call fails (the message names the reason); the full log is in
3137
+ * {@link MailMan.lastErrorText}.
3138
+ */
3139
+ getServerCert(useSmtp: boolean, cert: Cert): void
3140
+
3141
+ /**
3142
+ * Retrieves messages from the POP3 mailbox and appends them to the
3143
+ * `EmailBundle` in `bundle`. Existing emails in `bundle` are preserved.
3144
+ *
3145
+ * If `headersOnly` is `_TRUE_`, Chilkat retrieves the message headers and a partial
3146
+ * body. `numBodyLines` specifies the number of body lines; a value of `0` retrieves
3147
+ * the first body line. Attachments are not downloaded. If `headersOnly` is
3148
+ * `_FALSE_`, Chilkat retrieves the complete messages, including
3149
+ * attachments.
3150
+ *
3151
+ * If `keepOnServer` is `_TRUE_`, every retrieved message remains on the POP3 server,
3152
+ * regardless of {@link MailMan.immediateDelete}.
3153
+ *
3154
+ * If `keepOnServer` is `_FALSE_` and complete messages are retrieved, Chilkat sends
3155
+ * `DELE` for each message after it is downloaded. If
3156
+ * `ImmediateDelete = _TRUE_`, Chilkat sends `QUIT` only after the
3157
+ * entire requested set has been downloaded successfully; this commits the
3158
+ * deletions and closes the POP3 session. If
3159
+ * `ImmediateDelete = _FALSE_`, the deletion marks remain pending in the
3160
+ * open session until the application calls
3161
+ * {@link MailMan.pop3EndSession}.
3162
+ *
3163
+ * If the POP3 connection is lost before `QUIT`, the session ends and the
3164
+ * server forgets all uncommitted deletion marks. Chilkat automatically reconnects
3165
+ * and establishes a new session when the next POP3 method is called.
3166
+ *
3167
+ * Header-only or partial retrieval never marks messages for deletion, regardless
3168
+ * of `keepOnServer` or `ImmediateDelete`.
3169
+ *
3170
+ * {@link MailMan.maxCount} can limit the result to the newest
3171
+ * messages. {@link MailMan.sizeLimit} can omit oversized
3172
+ * messages from full-message retrieval.
3173
+ *
3174
+ * If an error occurs while retrieving multiple messages, processing stops at the
3175
+ * first failure. Messages that were successfully retrieved before the failure
3176
+ * remain appended to the output `EmailBundle`; Chilkat does not remove
3177
+ * those results or restore the bundle to its prior state.
3178
+ *
3179
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3180
+ * {@link MailMan.fetchAllAsync}.
3181
+ *
3182
+ * @throws Error if the call fails (the message names the reason); the full log is in
3183
+ * {@link MailMan.lastErrorText}.
3184
+ */
3185
+ fetchAll(keepOnServer: boolean, headersOnly: boolean, numBodyLines: number, bundle: EmailBundle): void
3186
+
3187
+ /**
3188
+ * Asynchronous form of {@link MailMan.fetchAll}: the same call on a native worker thread,
3189
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3190
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3191
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3192
+ *
3193
+ * The promise rejects with an Error if the call fails; the full log is in
3194
+ * {@link MailMan.lastErrorText}.
3195
+ */
3196
+ fetchAllAsync(keepOnServer: boolean, headersOnly: boolean, numBodyLines: number, bundle: EmailBundle): Promise<void>
3197
+
3198
+ /**
3199
+ * Retrieves a range of messages from the POP3 mailbox and appends them to the
3200
+ * `EmailBundle` in `bundle`. Existing emails in `bundle` are preserved.
3201
+ *
3202
+ * `startIndex` and `endIndex` are zero-based, inclusive indexes in the server's current mailbox
3203
+ * order. The messages are appended in increasing index order. If `endIndex` extends
3204
+ * past the end of the mailbox, Chilkat stops at the final message. If `startIndex` is
3205
+ * greater than `endIndex`, the method succeeds without appending any messages.
3206
+ *
3207
+ * If `headersOnly` is `_TRUE_`, Chilkat retrieves the message headers and a partial
3208
+ * body. `numBodyLines` specifies the number of body lines; a value of `0` retrieves
3209
+ * the first body line. Attachments are not downloaded. If `headersOnly` is
3210
+ * `_FALSE_`, Chilkat retrieves the complete messages, including
3211
+ * attachments.
3212
+ *
3213
+ * If `keepOnServer` is `_TRUE_`, every retrieved message remains on the POP3 server,
3214
+ * regardless of {@link MailMan.immediateDelete}.
3215
+ *
3216
+ * If `keepOnServer` is `_FALSE_` and complete messages are retrieved, Chilkat sends
3217
+ * `DELE` for each message after it is downloaded. If
3218
+ * `ImmediateDelete = _TRUE_`, Chilkat sends `QUIT` only after the
3219
+ * entire requested set has been downloaded successfully; this commits the
3220
+ * deletions and closes the POP3 session. If
3221
+ * `ImmediateDelete = _FALSE_`, the deletion marks remain pending in the
3222
+ * open session until the application calls
3223
+ * {@link MailMan.pop3EndSession}.
3224
+ *
3225
+ * If the POP3 connection is lost before `QUIT`, the session ends and the
3226
+ * server forgets all uncommitted deletion marks. Chilkat automatically reconnects
3227
+ * and establishes a new session when the next POP3 method is called.
3228
+ *
3229
+ * Header-only or partial retrieval never marks messages for deletion, regardless
3230
+ * of `keepOnServer` or `ImmediateDelete`.
3231
+ *
3232
+ * If an error occurs while retrieving multiple messages, processing stops at the
3233
+ * first failure. Messages that were successfully retrieved before the failure
3234
+ * remain appended to the output `EmailBundle`; Chilkat does not remove
3235
+ * those results or restore the bundle to its prior state.
3236
+ *
3237
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3238
+ * {@link MailMan.fetchRangeAsync}.
3239
+ *
3240
+ * @throws Error if the call fails (the message names the reason); the full log is in
3241
+ * {@link MailMan.lastErrorText}.
3242
+ */
3243
+ fetchRange(keepOnServer: boolean, headersOnly: boolean, numBodyLines: number, startIndex: number, endIndex: number, bundle: EmailBundle): void
3244
+
3245
+ /**
3246
+ * Asynchronous form of {@link MailMan.fetchRange}: the same call on a native worker thread,
3247
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3248
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3249
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3250
+ *
3251
+ * The promise rejects with an Error if the call fails; the full log is in
3252
+ * {@link MailMan.lastErrorText}.
3253
+ */
3254
+ fetchRangeAsync(keepOnServer: boolean, headersOnly: boolean, numBodyLines: number, startIndex: number, endIndex: number, bundle: EmailBundle): Promise<void>
3255
+
3256
+ /**
3257
+ * Retrieves one message by POP3 message number and stores it in the
3258
+ * `Email` in `email`. The first message has number `1`. The message
3259
+ * remains on the server.
3260
+ *
3261
+ * If `headerOnly` is `_TRUE_`, Chilkat retrieves the headers and a partial body.
3262
+ * `numBodyLines` specifies the number of body lines; a value of `0` retrieves the
3263
+ * first body line. Attachments are not downloaded. If `headerOnly` is
3264
+ * `_FALSE_`, Chilkat retrieves the complete message, including
3265
+ * attachments.
3266
+ *
3267
+ * If the message number is invalid or the fetch otherwise fails, `email` is left
3268
+ * unchanged.
3269
+ *
3270
+ * POP3 message numbers are specific to the current mailbox state and can change
3271
+ * between sessions. Use UIDLs when a message must be identified reliably across
3272
+ * sessions.
3273
+ *
3274
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3275
+ * {@link MailMan.fetchOneAsync}.
3276
+ *
3277
+ * @throws Error if the call fails (the message names the reason); the full log is in
3278
+ * {@link MailMan.lastErrorText}.
3279
+ */
3280
+ fetchOne(headerOnly: boolean, numBodyLines: number, msgNum: number, email: Email): void
3281
+
3282
+ /**
3283
+ * Asynchronous form of {@link MailMan.fetchOne}: the same call on a native worker thread,
3284
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3285
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3286
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3287
+ *
3288
+ * The promise rejects with an Error if the call fails; the full log is in
3289
+ * {@link MailMan.lastErrorText}.
3290
+ */
3291
+ fetchOneAsync(headerOnly: boolean, numBodyLines: number, msgNum: number, email: Email): Promise<void>
3292
+
3293
+ /**
3294
+ * Retrieves one message by UIDL and stores it in the `Email` in `email`. The
3295
+ * message remains on the POP3 server.
3296
+ *
3297
+ * If `headerOnly` is `_TRUE_`, Chilkat retrieves the headers and a partial body.
3298
+ * `numBodyLines` specifies the number of body lines; a value of `0` retrieves the
3299
+ * first body line. Attachments are not downloaded. If `headerOnly` is
3300
+ * `_FALSE_`, Chilkat retrieves the complete message, including
3301
+ * attachments.
3302
+ *
3303
+ * If `uidl` is not found or the fetch otherwise fails, `email` is left unchanged.
3304
+ *
3305
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3306
+ * {@link MailMan.fetchByUidlAsync}.
3307
+ *
3308
+ * @throws Error if the call fails (the message names the reason); the full log is in
3309
+ * {@link MailMan.lastErrorText}.
3310
+ */
3311
+ fetchByUidl(uidl: string, headerOnly: boolean, numBodyLines: number, email: Email): void
3312
+
3313
+ /**
3314
+ * Asynchronous form of {@link MailMan.fetchByUidl}: the same call on a native worker thread,
3315
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3316
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3317
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3318
+ *
3319
+ * The promise rejects with an Error if the call fails; the full log is in
3320
+ * {@link MailMan.lastErrorText}.
3321
+ */
3322
+ fetchByUidlAsync(uidl: string, headerOnly: boolean, numBodyLines: number, email: Email): Promise<void>
3323
+
3324
+ /**
3325
+ * Retrieves the messages whose UIDLs are listed in `uidls` and appends them to the
3326
+ * `EmailBundle` in `bundle`. Existing emails in `bundle` are preserved, and the
3327
+ * retrieved messages remain on the POP3 server.
3328
+ *
3329
+ * UIDLs are processed in the order in which they occur in `uidls`. A duplicate UIDL
3330
+ * causes the same message to be appended again. A UIDL that is not present in the
3331
+ * mailbox is ignored and does not by itself cause the method to fail.
3332
+ *
3333
+ * If `headersOnly` is `_TRUE_`, Chilkat retrieves the headers and a partial body.
3334
+ * `numBodyLines` specifies the number of body lines; a value of `0` retrieves the
3335
+ * first body line. Attachments are not downloaded. If `headersOnly` is
3336
+ * `_FALSE_`, Chilkat retrieves the complete messages, including
3337
+ * attachments.
3338
+ *
3339
+ * If an error occurs while retrieving multiple messages, processing stops at the
3340
+ * first failure. Messages that were successfully retrieved before the failure
3341
+ * remain appended to the output `EmailBundle`; Chilkat does not remove
3342
+ * those results or restore the bundle to its prior state.
3343
+ *
3344
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3345
+ * {@link MailMan.fetchUidlSetAsync}.
3346
+ *
3347
+ * @throws Error if the call fails (the message names the reason); the full log is in
3348
+ * {@link MailMan.lastErrorText}.
3349
+ */
3350
+ fetchUidlSet(uidls: StringTable, headersOnly: boolean, numBodyLines: number, bundle: EmailBundle): void
3351
+
3352
+ /**
3353
+ * Asynchronous form of {@link MailMan.fetchUidlSet}: the same call on a native worker thread,
3354
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3355
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3356
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3357
+ *
3358
+ * The promise rejects with an Error if the call fails; the full log is in
3359
+ * {@link MailMan.lastErrorText}.
3360
+ */
3361
+ fetchUidlSetAsync(uidls: StringTable, headersOnly: boolean, numBodyLines: number, bundle: EmailBundle): Promise<void>
3362
+
3363
+ /**
3364
+ * Downloads the complete version of the header-only or partial `Email`
3365
+ * in `partialEmail` and stores it in `fullEmail`. The full result includes the complete body and
3366
+ * any attachments.
3367
+ *
3368
+ * `partialEmail` must retain the UIDL needed to locate the same message in the POP3 mailbox.
3369
+ * The original POP3 session is not required; Chilkat connects and authenticates
3370
+ * automatically when a session is not already active.
3371
+ *
3372
+ * If the UIDL no longer exists in the mailbox, or if the full message cannot be
3373
+ * downloaded for another reason, the method fails and `fullEmail` remains unchanged.
3374
+ *
3375
+ * This method is useful when an application first retrieves headers or partial
3376
+ * bodies and downloads the complete message only after the user selects it.
3377
+ *
3378
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3379
+ * {@link MailMan.fetchFullAsync}.
3380
+ *
3381
+ * @throws Error if the call fails (the message names the reason); the full log is in
3382
+ * {@link MailMan.lastErrorText}.
3383
+ */
3384
+ fetchFull(partialEmail: Email, fullEmail: Email): void
3385
+
3386
+ /**
3387
+ * Asynchronous form of {@link MailMan.fetchFull}: the same call on a native worker thread,
3388
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3389
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3390
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3391
+ *
3392
+ * The promise rejects with an Error if the call fails; the full log is in
3393
+ * {@link MailMan.lastErrorText}.
3394
+ */
3395
+ fetchFullAsync(partialEmail: Email, fullEmail: Email): Promise<void>
3396
+
3397
+ /**
3398
+ * Loads emails from a `.mbx` mailbox file and stores them in `ARG2`.
3399
+ *
3400
+ * If a filter has been configured, only the emails matching the filter are returned.
3401
+ *
3402
+ * @throws Error if the call fails (the message names the reason); the full log is in
3403
+ * {@link MailMan.lastErrorText}.
3404
+ */
3405
+ loadMbxFile(mbxPath: string, bundle: EmailBundle): void
3406
+
3407
+ /**
3408
+ * Retrieves the UIDLs of the messages currently stored in the POP3 mailbox and
3409
+ * stores them in `uidls`. The UIDLs are returned in the server's current mailbox
3410
+ * order, with one entry for each message.
3411
+ *
3412
+ * A POP3 UIDL, or Unique ID Listing, is a persistent identifier assigned by the
3413
+ * mail server. Unlike POP3 message numbers, which can change between sessions, a
3414
+ * UIDL remains stable for as long as the message remains in the mailbox.
3415
+ *
3416
+ * If no POP3 session is active, Chilkat connects and authenticates automatically.
3417
+ * After a successful call, the session remains open for reuse by subsequent POP3
3418
+ * methods.
3419
+ *
3420
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3421
+ * {@link MailMan.fetchUidlsAsync}.
3422
+ *
3423
+ * @throws Error if the call fails (the message names the reason); the full log is in
3424
+ * {@link MailMan.lastErrorText}.
3425
+ */
3426
+ fetchUidls(uidls: StringTable): void
3427
+
3428
+ /**
3429
+ * Asynchronous form of {@link MailMan.fetchUidls}: the same call on a native worker thread,
3430
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3431
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3432
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3433
+ *
3434
+ * The promise rejects with an Error if the call fails; the full log is in
3435
+ * {@link MailMan.lastErrorText}.
3436
+ */
3437
+ fetchUidlsAsync(uidls: StringTable): Promise<void>
3438
+
3439
+ /**
3440
+ * Adds a PFX/PKCS#12 certificate store to the MailMan object's internal list of
3441
+ * sources used for locating certificates and private keys.
3442
+ *
3443
+ * `bd` is a `BinData` object containing the bytes of a `.pfx` or `.p12` file.
3444
+ *
3445
+ * The added PFX source is searched when Chilkat needs a certificate and private key
3446
+ * for operations such as:
3447
+ *
3448
+ * - Decrypting S/MIME encrypted email
3449
+ *
3450
+ * - Creating digitally signed email
3451
+ *
3452
+ * Multiple PFX sources can be added by calling this method once for each PFX.
3453
+ *
3454
+ * On Windows, the registry-based Windows certificate stores are automatically searched
3455
+ * when locating certificates and private keys. Therefore, if the required certificate
3456
+ * and private key are already installed in the Windows certificate store, explicitly
3457
+ * adding a PFX source is often unnecessary.
3458
+ *
3459
+ * On macOS, the Apple Keychain is also searched automatically. If the required
3460
+ * certificate and private key are already available in the Apple Keychain, it is
3461
+ * likewise unnecessary to explicitly add a PFX source.
3462
+ *
3463
+ * `password` specifies the password required to open the PFX.
3464
+ *
3465
+ * @throws Error if the call fails (the message names the reason); the full log is in
3466
+ * {@link MailMan.lastErrorText}.
3467
+ */
3468
+ addPfxSourceBd(bd: BinData, password: string): void
3469
+
3470
+ /**
3471
+ * Retrieves an email by POP3 message number and stores the raw MIME source bytes in `ARG2`.
3472
+ *
3473
+ * Chilkat clears the existing contents of `bd` before attempting the download. If
3474
+ * the method succeeds, `bd` contains the downloaded MIME bytes. If it fails, `bd`
3475
+ * remains empty.
3476
+ *
3477
+ * **Important:** Message numbers are specific to a single POP3 session and can change from one
3478
+ * session to
3479
+ * the next. For example, if a mailbox contains ten messages, they are numbered `1` through `10`.
3480
+ * If message `1` is deleted and a new POP3 session is opened, the remaining messages are
3481
+ * renumbered
3482
+ * `1` through `9`.
3483
+ *
3484
+ * A POP3 session must already be established before this method is called, either explicitly by
3485
+ * calling
3486
+ * {@link MailMan.pop3BeginSession} or implicitly by calling another method that opens the
3487
+ * session. This method does not
3488
+ * automatically begin a new POP3 session because doing so could change the message numbers.
3489
+ *
3490
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3491
+ * {@link MailMan.fetchMimeByMsgnumBdAsync}.
3492
+ *
3493
+ * @throws Error if the call fails (the message names the reason); the full log is in
3494
+ * {@link MailMan.lastErrorText}.
3495
+ */
3496
+ fetchMimeByMsgnumBd(msgnum: number, bd: BinData): void
3497
+
3498
+ /**
3499
+ * Asynchronous form of {@link MailMan.fetchMimeByMsgnumBd}: the same call on a native worker
3500
+ * thread,
3501
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3502
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3503
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3504
+ *
3505
+ * The promise rejects with an Error if the call fails; the full log is in
3506
+ * {@link MailMan.lastErrorText}.
3507
+ */
3508
+ fetchMimeByMsgnumBdAsync(msgnum: number, bd: BinData): Promise<void>
3509
+
3510
+ /**
3511
+ * Marks the POP3 messages whose UIDLs are listed in `stUidls` for deletion.
3512
+ *
3513
+ * Chilkat processes the UIDL set and sends `DELE` for each located
3514
+ * message. If a connection failure occurs before processing is complete, the POP3
3515
+ * session is lost and all uncommitted deletion marks are forgotten.
3516
+ *
3517
+ * If {@link MailMan.immediateDelete} is
3518
+ * `_TRUE_`, which is the default, Chilkat sends a single
3519
+ * `QUIT` after the entire set has been processed. This commits all
3520
+ * deletion marks and closes the POP3 session. If it is `_FALSE_`, the
3521
+ * marks remain pending until the application calls
3522
+ * {@link MailMan.pop3EndSession}.
3523
+ *
3524
+ * When making multiple deletion calls, it is usually more efficient to set
3525
+ * `ImmediateDelete` to `_FALSE_`, perform all deletion
3526
+ * operations, and call `Pop3EndSession` once at the end.
3527
+ *
3528
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3529
+ * {@link MailMan.deleteUidlSetAsync}.
3530
+ *
3531
+ * @throws Error if the call fails (the message names the reason); the full log is in
3532
+ * {@link MailMan.lastErrorText}.
3533
+ */
3534
+ deleteUidlSet(stUidls: StringTable): void
3535
+
3536
+ /**
3537
+ * Asynchronous form of {@link MailMan.deleteUidlSet}: the same call on a native worker thread,
3538
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3539
+ * except {@link MailMan.abort} (which cancels it) and the {@link MailMan.onPercentDone} /
3540
+ * {@link MailMan.onProgressInfo} callbacks, which report progress while it runs.
3541
+ *
3542
+ * The promise rejects with an Error if the call fails; the full log is in
3543
+ * {@link MailMan.lastErrorText}.
3544
+ */
3545
+ deleteUidlSetAsync(stUidls: StringTable): Promise<void>
3546
+
3547
+ // ---- Events (ReactNativeGen_DESIGN.md §6) ----
3548
+
3549
+ /**
3550
+ * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
3551
+ * can measure progress. Runs on the JavaScript thread, so it is only useful with the
3552
+ * `...Async` methods (during a synchronous call the thread is busy and the events arrive
3553
+ * after it returns). Assign `undefined` to remove.
3554
+ */
3555
+ onPercentDone?: (pctDone: number) => void
3556
+
3557
+ /**
3558
+ * Called with a name/value pair of progress information while a long-running method runs
3559
+ * (what is reported depends on the class and method). Runs on the JavaScript thread; see
3560
+ * {@link MailMan.onPercentDone}. Assign `undefined` to remove.
3561
+ */
3562
+ onProgressInfo?: (name: string, value: string) => void
3563
+
3564
+ /**
3565
+ * Requests that the pending `...Async` call on this object stop at its next progress check.
3566
+ * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
3567
+ * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
3568
+ * for a responsive cancel. Harmless when nothing is pending.
3569
+ */
3570
+ abort(): void
3571
+ }