meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:housekeeping [2019/05/13 20:53] – [Linktrack forward] duncanc | plugin:housekeeping [2024/06/22 20:21] (current) – duncanc | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Housekeeping ====== | ||
+ | |||
+ | ---- plugin ---- | ||
+ | |||
+ | description: | ||
+ | author | ||
+ | type : | ||
+ | lastupdate : 2017-09-17 | ||
+ | compatible : phplist 3 | ||
+ | depends | ||
+ | conflicts | ||
+ | similar | ||
+ | tags : | ||
+ | |||
+ | sourcerepo : https:// | ||
+ | donationurl: | ||
+ | ---- | ||
+ | |||
+ | ====== Purpose ====== | ||
+ | This plugin deletes old and unused records from various tables, either single tables or a group of related tables. | ||
+ | The plugin provides a page that can be invoked through menu System > Housekeeping or as a cron job. | ||
+ | |||
+ | ==== Messages ==== | ||
+ | |||
+ | Rows will be deleted from the '' | ||
+ | Rows will also be deleted from all tables related to the '' | ||
+ | |||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ==== Event log ==== | ||
+ | |||
+ | Rows will be deleted from the '' | ||
+ | |||
+ | ==== Bounces ==== | ||
+ | |||
+ | Rows will be deleted from the '' | ||
+ | |||
+ | Rows will also be deleted from the '' | ||
+ | |||
+ | Rows will also be deleted from the '' | ||
+ | |||
+ | Rows will be deleted from the '' | ||
+ | |||
+ | ==== Linktrack forward ==== | ||
+ | |||
+ | Rows will be deleted from the '' | ||
+ | |||
+ | This can happen after deleting campaigns, | ||
+ | |||
+ | ==== User history ==== | ||
+ | |||
+ | Deletes rows from the '' | ||
+ | |||
+ | For example, if the threshold is 6 months and the most recent '' | ||
+ | ====== Installation ====== | ||
+ | |||
+ | See the README file on the GitHub page https:// | ||
+ | ===== Translations ===== | ||
+ | |||
+ | The text displayed by the plugin can be translated into other languages. See the file '' | ||
+ | |||
+ | To create a new language file, copy '' | ||
+ | |||
+ | |||
+ | ====== Usage ====== | ||
+ | |||
+ | ===== Configuration ===== | ||
+ | |||
+ | The plugin provdes a section on the Settings page where you can configure which tables should be processed. | ||
+ | {{: | ||
+ | |||
+ | The threshold values must be specified as a number of days, weeks, months, quarters or years, singular or plural are accepted. For example | ||
+ | |||
+ | * 1 year | ||
+ | * 10 weeks | ||
+ | * 1 month | ||
+ | * 60 days | ||
+ | |||
+ | ===== Cron job ===== | ||
+ | |||
+ | The housekeeping can be automated by running a cron job periodically, | ||
+ | |||
+ | <code bash>php / | ||
+ | |||
+ | You can also run the command as a remote page if your cron job is limited to fetching web pages and cannot run linux commands. | ||
+ | The page can be fetched using a linux command such as wget or curl. | ||
+ | |||
+ | < | ||
+ | |||
+ | < | ||
+ | |||
+ | where xxxxxxxx is the “Secret for remote processing” value from the phplist Settings page. | ||