mirror of
https://github.com/ShadowKatStudios/OC-Minitel.git
synced 2024-11-23 10:38:05 +11:00
Documentation updates.
This commit is contained in:
parent
1bcf22b3e5
commit
f076144249
24
MMail/MMail-protocol.md
Normal file
24
MMail/MMail-protocol.md
Normal file
@ -0,0 +1,24 @@
|
||||
# MMail - simple mail protocol
|
||||
|
||||
MMail, or Minitel Mail, is a simple electronic mail protocol for Minitel networks, using port 25.
|
||||
|
||||
## Messages
|
||||
|
||||
A message must contain:
|
||||
|
||||
- A line with `From: ` and an address, specifying where this mail came from, in the form of `user@host`
|
||||
- A line with `To: ` and an address, specifying to whom this mail is addressed to, in the form of `user@host`
|
||||
- A line with `Subject: ` and a subject line, specifying the subject of the message.
|
||||
|
||||
The entire exchange will be written to the file, but those lines are required.
|
||||
|
||||
## Sending
|
||||
|
||||
Sending a MMail message is simple:
|
||||
|
||||
1. The client opens a connection to the server on the MMail port.
|
||||
2. The client sends the header, with To, From and Subject lines.
|
||||
3. The client sends the message contents.
|
||||
4. The client closes the connection.
|
||||
|
||||
The server can then decide what to do with the message.
|
18
MMail/OpenOS/usr/man/mmail-send
Normal file
18
MMail/OpenOS/usr/man/mmail-send
Normal file
@ -0,0 +1,18 @@
|
||||
NAME
|
||||
mmail-send - send mmail-compatible messages from the command line
|
||||
|
||||
SYNOPSIS
|
||||
mmail-send [TO] [FROM] [SUBJECT] [PATH]
|
||||
|
||||
DESCRIPTION
|
||||
`mmail-send` sends mail over the Minitel network to MMail-compatible mail servers.
|
||||
|
||||
EXAMPLES
|
||||
mmail-send alice@host bob "Example message" /usr/man/mmail-send
|
||||
Sends the user alice a message addressed from bob, with subject 'Example message', containing the contents of this manual page.
|
||||
|
||||
mmail-send alice@host
|
||||
Sends the user alice a message, and prompts for all the other information.
|
||||
|
||||
mmail-send
|
||||
Prompts for all required information (to, from, subject, message)
|
@ -3,7 +3,7 @@
|
||||
files = {
|
||||
["master/OpenOS/etc/rc.d/minitel.lua"] = "//etc/rc.d",
|
||||
["master/OpenOS/usr/lib/net.lua"] = "/lib",
|
||||
["master/OpenOS/usr/man/minitel/minitel"] = "/usr/man",
|
||||
["master/OpenOS/usr/man/minitel"] = "/usr/man",
|
||||
},
|
||||
name = "Minitel",
|
||||
description = "Simple and powerful networking stack",
|
||||
@ -49,6 +49,7 @@
|
||||
["mmail-send"] = {
|
||||
files = {
|
||||
["master/MMail/OpenOS/usr/bin/mmail-send.lua"] = "/bin"
|
||||
["master/MMail/OpenOS/usr/man/mmail-send"] = "/man"
|
||||
},
|
||||
dependencies = {
|
||||
["minitel"] = ""
|
||||
|
Loading…
Reference in New Issue
Block a user