mod_mam

Introduction

Implementation of XEP-0313: Message Archive Management.

Details

This module will archive all messages that match the simple rules setup by the user, and allow the user to access this archive.

Usage

First copy the module to the prosody plugins directory.

Then add “mam” to your modules_enabled list:

modules_enabled = {
-- ...
"mam",
-- ...
}

Configuration

Option summary

option type default
max_archive_query_results number 50
default_archive_policy boolean or "roster" true
archive_expires_after string "1w"
archive_cleanup_interval number 4*60*60

Storage backend

mod_mam uses the store “archive2”1. See Prosodys data storage documentation for information on how to configure storage.

For example, to use mod_storage_sql (requires Prosody 0.10 or later):

storage = {
archive2 = "sql";
}

If no archive-capable storage backend can be opened then an in-memory one will be used as fallback.

Query size limits

max_archive_query_results = 20;

This is the largest number of messages that are allowed to be retrieved in one request page. A query that does not fit in one page will include a reference to the next page, letting clients page through the result set. Setting large number is not recommended, as Prosody will be blocked while processing the request and will not be able to do anything else.

Archive expiry

Messages in the archive will expire after some time, by default one week. This can be changed by setting archive_expires_after:

archive_expires_after = "1d" -- one day
archive_expires_after = "1w" -- one week, the default
archive_expires_after = "2m" -- two months
archive_expires_after = "1y" -- one year
archive_expires_after = 60 * 60 -- one hour
archive_expires_after = "never" -- forever

The format is an integer number of seconds or a multiple of a period given by a suffix that can be one of d (day), w (week), m (month) or y (year). No multiplier means seconds.

Message matching policy

The MAM protocol includes a way for clients to control what messages should be stored. This allows users to enable or disable archiving by default or for specific contacts.

default_archive_policy = true
default_archive_policy = Meaning
false Store no messages.
"roster" Store messages to/from contacts in the users roster.
true Store all messages. This is the default.

Compatibility

trunk Included with Prosody
0.10 Included with Prosody
0.9 Works
0.8 Does not work

  1. Might be changed to “mam” at some point