Mercurial > prosody-modules
comparison mod_offline_email/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 18:03:58 +0200 |
| parents | mod_offline_email/README.wiki@29f3d6b7ad16 |
| children | ea6b5321db50 |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Beta' | |
| 4 summary: Forward offline messages via email | |
| 5 ... | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 Quite often when I am out and about, I'm not able to connect to Jabber. | |
| 11 It is usually much more likely I can access my email though (whether via | |
| 12 the web, or a mobile client). | |
| 13 | |
| 14 For this reason I decided it would be extremely useful to have Jabber | |
| 15 messages sent to me while I was offline forwarded to my email inbox. | |
| 16 | |
| 17 Usage | |
| 18 ===== | |
| 19 | |
| 20 Simply add "offline\_email" to your modules\_enabled list. When any user | |
| 21 receives a message while they are offline, it will automatically be | |
| 22 forwarded via mail to the **same** address as their Jabber ID. e.g. | |
| 23 user1@example.com's offline messages will be forwarded to | |
| 24 user1@example.com's email inbox. | |
| 25 | |
| 26 Configuration | |
| 27 ============= | |
| 28 | |
| 29 Option Description | |
| 30 ------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 31 queue\_offline\_emails The number of seconds to buffer messages for, before they are sent as an email. The default is to send each message as it arrives. | |
| 32 smtp\_server Address of the SMTP server to send through. Default 'localhost' (recommended, see caveats below) | |
| 33 smtp\_username If set, Prosody will authenticate with the SMTP server before sending (default is no authentication) | |
| 34 smtp\_password The password for the above user (default is none) | |
| 35 smtp\_from Address from which it will appear the emails came. Default is smtp\_username@smtp\_server, where smtp\_username is replaced with 'xmpp' if not set | |
| 36 | |
| 37 Compatibility | |
| 38 ============= | |
| 39 | |
| 40 ----- ------- | |
| 41 0.9 Works | |
| 42 ----- ------- | |
| 43 | |
| 44 Caveats/Todos/Bugs | |
| 45 ================== | |
| 46 | |
| 47 - Currently SMTP sending blocks the whole server. This should not be | |
| 48 noticable if your mail server is on the same machine as Prosody. | |
| 49 - There is not (yet) any way to configure forwarding to an email | |
| 50 address other than your JID (idea... use email address in vcard?) | |
| 51 - Enable/disable this feature per user? |