MTSR/mail
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update player entry format in API documentation

Browse Source
This commit is contained in:
Athozus 2024-04-15 17:22:59 +02:00
parent 48b632fba2
commit 6fef89ec17
No known key found for this signature in database
GPG Key ID: B50895022E8484BF
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
api.md
View File

@ -1,4 +1,3 @@
# Mail format # Mail format
The mail format in the api hooks 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): mod-storage entry for a player (indexed by playername and serialized with json):
```lua ```lua
{ {
contacts = { contacts = {
{ {
-- name of the player (unique key in the list) -- name of the player (unique key in the list)
@ -107,6 +107,12 @@ mod-storage entry for a player (indexed by playername and serialized with json):
outbox = { outbox = {
-- same format as "inbox" -- same format as "inbox"
}, },
drafts = {
-- same format as "inbox"
},
trash = {
-- same format as "inbox"
},
lists = { lists = {
{ {
-- name of the maillist (unique key in the list) -- name of the maillist (unique key in the list)
@ -116,5 +122,10 @@ mod-storage entry for a player (indexed by playername and serialized with json):
-- playername list -- playername list
players = {"playername", "playername2"} players = {"playername", "playername2"}
} }
},
settings = {
setting1 = "value",
setting2 = true,
setting3 = 123
} }
} }