mod_offline_email/README.wiki
changeset 1786 29f3d6b7ad16
equal deleted inserted replaced
1785:12ac88940fe3 1786:29f3d6b7ad16
       
     1 #summary Forward offline messages via email
       
     2 #labels Stage-Beta
       
     3 
       
     4 = Introduction =
       
     5 
       
     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).
       
     7 
       
     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.
       
     9 
       
    10 = Usage =
       
    11 
       
    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.
       
    13 
       
    14 = Configuration =
       
    15 
       
    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. ||
       
    17 || smtp_server || Address of the SMTP server to send through. Default 'localhost' (recommended, see caveats below) ||
       
    18 || smtp_username   || If set, Prosody will authenticate with the SMTP server before sending (default is no authentication) ||
       
    19 || smtp_password   || The password for the above user (default is none) ||
       
    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 ||
       
    21 
       
    22 = Compatibility =
       
    23 ||0.9||Works||
       
    24 
       
    25 = Caveats/Todos/Bugs =
       
    26 
       
    27   * Currently SMTP sending blocks the whole server. This should not be noticable if your mail server is on the same machine as Prosody.
       
    28   * There is not (yet) any way to configure forwarding to an email address other than your JID (idea... use email address in vcard?)
       
    29   * Enable/disable this feature per user?