From b27e3ccca64141691fbdf77201f8bbbad71b3245 Mon Sep 17 00:00:00 2001 From: Rupert Bogensperger <47078678+Rupert-com@users.noreply.github.com> Date: Wed, 14 Jul 2021 06:24:27 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/README.md b/README.md index 05afb60..1a95935 100644 --- a/README.md +++ b/README.md @@ -60,15 +60,6 @@ Note that all instance methods throw an error when something goes wrong or when | username | String | No | - | Authentication username. | password | String | No | - | Authentication password. -**SMTPClient.prototype.authPlain({username, password})**:Promise; - -> Sends AUTH PLAIN command to the server and authenticates. - -| Option | Type | Required | Default | Description -|--------|------|----------|---------|------------ -| username | String | No | - | Authentication username. -| password | String | No | - | Authentication password. - **SMTPClient.prototype.close({timeout})**:Promise; > Destroys the client and ensures that no more I/O activity happens on this socket. When possible, use the `quit` method instead. From eea007c8ae78e1366a664bf520f6ed9e122cf5b3 Mon Sep 17 00:00:00 2001 From: Rupert Bogensperger <47078678+Rupert-com@users.noreply.github.com> Date: Wed, 14 Jul 2021 06:33:11 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1a95935..c3dcd27 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # smtp-client -> Simple, promisified, protocol-based SMTP client for Node.js. +> Simple promised, protocol-based SMTP client for Node.js. -This is an open source [npm](http://npmjs.com) package from [Node.js](http://nodejs.org). The source code is available on [GitHub](https://github.com/xpepermint/smtp-client) where you can also find our [issue tracker](https://github.com/xpepermint/smtp-client/issues). +This is an open-source [npm](http://npmjs.com) package from [Node.js](http://nodejs.org). The source code is available on [GitHub](https://github.com/xpepermint/smtp-client) where you can also find our [issue tracker](https://github.com/xpepermint/smtp-client/issues). ## Related Projects @@ -70,7 +70,7 @@ Note that all instance methods throw an error when something goes wrong or when **SMTPClient.prototype.connect({timeout})**:Promise; -> Connects to the SMTP server and starts socket I/O activity. +> Connects to the SMTP server and starts to socket I/O activity. | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ @@ -78,7 +78,7 @@ Note that all instance methods throw an error when something goes wrong or when **SMTPClient.prototype.data(source, {sourceSize, timeout})**:Promise; -> Sends the DATA command to the server which uploads the `source` of an email and finalize the process with the `.` (automatically appended to the source). +> Sends the DATA command to the server which uploads the `source` of an email and finalizes the process with the `.` (automatically appended to the source). | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ @@ -160,7 +160,7 @@ Note that all instance methods throw an error when something goes wrong or when **SMTPClient.prototype.parseEnhancedReplyCode(line)**:String; -> A helper method which parses and returns the enhanced reply code from the provided SMTP server reply. +> A helper method that parses and returns the enhanced reply code from the provided SMTP server reply. | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ @@ -168,7 +168,7 @@ Note that all instance methods throw an error when something goes wrong or when **SMTPClient.prototype.parseReplyCode(line)**:String; -> A helper method which parses and returns the reply code from the provided SMTP server reply. +> A helper method that parses and returns the reply code from the provided SMTP server reply. | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ @@ -176,7 +176,7 @@ Note that all instance methods throw an error when something goes wrong or when **SMTPClient.prototype.parseReplyText(line)**:String; -> A helper method which parses and returns the message part of the provided SMTP server reply. +> A helper method that parses and returns the message part of the provided SMTP server reply. | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ @@ -221,8 +221,8 @@ Note that all instance methods throw an error when something goes wrong or when | Option | Type | Required | Default | Description |--------|------|----------|---------|------------ -| data | String,Stream,Buffer | Yes | - | Data to be sent to the SMTP server. Make sure that you apply to the SMTP rules and complete lines with `\r\n`. When sending email data stream, make sure you include the `.` as the last line. -| handler | Function,Promise | No | - | A method for handling SMTP server replies. +| data | String, Stream, Buffer | Yes | - | Data to be sent to the SMTP server. Make sure that you apply to the SMTP rules and complete lines with `\r\n`. When sending email data stream, make sure you include the `.` as the last line. +| handler | Function, Promise | No | - | A method for handling SMTP server replies. | timeout | Integer | No | 0 | A time in milliseconds after the operation automatically rejects (`0` disables the timeout). **Event: close**: () => {} @@ -259,7 +259,7 @@ Note that all instance methods throw an error when something goes wrong or when | Argument | Type | Description |----------|------|------------ -| chunk | Buffer,String | A chunk of data. +| chunk | Buffer, String | A chunk of data. **Event: reply**: (line) => {} From 2cbc05c343dc03c7a2f52e29147fb7fd6ae7ee76 Mon Sep 17 00:00:00 2001 From: Rupert Bogensperger <47078678+Rupert-com@users.noreply.github.com> Date: Wed, 14 Jul 2021 06:42:26 +0200 Subject: [PATCH 3/3] Revert "Update README.md" This reverts commit b27e3ccca64141691fbdf77201f8bbbad71b3245. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c3dcd27..0ff7321 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,15 @@ Note that all instance methods throw an error when something goes wrong or when | username | String | No | - | Authentication username. | password | String | No | - | Authentication password. +**SMTPClient.prototype.authPlain({username, password})**:Promise; + +> Sends AUTH PLAIN command to the server and authenticates. + +| Option | Type | Required | Default | Description +|--------|------|----------|---------|------------ +| username | String | No | - | Authentication username. +| password | String | No | - | Authentication password. + **SMTPClient.prototype.close({timeout})**:Promise; > Destroys the client and ensures that no more I/O activity happens on this socket. When possible, use the `quit` method instead.