bulk-barrage/README.md

96 lines
2.2 KiB
Markdown
Raw Normal View History

2023-12-24 16:07:23 +00:00
# BulkBarrage
2023-12-24 16:01:57 +00:00
2023-12-24 16:07:23 +00:00
BulkBarrage is a command-line tool that enables users to report spam emails to
the SignalSpam platform <signal-spam.fr>.
This tool serves as a bridge between individual users and the SignalSpam
service, facilitating the process of submitting spam for official investigation
and action.
2023-12-24 16:01:57 +00:00
## Introduction
2023-12-24 16:07:23 +00:00
BulkBarrage is a community-driven project developed independently from
2023-12-24 16:01:57 +00:00
SignalSpam. It offers a convenient way for users to report spam emails directly
from any email-piping capable mail client by leveraging the HTML forms on
SignalSpam's web platform. The project is currently in beta but is mature
enough for daily use.
## Requirements
To use the project:
* An account on SignalSpam.
To build the project from source:
* GNU Make,
* CrystalLang and Shards.
## Installation
2023-12-24 16:07:23 +00:00
To install BulkBarrage, follow these steps:
2023-12-24 16:01:57 +00:00
1. Ensure that CrystalLang is installed on your system.
2. Clone the repository:
```bash
2023-12-24 16:07:23 +00:00
git clone https://github.com/your-repo/bulkbarrage.git
cd bulkbarrage
2023-12-24 16:01:57 +00:00
```
3. Use the Makefile to build the project:
```bash
make build
```
## Usage
2023-12-24 16:07:23 +00:00
BulkBarrage can be used in a few simple steps:
2023-12-24 16:01:57 +00:00
```bash
2023-12-24 16:07:23 +00:00
Usage: bulkbarrage [options] [command]
2023-12-24 16:01:57 +00:00
Commands:
configure Initialize the configuration
2023-12-24 16:07:23 +00:00
report Process and report spam email (default: from STDIN)
2023-12-24 16:01:57 +00:00
Options:
2023-12-24 16:07:23 +00:00
-h, --help Show this help
2023-12-24 16:01:57 +00:00
```
### Reporting Spam
To report a spam email, you can use the `report` command:
```bash
2023-12-24 16:07:23 +00:00
cat spam_email.eml | bulkbarrage send
2023-12-24 16:01:57 +00:00
```
## Configuration
2023-12-24 16:07:23 +00:00
After installation, run `bulkbarrage configure` to set up your user
2023-12-24 16:01:57 +00:00
configuration, which may include credentials or preferences for interacting
with the SignalSpam platform.
## Issue Reporting
2023-12-24 16:07:23 +00:00
Issues can be reported on BulkBarrage's Issue Tracker.
2023-12-24 16:01:57 +00:00
## License
This project is licensed under the LGPL-3.0-or-later.
## Acknowledgments and thanks
* SignalSpam for their efforts in combating spam.
* The CrystalLang community for support and resources.
## Alternatives
For alternative solutions or more information on SignalSpam, you can refer to:
- [SignalSpam's Official Blog Post](https://signal.eu.org/blog/wp-content/uploads/2007/05/signalspam.txt)
- [Bortzmeyer's Guide on Reporting to Signal Spam](https://www.bortzmeyer.org/signaler-a-signal-spam.html)