Mercurial > prosody-modules
view mod_offline_email/mod_offline_email.lua @ 6258:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md
--- a/mod_cloud_notify/README.md
+++ b/mod_cloud_notify/README.md
@@ -1,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+This protocol is described for developers in [XEP-0357: Push
+Notifications].
-For this module to work reliably, you must have \[mod_smacks\],
-\[mod_mam\] and \[mod_carbons\] also enabled on your server.
+For this module to work reliably, you must have [mod_smacks],
+[mod_mam] and [mod_carbons] also enabled on your server.
Some clients, notably Siskin and Snikket iOS need some additional
extensions that are not currently defined in a standard XEP. To support
-these clients, see \[mod_cloud_notify_extensions\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# Internal design notes
App servers are notified about offline messages, messages stored by
-\[mod_mam\] or messages waiting in the smacks queue. The business rules
+[mod_mam] or messages waiting in the smacks queue. The business rules
outlined
[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
are all honored[^2].
-To cooperate with \[mod_smacks\] this module consumes some events:
+To cooperate with [mod_smacks] this module consumes some events:
`smacks-ack-delayed`, `smacks-hibernation-start` and
`smacks-hibernation-end`. These events allow this module to send out
notifications for messages received while the session is hibernated by
-\[mod_smacks\] or even when smacks acknowledgements for messages are
+[mod_smacks] or even when smacks acknowledgements for messages are
delayed by a certain amount of seconds configurable with the
-\[mod_smacks\] setting `smacks_max_ack_delay`.
+[mod_smacks] setting `smacks_max_ack_delay`.
The `smacks_max_ack_delay` setting allows to send out notifications to
clients which aren't already in smacks hibernation state (because the
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parents | ee724c7fa8e0 |
| children |
line wrap: on
line source
local jid_bare = require "util.jid".bare; local os_time = os.time; local t_concat = table.concat; prosody.unlock_globals(); -- LuaSocket wants to pollute the global scope local smtp = require "socket.smtp"; prosody.lock_globals(); local smtp_server = module:get_option_string("smtp_server", "localhost"); local smtp_user = module:get_option_string("smtp_username"); local smtp_pass = module:get_option_string("smtp_password"); local smtp_address = module:get_option("smtp_from") or ((smtp_user or "xmpp").."@"..(smtp_server or module.host)); local queue_offline_emails = module:get_option("queue_offline_emails"); if queue_offline_emails == true then queue_offline_emails = 300; end local send_message_as_email; module:hook("message/offline/handle", function(event) local stanza = event.stanza; local text = stanza:get_child_text("body"); if text then return send_message_as_email(jid_bare(stanza.attr.to), jid_bare(stanza.attr.from), text); end end, 1); function send_message_as_email(address, from_address, message_text, subject) module:log("info", "Forwarding offline message to %s via email", address); local rcpt = "<"..address..">"; local mesgt = { headers = { ["content-type"] = 'text/plain; charset=utf-8'; to = address; subject = subject or ("Offline message from "..jid_bare(from_address)); }; body = message_text; }; local ok, err = smtp.send{ from = smtp_address, rcpt = rcpt, source = smtp.message(mesgt), server = smtp_server, user = smtp_user, password = smtp_pass }; if not ok then module:log("error", "Failed to deliver to %s: %s", tostring(address), tostring(err)); return; end return true; end if queue_offline_emails then local queues = {}; local real_send_message_as_email = send_message_as_email; function send_message_as_email(address, from_address, message_text) local pair_key = address.."\0"..from_address; local queue = queues[pair_key]; if not queue then queue = { from = smtp_address, to = address, messages = {} }; queues[pair_key] = queue; module:add_timer(queue_offline_emails+5, function () module:log("info", "Checking on %s", from_address); local current_time = os_time(); local diff = current_time - queue.last_message_time; if diff > queue_offline_emails then module:log("info", "Enough silence, sending..."); real_send_message_as_email(address, from_address, t_concat(queue.messages, "\n"), "You have "..#queue.messages.." offline message"..(#queue.messages == 1 and "" or "s").." from "..from_address) else module:log("info", "Next check in %d", queue_offline_emails - diff + 5); return queue_offline_emails - diff + 5; end end); end queue.last_message_time = os_time(); local messages = queue.messages; messages[#messages+1] = message_text; return true; end end
