Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seanox/roundup
IMAP background filter, washer and reorganizer (based on regular and and logical expressions)
https://github.com/seanox/roundup
filters imap php reorganize roundup seanox
Last synced: 12 days ago
JSON representation
IMAP background filter, washer and reorganizer (based on regular and and logical expressions)
- Host: GitHub
- URL: https://github.com/seanox/roundup
- Owner: seanox
- License: apache-2.0
- Created: 2018-01-23T17:22:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T04:05:12.000Z (6 months ago)
- Last Synced: 2024-06-01T05:23:12.511Z (6 months ago)
- Topics: filters, imap, php, reorganize, roundup, seanox
- Language: PHP
- Homepage:
- Size: 227 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
# Description
Roundup (in allusion to a broadband herbicide) is an IMAP-based mail filter,
washer and (re)organizer that works in the background, e.g. as a cron job.
This tool uses IMAP to move rule based mails in a mailbox. The rules for this
are a combination of regular and logical expressions.
__Why PHP?__
For those who use a homepage, server-side PHP is often available for crone job
and so the solution can be used remotely instead of locally -- and the IMAP
implementation for PHP is good :-)
# Features
- Multiple account support
- IMAP support (incl. SSL)
- simple URL based IMAP and mailbox definition
- Internal dynamic whitelist
Exclusion of mails from subsequent filters and rules.
- Filter based on patterns with regular expression
The patterns can then be combined in logical expressions.
Supported: AND, OR, NOT, round brackets
- Processes the header and body of the messages
Message content, including multi-part, is decoded and simplified for the
filters. The decoding only happens in memory.
- Message attributes such as 'seen / unseen' are retained
- Continuation of filtering from the last analyzed mail (for each mailbox
separately); complete reanalysis when changing application, configuration or
filter
- Logging with detailed error messages
- Physical separation of application, configuration (with accounts) and filter
# Licence Agreement
LIZENZBEDINGUNGEN - Seanox Software Solutions ist ein Open-Source-Projekt, im
Folgenden Seanox Software Solutions oder kurz Seanox genannt.
Diese Software unterliegt der Version 2 der Apache License.
Copyright (C) 2024 Seanox Software Solutions
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
# System Requirement
- PHP 7.x or higher + imap extension
# Downloads
[Seanox Roundup 2.0.1](https://github.com/seanox/roundup/releases/download/2.0.1/seanox-roundup-2.0.1.zip)
# Installation
The script must be stored on a server and is called by a cron job.
```
/bin/php -f roundup.php
```
Alternatively, the script can also be used via CGI.
__In this case, please prohibit access to the configuration (ini) and filter file.__
# Configuration
The application consists of three files (`roundup.php`, `roundup.ini`,
`roundup.filter`). At runtime, the session file `roundup.data` is created later.
The files can be renamed. Basis is the file name of the application
(`roundup.php`). All other file names must be based on it.
The program file`roundup.php` itself does not need to be configured.
## Configuration _(roundup.ini)_
There are two sections: _COMMON_ and _ACCOUNT_.
Please open `roundup.ini` and read the notices and see the examples.
## Filter _(roundup.filter)_
The filters are defined here.
Please open `roundup.filter` and read the instructions and see the examples.
## Filter collection against spam
Collected selection with general rules.
- A + B: Pupular sender that does not match sender address
- C: Empty tags in header X-Envelope-From
- D: Empty tags in the Reply-to () header
- E: Images with request parameter
```
A: /^From:.*(google|facebook|ebay|amazon)/im
B: /^From:.*?(google|facebook|ebay|amazon).*<.*@[^>]*\1\.(\w+)>/im
C: /X-Envelope-From:\s*<\s*>/i
D: /Reply-to:\s*<\s*>/i
E: /![]()
]+\ssrc=[^>]+\?/i
(A && !B) || C || D || E
```
# Changes
## 2.0.1 20240401
BF: Review: Optimizations and corrections
BF: Build: Optimization of the release info process
BF: Filter: Update of example patterns
[Read more](https://raw.githubusercontent.com/seanox/roundup/master/CHANGES)
# Contact
[Issues](https://github.com/seanox/roundup/issues)
[Requests](https://github.com/seanox/roundup/pulls)
[Mail](http://seanox.de/contact)