glenux/bulk-barrage

Fork 0

Glenn 295456568a

continuous-integration/drone/push Build is failing

Details

chore: add missing cmake dependency

2023-12-25 20:02:23 +01:00

3 KiB

Raw Blame History

Bulk Barrage

Bulk Barrage 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.

Introduction

Bulk Barrage is a community-driven project developed independently from 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:

Make,
CMake
CrystalLang and Shards.

Installation

To install Bulk Barrage, follow these steps:

Ensure that CrystalLang is installed on your system.

Clone the repository:

git clone https://github.com/your-repo/bulk-barrage.git
cd bulk-barrage

Use the Makefile to build the project:
```
make build
```

Usage

Bulk Barrage can be used in a few simple steps:

Usage: bulk-barrage [options] [command]

Commands:
  configure        Initialize the configuration
  report           Process and report spam email (default: from STDIN)

Options:
  -h, --help       Show this help

Reporting spam from command-line

To report a spam email, you can use the report command:

cat spam_email.eml | bulk-barrage report

Reporting spam from Mutt (or Neomutt)

Add the following code in your ~/.muttrc configuration file.

macro index,pager \ez "<enter-command>set pipe_decode=no\n<pipe-entry>bulk-barrage report\n<enter-command>set pipe_decode=yes\n<delete-message>" "Report a spam using Bulk Barrage"

Configuration

After installation, run bulk-barrage configure to set up your user configuration, which may include credentials or preferences for interacting with the SignalSpam platform.

Issue Reporting

Issues can be reported on Bulk Barrage's Issue Tracker.

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:

3 KiB Raw Blame History