bulk-barrage/README.md

115 lines
3 KiB
Markdown
Raw Normal View History

2023-12-24 17:48:55 +00:00
<!--
# SPDX-License-Identifier: LGPL-3.0-or-later
#
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
-->
[![Build Status](https://cicd.apps.glenux.net/api/badges/glenux/bulk-barrage/status.svg)](https://cicd.apps.glenux.net/glenux/bulk-barrage)
2023-12-24 17:48:55 +00:00
<img src="/glenux/bulk-barrage/raw/branch/master/_images/logo-simple.svg" height="256" />
2023-12-25 17:25:20 +00:00
# Bulk Barrage
2023-12-24 16:01:57 +00:00
Bulk Barrage is a command-line tool that enables users to report spam emails to
2023-12-24 16:07:23 +00:00
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
Bulk Barrage 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
To install Bulk Barrage, 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
Bulk Barrage 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
```
2023-12-24 17:51:25 +00:00
### Reporting spam from command-line
2023-12-24 16:01:57 +00:00
To report a spam email, you can use the `report` command:
```bash
2023-12-24 18:28:06 +00:00
cat spam_email.eml | bulkbarrage report
2023-12-24 16:01:57 +00:00
```
2023-12-24 17:51:25 +00:00
### Reporting spam from Mutt (or Neomutt)
Add the following code in your `~/.muttrc` configuration file.
```muttrc
macro index,pager \ez "<enter-command>set pipe_decode=no\n<pipe-entry>bulkbarrage report\n<enter-command>set pipe_decode=yes\n<delete-message>" "Report a spam using Bulk Barrage"
2023-12-24 17:51:25 +00:00
```
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-25 18:57:27 +00:00
Issues can be reported on [Bulk Barrage's Issue Tracker](https://code.apps.glenux.net/glenux/bulk-barrage/issues).
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)