view mod_mam.wiki @ 373:c929df198f10

Mark pages of modules no longer in the repo as Deprecated
author Kim Alvefur <zash@zash.se>
date Fri, 28 Jun 2013 19:55:59 +0200
parents fc11f3985d9b
children 6f559c056dc8
line wrap: on
line source

#summary XEP-0313: Message Archive Management (Really)
#labels Stage-Alpha

= Introduction =

Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]. Like [mod_archive] but much simpler.

= 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 =

{{{
	default_archive_policy = true or false or "roster";
}}}

This controls what messages are archived if the user hasn't set a matching rule, or another personal default.

 * `false` means to store no messages. This is the built in default.
 * `"roster"` means to store messages to/from contacts in the users roster.
 * `true` means is to store all messages.

{{{
	max_archive_query_results = 50;
}}}

This is the largest number of messages that are allowed to be retrieved in one request.


= Compatibility =
|| 0.8 || Works ||
|| 0.9 || Works ||
|| trunk || Works ||

= TODO =

	* Optimize
	* Use new stanza archive API once it appears
	* Policy enforcing.