view mod_offline_email.wiki @ 227:e661e843f083

Created wiki page through web user interface.
author MWild1
date Tue, 11 Oct 2011 00:58:27 +0000
parents 7629b4f71114
children 0b3b86dce224
line wrap: on
line source

#summary Forward offline messages via email
#labels Stage-Beta

= Introduction =

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).

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.

= Usage =

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.

= Configuration =

|| 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. ||
|| smtp_server || Address of the SMTP server to send through. Default 'localhost' (recommended, see caveats below) ||
|| smtp_username   || If set, Prosody will authenticate with the SMTP server before sending (default is no authentication) ||
|| smtp_password   || The password for the above user (default is none) ||
|| 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 ||

= Compatibility =
||0.6||Works||
||0.5||Should work||

= Caveats/Todos/Bugs =

  * Currently SMTP sending blocks the whole server. This should not be noticable if your mail server is on the same machine as Prosody.
  * There is not (yet) any way to configure forwarding to an email address other than your JID (idea... use email address in vcard?)
  * Enable/disable this feature per user?