Contents

# Ruby client for Rspamd’s HTTP API

## Usage

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

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

Check a message:

```ruby
result = client.check(<<~MIME)
  Date: Tue, 21 Jan 2020 21:04:42 +0000
  From: Alice <[e-mail]>
  To: Bob <[e-mail]>
  Message-ID: <[e-mail]>
  Subject: Hello
  Mime-Version: 1.0
  Content-Type: text/plain; charset=UTF-8
  Content-Transfer-Encoding: quoted-printable
  Delivered-To: [e-mail]

  Hi Bob!

  -Alice
MIME

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

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

Report a message as spam:

```ruby
client.spam!(<<~MIME)
  Date: Tue, 21 Jan 2020 21:04:42 +0000
  From: Spammer <[e-mail]>
  To: Bob <[e-mail]>
  Message-ID: <[e-mail]>
  Subject: Hello
  Mime-Version: 1.0
  Content-Type: text/plain; charset=UTF-8
  Content-Transfer-Encoding: quoted-printable
  Delivered-To: [e-mail]

  Buy some stuff?
MIME
```

Report a message as ham:

```ruby
client.ham!(<<~MIME)
  Date: Tue, 21 Jan 2020 21:04:42 +0000
  From: Alice <[e-mail]>
  To: Bob <[e-mail]>
  Message-ID: <[e-mail]>
  Subject: Hello
  Mime-Version: 1.0
  Content-Type: text/plain; charset=UTF-8
  Content-Transfer-Encoding: quoted-printable
  Delivered-To: [e-mail]

  Hi Bob!

  -Alice
MIME
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rspamd-ruby-1.0.0	README.md