From b8689f83359cda76659c41cb18aaf8718387972b Mon Sep 17 00:00:00 2001 From: Brian White Date: Mon, 10 Sep 2012 19:43:29 -0400 Subject: [PATCH] Document debug config option --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 471cc5c..693eee7 100644 --- a/README.md +++ b/README.md @@ -350,6 +350,8 @@ ImapConnection Functions * **connTimeout** - <_integer_> - Number of milliseconds to wait for a connection to be established. **Default:** 10000 + * **debug** - <_function_> - If set, the function will be called with one argument, a string containing some debug info **Default:** + * **connect**(<_function_>callback) - _(void)_ - Attempts to connect and log into the IMAP server. The callback has one parameter: the error (falsey if none). * **logout**(<_function_>callback) - _(void)_ - Closes the connection to the server.