network-diagnostics - npm Package Compare versions

Comparing version 0.3.1 to 0.3.2

package.json

 {
   "name": "network-diagnostics",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Performs diagnostics on the network to determine network problems.",
@@ -5,0 +5,0 @@ "main": "diagnostics.js",

README.md

@@ -142,2 +142,33 @@ #network-diagnostics
 
+### diagnostics.haveInsecureImap and diagnostics.haveSecureImap
+These functions check if IMAP is usable, with and without security. Callback based. Note: These functions are not in the standard test procedure, because they need accounts. Because they need accounts, you should probably have a dedicated diagnostics account which has almost no rights, since this can result in leaked passwords.
+
+```
+var config = {
+	user: "[e-mail]",
+	password: "jerlita",
+	host: "imap.gmail.com",
+};
+var checkInsecureImap = diagnostics.haveInsecureImap(config, function(result) {
+	if (result == true) {
+		console.log("insecure imap works");
+	} else {
+		console.log("insecure imap does not work");
+	}
+});
+var checkSecureImap = diagnostics.haveSecureImap(config, function(result) {
+	if (result == true) {
+		console.log("secure imap works");
+	} else {
+		console.log("secure imap does not work");
+	}
+});
+```
+
+#### config specification
+* user: Mandatory, account name.
+* password: default is "".
+* host: default is "localhost".
+* port: default is 143 or 993 depending on the enabling of security.
+
 ##Standardized Test
@@ -173,3 +204,5 @@ This function performs every network test in the script that does not require any complex input from the user. Tests that require complex input must be run explicitly. It then returns the results as a number array in a callback function.
 | 80  | "NoHTTPconnection"         |
+| 143 | "NoInsecureIMAP"           |
 | 443 | "NoHTTPSconnection"        |
+| 993 | "NoSecureIMAP"             |
 
@@ -189,6 +222,4 @@ These error codes are going to be used in the future when tests are written for them. Until that point, they are not directly usable.
 | 110 | "NoInsecurePOP3"      |
-| 143 | "NoInsecureIMAP"      |
 | 161 | "NoSNMP"              |
 | 194 | "NoIRC"               |
-| 993 | "NoSecureIMAP"        |
 | 995 | "NoSecurePOP3"        |

No alert changes

Improved metrics

Total package byte prevSize

17027

increased by7.08%

Number of lines in readme file

223

increased by16.15%

No dependency changes