view mod_list_inactive/README.markdown @ 4451:f1a63271dcfc

Add tag 'Statistics' to some modules to ease discoverability Description doesn't mention stats or statistics, so doesn't show up if you search for that.
author Kim Alvefur <zash@zash.se>
date Fri, 19 Feb 2021 23:42:12 +0100
parents 0c01444f8bc2
children
line wrap: on
line source

Description
===========

This module lists those users, who haven't used their account in a
defined time-frame.

Dependencies
============

[mod_lastlog] must be enabled to collect the data used by this module.

Usage
=====

    prosodyctl mod_list_inactive example.com time [format]

Time is a number followed by 'day', 'week', 'month' or 'year'

Formats are:

  --------- ------------------------------------------------
  delete    `user:delete"user@example.com" -- last action`
  default   `user@example.com`
  event     `user@example.com last action`
  --------- ------------------------------------------------

Example
=======

    prosodyctl mod_list_inactive example.com 1year

Help
====

    prosodyctl mod_list_inactive