Skip to content

Commit d4a0e5d

Browse files
committed
Tweak README.
1 parent 6816253 commit d4a0e5d

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,37 @@ The `Mail` class encapsulates connection settings and can be used as a
1717
safe, high-level mailer.
1818

1919
var mail = require('mail').Mail({
20-
host: 'smtp.gmail.com',
21-
username: '[email protected]',
22-
password: '**password**'
23-
});
20+
host: 'smtp.gmail.com',
21+
username: '[email protected]',
22+
password: '**password**'
23+
});
2424

2525
Use the mailer to send messages:
2626

2727
mail.message({
28-
29-
30-
subject: 'Hello from Node.JS'
31-
})
32-
.body('Node speaks SMTP!')
33-
.send(function(err) {
34-
if (err) throw err;
35-
console.log('Sent!');
36-
});
28+
29+
30+
subject: 'Hello from Node.JS'
31+
})
32+
.body('Node speaks SMTP!')
33+
.send(function(err) {
34+
if (err) throw err;
35+
console.log('Sent!');
36+
});
3737

3838
## Mail(options) ##
3939

4040
Create a new mailer that can be used to send messages. Common options
4141
include:
4242

43-
+ `port`: server listens on this port (default: 587 or 25)
4443
+ `host`: server hostname
4544
+ `username`: user for server authentication
4645
+ `password`: password for server authentication,
4746

4847
Other options:
4948

5049
+ `secure`: `true`, `false`, or crypto credentials (default: `true`)
50+
+ `port`: server listens on this port (default: 587 or 25)
5151
+ `domain`: the domain of the sender (default: `os.hostname()`)
5252
+ `mimeTransport`: `7BIT` or `8BITMIME` (default: `8BITMIME`)
5353

@@ -85,7 +85,9 @@ version `v0.4.3`. A working subset of these RFCs are supported:
8585
+ [SMTP Transport Layer Security](http://tools.ietf.org/html/rfc3207)
8686
+ [8-bit MIME Transport](http://tools.ietf.org/html/rfc6152)
8787

88-
There is not currently support for MIME.
88+
There is not currently direct support for multipart messages or
89+
attachments, although `node-mail` will send messages in this format if
90+
they're build manually.
8991

9092
[1]: http://qmail.org/top.html
9193
[2]: http://mail.google.com/support/bin/answer.py?hl=en&answer=13287

0 commit comments

Comments
 (0)