From 632fd7a702fe87bf63f00f47f75d9397fa68caa7 Mon Sep 17 00:00:00 2001
From: gethvi <gethvi@tauri.one>
Date: Wed, 13 Dec 2023 18:00:07 +0100
Subject: [PATCH] FIX: Adds missing SMTP Batch Output bot to the docs.

---
 docs/user/bots.md | 126 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)

diff --git a/docs/user/bots.md b/docs/user/bots.md
index 57baf0a88..c97c8f5fe 100644
--- a/docs/user/bots.md
+++ b/docs/user/bots.md
@@ -5008,6 +5008,132 @@ rpz.yourdomain.eu. *.secondmaliciousdomain.com CNAME rpz.yourdomain.eu.
 
 ---
 
+### SMTP Batch <div id="intelmq.bots.outputs.smtp_batch.output" />
+
+Aggregate events by e-mail addresses in the `source.abuse_contact` field and batch send them at once as a zipped CSV file attachment in a GPG signed message.
+
+When the bot is run normally by IntelMQ, it just aggregates the events for later use into a custom Redis database.
+If run through CLI (by a cron or manually), it shows e-mail messages that are ready to be sent and let you send them to the tester's e-mail OR to abuse contact e-mails.
+E-mails are sent in a zipped CSV file, delimited by a comma, while keeping strings in double quotes.
+Note: The field "raw" gets base64 decoded if possible. Bytes `\n` and `\r` are replaced with "\n" and "\r" strings in order to guarantee best CSV files readability both in Microsoft Office and LibreOffice. (A multiline string may be stored in "raw" which completely confused Microsoft Excel.)
+
+Launch it like this:
+```
+</usr/local/bin executable> <bot-id> cli [--tester tester's email]
+```
+Example:
+```bash
+intelmq.bots.outputs.smtp_batch.output smtp-batch-output --cli --tester your-email@example.com
+```
+
+CLI flags:
+```
+-h, --help            show this help message and exit
+--cli                 initiate CLI interface
+--tester TESTING_TO   tester's e-mail
+--ignore-older-than-days IGNORE_OLDER_THAN_DAYS
+                      1..n skip all events with time.observation older than 1..n day; 0 disabled (allow all)
+--gpg-key GPG_KEY     fingerprint of gpg key to be used
+--limit-results LIMIT_RESULTS
+                      Just send first N mails.
+--send                Sends now, without dialog.
+```
+
+You can schedule the batch sending easily with a cron script, I.E. put this into `crontab -e` of the `intelmq` user:
+
+```
+# Send the e-mails every day at 6 AM
+0 6 * * *  /usr/local/bin/intelmq.bots.outputs.smtp_batch.output smtp-batch-output-cz cli --ignore-older-than-days 4 --send > /tmp/intelmq-send.log
+```
+
+**Module:** `intelmq.bots.outputs.smtp_batch.output`
+
+**Parameters:**
+
+**`alternative_mails`**
+
+(optional, string) Path to CSV in the form `original@email.com,alternative@email.com`. Needed when some of the recipients ask you to forward their e-mails to another address.
+
+**`attachment_name`**
+
+(optional, string)  Attachment file name for the outgoing messages. May contain date formatting like this `%Y-%m-%d`. Example: "events_%Y-%m-%d" will appear as "events_2022-12-01.zip". Defaults to "intelmq_%Y-%m-%d".
+
+**`bcc`**
+
+(optional, array of strings) An array of e-mails to be put in the `Bcc` field for every mail.
+
+**`email_from`**
+
+(required, string) Sender's e-mail of the outgoing messages.
+
+
+**`gpg_key`**
+
+(optional, string) The Key or the fingerprint of a GPG key stored in ~/.gnupg keyring folder.
+
+
+**`gpg_pass`**
+
+(optional, string) Password for the GPG key if needed.
+
+
+**`mail_template`**
+
+(required, string) Path to the file containing the body of the mail for the outgoing messages.
+
+
+**`ignore_older_than_days`**
+
+(optional, integer) Skips events with time.observation older than now-N. (If your queue gets stuck for a reason, you do not want to send old and probably already solved events.) Defaults to 0 (allow all).
+
+
+**`limit_results`**
+
+(optional, integer) Intended as a debugging option, allows loading just first N e-mails from the queue.
+
+
+**`redis_cache_db`**
+
+(required, integer)  Redis database used for event aggregation. As the databases < 10 are reserved for the IntelMQ core, recommended is a bigger number.
+
+
+**`redis_cache_host`**
+
+(required, string) Hostname of the Redis database.
+
+
+**`redis_cache_port`**
+
+(required, string)  Port of the Redis database.
+
+
+**`redis_cache_ttl`**
+
+(required, integer) TTL in seconds used for caching. Recommended 1728000 for 20 days.
+
+
+**`smtp_server`**
+
+(required, string/array/object) SMTP server information and credentials. See [SMTP parameter](https://github.com/CZ-NIC/envelope#sending) of the envelope module.
+
+Examples: 
+```yaml
+smtp_server: "mailer"
+smtp_server: {"host": "mailer", "port": 587, "user": "john", "password": "123"}
+smtp_server: ["mailer", 587, "john", "password"]
+```
+
+**`subject`**
+
+(required, string) Subject for the outgoing messages. May contain date formatting like this `%Y-%m-%d`. Example: "IntelMQ weekly warning (%d.%m.%Y)".
+
+
+**`testing_to`**
+
+(optional, string) Tester's e-mail.
+
+---
+
 ### SMTP <div id="intelmq.bots.outputs.smtp.output" />
 
 Sends a MIME Multipart message containing the text and the event as CSV for every single event.