From 5cfec3a92ad07bcfeb5d3f6bc7ff780f9a3473d4 Mon Sep 17 00:00:00 2001
From: Athozus <athozus@gmail.com>
Date: Mon, 5 Aug 2024 17:01:20 +0200
Subject: [PATCH] Update api.md docs (#148)

* Update player entry format in API documentation

* Add spam flag
---
 api.md | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/api.md b/api.md
index bfb5ed2..aec8232 100644
--- a/api.md
+++ b/api.md
@@ -1,4 +1,3 @@
-
 # Mail format
 The mail format in the api hooks
 
@@ -70,6 +69,7 @@ The recipient handler should return
 mod-storage entry for a player (indexed by playername and serialized with json):
 ```lua
 {
+
 	contacts = {
 		{
 			-- name of the player (unique key in the list)
@@ -99,7 +99,9 @@ mod-storage entry for a player (indexed by playername and serialized with json):
 			-- timestamp (os.time())
 			time = 1234,
 			-- read-flag (true: player has read the mail, inbox only)
-			read = true
+			read = true,
+                        -- spam-flag (true: that mail is noted as a spam)
+                        spam = false
 		},{
 			...
 		}
@@ -107,6 +109,12 @@ mod-storage entry for a player (indexed by playername and serialized with json):
 	outbox = {
 		-- same format as "inbox"
 	},
+	drafts = {
+		-- same format as "inbox"
+	},
+	trash = {
+		-- same format as "inbox"
+	},
 	lists = {
 		{
 			-- name of the maillist (unique key in the list)
@@ -116,5 +124,10 @@ mod-storage entry for a player (indexed by playername and serialized with json):
 			-- playername list
 			players = {"playername", "playername2"}
 		}
+	},
+	settings = {
+		setting1 = "value",
+		setting2 = true,
+		setting3 = 123
 	}
 }