From 5d862c851cbcb2e5d53778250c82710ab6623e24 Mon Sep 17 00:00:00 2001
From: Michael M Slusarz <slusarz@users.noreply.github.com>
Date: Fri, 3 Jan 2025 11:57:38 -0700
Subject: [PATCH] WIP: doveadm: Add responses to commands

---
 data/doveadm.js | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/data/doveadm.js b/data/doveadm.js
index b4b4c38fe..083e31d11 100644
--- a/data/doveadm.js
+++ b/data/doveadm.js
@@ -2273,6 +2273,37 @@ returned.`,
 				text: `UID mask.`,
 			},
 		},
+		response: {
+			example: [
+				{
+					username: "foo",
+					connections: "1",
+					service: "imap",
+					pid: "(47)",
+					ip: "(10.0.2.100)"
+				}
+			],
+			text: `
+Returns an array of objects.
+
+If \`separate-connections\` is \`false\`, each object represents a single
+username/service combination, and the \`pid\` and \`ip\` fields will include
+all entries for that combination.
+
+If \`separate-connections\` is \`true\`, each object will contain a single
+connection.
+
+Object fields:
+
+| Key | Description |
+| --- | ----------- |
+| \`connections\` | The total number of connections for the user. This is only returned if \`separate-connections\` is \`false\`. |
+| \`ip\` | IP addresses where the user's connections are originating. |
+| \`pid\` | Process IDs of the session. |
+| \`service\` | The Dovecot service. |
+| \`username\` | Username |
+`
+		},
 		man: 'doveadm-who',
 		text: `Show who is logged into the Dovecot server.`,
 	},