Mercurial > prosody-wiki

annotate mod_offline_email.wiki @ 502:3c81d8a9f1e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation for the new mod_admin_message module.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:07:33 +0000
parents 0b3b86dce224
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
1 #summary Forward offline messages via email
29
7629b4f71114 Added Stage-Beta
MWild1
parents: 21
diff changeset
2 #labels Stage-Beta
0
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
3
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
4 = Introduction =
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
5
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
6 Quite often when I am out and about, I'm not able to connect to Jabber. It is usually much more likely I can access my email though (whether via the web, or a mobile client).
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
7
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
8 For this reason I decided it would be extremely useful to have Jabber messages sent to me while I was offline forwarded to my email inbox.
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
9
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
10 = Usage =
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
11
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
12 Simply add "offline_email" to your modules_enabled list. When any user receives a message while they are offline, it will automatically be forwarded via mail to the *same* address as their Jabber ID. e.g. user1@example.com's offline messages will be forwarded to user1@example.com's email inbox.
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
13
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
14 = Configuration =
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
15
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
16 || 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. ||
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
17 || smtp_server || Address of the SMTP server to send through. Default 'localhost' (recommended, see caveats below) ||
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
18 || smtp_username || If set, Prosody will authenticate with the SMTP server before sending (default is no authentication) ||
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
19 || smtp_password || The password for the above user (default is none) ||
1
8061f15ea4ae Removed unintentional links.
waqas20
parents: 0
diff changeset
20 || 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 ||
0
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
21
21
84e81806c041 Added compatibility section
MWild1
parents: 1
diff changeset
22 = Compatibility =
499
0b3b86dce224 Edited wiki page mod_offline_email through web user interface.
MWild1@gmail.com
parents: 29
diff changeset
23 ||0.9||Works||
21
84e81806c041 Added compatibility section
MWild1
parents: 1
diff changeset
24
0
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
25 = Caveats/Todos/Bugs =
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
26
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
27 * Currently SMTP sending blocks the whole server. This should not be noticable if your mail server is on the same machine as Prosody.
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
28 * There is not (yet) any way to configure forwarding to an email address other than your JID (idea... use email address in vcard?)
8e7907dab2a8 mod_offline_email: Initial page
MWild1
parents:
diff changeset
29 * Enable/disable this feature per user?