Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 3c3cca5 commit efc9c376cee61674460b41021ef1521d17c450cc Andris Reinman committed Feb 10, 2012
Showing with 8 additions and 7 deletions.
  1. +8 −7 README.md
View
@@ -2,9 +2,9 @@ Nodemailer
==========
**Nodemailer** is an easy to use module to send e-mails with Node.JS (using
-SMTP or sendmail) and it's Unicode friendly - You can use any characters you like ✔
+SMTP or sendmail) and it's unicode friendly - You can use any characters you like ✔
-This is a project for a new version of Nodemailer, built from scratch.
+This version of Nodemailer is built from scratch and might break some existing scripts, so beware while upgrading.
[Autogenerated docs](http://www.node.ee/maildoc/)
@@ -19,9 +19,10 @@ in a more structured way (with TOC).
* **HTML content** as well as **plain text** alternative
* **Attachments** (including attachment **streaming** for sending larger files)
* **Embedded images** in HTML
- * **SSL/TLS** for secure e-mail delivery
+ * **SSL/STARTTLS** for secure e-mail delivery
* Different transport methods - **SMTP**, **sendmail** and **Amazon SES**
- * **Connection pool** for SMTP for rapid delivery
+ * SMTP **Connection pool** and connection reuse for rapid delivery
+ * **Preconfigured** services for using SMTP with Gmail, Hotmail etc.
## Check out my other mail related modules
@@ -52,8 +53,8 @@ An e-mail can be sent with `sendMail(mailOptions, callback)` command
Where
- `mailOptions` defines the e-mail (set its subject, body text, receivers etc.), see **E-mail Message Fields** for details
- `callback` is the callback function that will be run after the e-mail is sent or the sending failed
+ * **mailOptions** defines the e-mail (set its subject, body text, receivers etc.), see **E-mail Message Fields** for details
+ * **callback** is the callback function that will be run after the e-mail is sent or the sending failed (see **Return callback** for details)
## Setting up a transport method
@@ -94,7 +95,7 @@ terms), you do not want to do it several times.
Possible SMTP options are the following:
- * **service** - a well known service identifier ("Gmail", "Hotmail" etc., see **Well known Services** below) for auto-completing host, port and secure connection settings
+ * **service** - a well known service identifier ("Gmail", "Hotmail" etc., see **Well known Services** for alist of supported services) for auto-completing host, port and secure connection settings
* **host** - hostname of the SMTP server (defaults to "localhost", not needed with `service`)
* **port** - port of the SMTP server (defaults to 25, not needed with `service`)
* **secureConnection** - use SSL (default is `false`, not needed with `service`)

0 comments on commit efc9c37

Please sign in to comment.