The leader in
true
open source email and collaboration
Home
Download
News
FAQ / Knowledge Base
Screenshots
Documentation
Support
philosophical imaginary
Application Layer Protocol for the Citadel system; Introducion
Application Layer Protocol for the Citadel system
Introduction
Important Notes to Developers!
Connecting to a Server
Character Sets
General Information about the Server
Result Codes
Parametrisation
Citadel's data model, and how it influences the protocol
The following Sections are available:
Inter Citadel Node Commands
NETP (authenticate as network session with connection NET Password)
NSYN (Network SYNchronize room)
NUOP (Network Upload OPen file)
NDOP (Network Download OPen file)
GNET (Get NETwork configuration for this room)
SNET (Set NETwork configuration for this room)
Misc
NOOP (NO OPeration)
QNOP (Quiet No OPeration)
ECHO (ECHO something)
TIME (get server local TIME)
MESG (read system MESsaGe)
MRTG (Multi Router Traffic Grapher)
Session Authentication
USER (send USER name)
PASS (send PASSword)
LOUT (LogOUT)
IDEN (IDENtify the client software)
IPGM (identify as an Internal ProGraM)
QUIT (QUIT)
Email Related
RWHO (Read WHO's online)
QDIR (Query global DIRectory)
AUTO (AUTOcompletion of email addresses)
ISME (find out if an e-mail address IS ME)
INFO (get server INFO)
Connection Related
TERM (TERMinate another session)
REQT (REQuest client Termination)
STLS (Start Transport Layer Security)
GTLS (Get Transport Layer Security Status)
ICAL (Internet CALendaring commands)
ICAL test
ICAL respond|msgnum|partnum|action
ICAL conflicts|msgnum|partnum
ICAL handle_rsvp|msgnum|partnum
ICAL freebusy|username
ICAL sgi|<bool>
ICAL getics
ICAL putics
Instant Messaging & Chat Commands
CHAT (enter CHAT mode)
SEXP (Send instant message)
GEXP (Get instant messages)
DEXP (Disable receiving instant messages)
ASYN (ASYNchronous message support)
ASYNCHRONOUS MESSAGES
902 (instant message arriving)
Manipulating a users Sieve Message Store
MSIV (Manage SIeVe scripts)
MSIV putscript|<scriptname>
MSIV listscripts
MSIV setactive|<scriptname>
MSIV getscript|<scriptname>
MSIV deletescript|<scriptname>
Room and Message Commands
Manipulate data in the current room
GOTO (GOTO a room)
STAT (retrieve name and modification time of current room)
Commands manipulating Messageindex Lists
MSGS (get pointers to MeSsaGeS in this room)
SEEN (set or clear the SEEN flag for a message)
GTSN (GeT the list of SeeN messages)
VIEW (set the VIEW for a room)
SRCH (SeaRCH the message base)
EUID (get message number using an EUID)
Commands manipulating One Message
DELE (DELEte a message)
MOVE (MOVE or copy a message to a different room)
EMSG (Enter a system MeSsaGe)
ENT0 (ENTer message, mode 0)
GVSN (Get Valid Screen Names)
GVEA (Get Valid Email Addresses)
DVCA (Dump VCard Addresses)
Reading a single Message
MSG0 (read MeSsaGe, mode 0)
Message Type Values
MSG2 (read MeSsaGe, mode 2)
MSG3 (read MeSsaGe, mode 3 -- internal command)
MSG4 (read MeSsaGe, mode 4 -- output in preferred MIME format)
Mime related Commands
MSGP (set MeSsaGe Preferred MIME format)
OPNA (OPeN Attachment)
DLAT (DownLoad ATtachment)
Wiki room commands
WIKI (perform operations on WIKI pages)
Rooms and Floor Directory Commands
Floor Commands
LFLR (List all known FLooRs)
CFLR (Create a new FLooR)
KFLR (Kill a FLooR)
EFLR (Edit a FLooR)
List Commands
LKRN (List Known Rooms with New messages)
LKRO (List Known Rooms with Old [no new] messages)
LZRM (List Zapped RooMs)
LKRA (List All Known Rooms)
LRMS (List all accessible RooMS)
LPRM (List all Public RooMs)
Commands manipulaing One rooom
RDIR (Read room DIRectory)
SLRP (Set Last-message-Read Pointer)
GETR (GET Room attributes)
SETR (SET Room attributes)
RINF (read Room INFormation file)
GETA
SETA
KILL (KILL current room)
CRE8 (CRE[ate] a new room)
FORG (FORGet the current room)
EINF (Enter INFo file for room)
LIST (user LISTing)
INVT (INViTe a user to a room)
WHOK (WHO Knows room)
KICK (KICK a user out of a room)
Files belonging to rooms
DELF (DELete a File)
MOVF (MOVe a File)
OPEN (OPEN a file for download)
CLOS (CLOSe the download file)
READ (READ from the download file)
UOPN (OPeN a file for Uploading)
UCLS (CLoSe the Upload file)
WRIT (WRITe to the upload file)
UIMG (Upload an IMaGe file)
OIMG (Open an IMaGe file)
DLRI (DownLoad Room Image)
ULRI (UpLoad Room Image)
Commands that change the behavior of this Citadel System
Overall Configuration
IGAB (Initialize Global Address Book)
CONF (get or set global CONFiguration options)
Autopurger Related
GPEX (Get Policy for message EXpiration)
SPEX (Set Policy for message EXpiration)
TDAP (manually initate The Dreaded Auto Purger)
Server Maintainance Commands
RSEN Retrieve Seen Status
GET|<msgid>
SET|<MSGID>|timestamp
DEL|<MSGID|
SMTP (utility commands for the SMTP gateway)
DOWN (shut DOWN the server)
SCDN (Schedule or Cancel a shutDowN)
HALT (HALT the server without shutting it down)
LOGP (LOGging configuration Print)
LOGS (LOGging configuration Set)
MIGR (Migration & system repair)
listdirs
export
import
restoremeta
User Related Commands
Session authentication
USER (send USER name)
PASS (send PASSword)
NEWU (create NEW User account)
CREU (CREate new User account)
VALI (VALIdate user)
QUSR (Query for a USeR)
LIST (user LISTing)
Manipulate existing users
SETP (SET new Password)
GETU (GET User configuration)
SETU (SET User configuration)
EBIO (Enter BIOgraphy)
RBIO (Read BIOgraphy)
DLUI (DownLoad User Image)
ULUI (UpLoad User Image)
AGUP | ASUP (Administrative Get / Set User Parameters)
AGEA (Administrative Get Email Addresses)
ASEA (Administrative Set Email Addresses)
RENU (REName a User)
GETU (GET User configuration)
SETU (SET User configuration)
GNUR (Get Next Unvalidated User)
GREG (Get REGistration for user)
REGI (send REGIstration)
CHEK (CHEcK various things)
Runtime Attribute Manipulation
HCHG (Hostname CHanGe)
RCHG (Roomname CHanGe)
UCHG (Username CHanGe)
STEL (enter STEaLth mode)
Copyright © 1987-2020 Uncensored Communications Group. All rights reserved.
Login (site admin)
