annotate README @ 1:56b67e2b35b1

Adds README.
author Sonny Piers <sonny.piers@gmail.com>
date Wed, 15 Jun 2011 06:20:32 +0200
parents
children 1299e2d8497f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
1 Notes:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
2
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
3 This is experimental for the moment. Currently working on making it better.
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
4 I would love to get feedbacks.
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
5
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
6 Dependencies:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
7 node-xmpp
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
8 Nodemailer
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
9 Optionnal dependency:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
10 node-ispdb (for easy SMTP setup account, it will find smtp settings for a given email address)
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
11
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
12 configuration.js:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
13 config.SMTP are settings used if the XMPP user haven't registered to the gateway you can disable this feature by setting config.defaultSMTP to false;
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
14
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
15 How it works:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
16 For example you wan't to send hello to john@email.com from the gateway mailer.xmpp.tld
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
17 Send a message to john%email.com@mailer.xmpp.tld
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
18
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
19 Licence MIT.