Ruby client for Rspamd’s HTTP API

Usage

Initialize a client with the host and port of an Rspamd controller process:

client = Rspamd::Client.new(host: "localhost", port: 11334)

Check a message:

result = client.check("Date: Tue, 21 Jan 2020 21:04:42 +0000\nFrom: Alice <alice@example.com>\nTo: Bob <bob@example.com>\nMessage-ID: <975bad33-2e76-40c3-89aa-7fe1edcbe7ce@example.com>\nSubject: Hello\nMime-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: quoted-printable\nDelivered-To: bob@example.com\n\nHi Bob!\n\n-Alice\n")

result.spam? # => false
result.ham? # => true

result.score # => 1.2
result.required_score # => 15
result.action # => "no action"

Report a message as spam:

client.spam!("Date: Tue, 21 Jan 2020 21:04:42 +0000\nFrom: Spammer <spammer@example.com>\nTo: Bob <bob@example.com>\nMessage-ID: <975bad33-2e76-40c3-89aa-7fe1edcbe7ce@example.com>\nSubject: Hello\nMime-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: quoted-printable\nDelivered-To: bob@example.com\n\nBuy some stuff?\n")

Report a message as ham:

client.ham!("Date: Tue, 21 Jan 2020 21:04:42 +0000\nFrom: Alice <alice@example.com>\nTo: Bob <bob@example.com>\nMessage-ID: <975bad33-2e76-40c3-89aa-7fe1edcbe7ce@example.com>\nSubject: Hello\nMime-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: quoted-printable\nDelivered-To: bob@example.com\n\nHi Bob!\n\n-Alice\n")