readme: note xoauth* values must be base64-encoded

11 years ago · 46d9b8577d
parent 977484ce7e
commit 46d9b8577d
1 changed files with 2 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -375,8 +375,8 @@ Connection Instance Methods

    * **user** - < _string_ > - Username for plain-text authentication.
    * **password** - < _string_ > - Password for plain-text authentication.
-    * **xoauth** - < _string_ > - OAuth token for [OAuth authentication](https://sites.google.com/site/oauthgoog/Home/oauthimap) for servers that support it (See Andris Reinman's [xoauth.js](https://github.com/andris9/inbox/blob/master/lib/xoauth.js) module to help generate this string).
-    * **xoauth2** - < _string_ > - OAuth2 token for [The SASL XOAUTH2 Mechanism](https://developers.google.com/google-apps/gmail/xoauth2_protocol#the_sasl_xoauth2_mechanism) for servers that support it (See Andris Reinman's [xoauth2](https://github.com/andris9/xoauth2) module to help generate this string).
+    * **xoauth** - < _string_ > - Base64-encoded OAuth token for [OAuth authentication](https://sites.google.com/site/oauthgoog/Home/oauthimap) for servers that support it (See Andris Reinman's [xoauth.js](https://github.com/andris9/inbox/blob/master/lib/xoauth.js) module to help generate this string).
+    * **xoauth2** - < _string_ > - Base64-encoded OAuth2 token for [The SASL XOAUTH2 Mechanism](https://developers.google.com/google-apps/gmail/xoauth2_protocol#the_sasl_xoauth2_mechanism) for servers that support it (See Andris Reinman's [xoauth2](https://github.com/andris9/xoauth2) module to help generate this string).
    * **host** - < _string_ > - Hostname or IP address of the IMAP server. **Default:** "localhost"
    * **port** - < _integer_ > - Port number of the IMAP server. **Default:** 143
    * **tls** - < _boolean_ > - Perform implicit TLS connection? **Default:** false