Back to index

citadel  8.12
Classes | Defines | Typedefs | Enumerations
citadel.h File Reference
#include "sysdep.h"
#include <limits.h>
#include "sysconfig.h"
#include "typesize.h"
#include "ipcdef.h"

Go to the source code of this file.

Classes

struct  ExpirePolicy
struct  march
struct  ctdluser
struct  ctdlroom
struct  floor

Defines

#define CITADEL   PACKAGE_STRING
#define REV_LEVEL   812 /* This version */
#define REV_MIN   591 /* Oldest compatible database */
#define EXPORT_REV_MIN   760 /* Oldest compatible export files */
#define LIBCITADEL_MIN   812 /* Minimum required version of libcitadel */
#define SERVER_TYPE
#define UGLISTLEN   100 /* you get a ungoto list of this size */
#define ROOMNAMELEN   128 /* The size of a roomname string */
#define NONCE_SIZE
#define USERNAME_SIZE   64 /* The size of a username string */
#define MAX_EDITORS   5 /* # of external editors supported */
#define EXPIRE_NEXTLEVEL   0 /* Inherit expiration policy */
#define EXPIRE_MANUAL   1 /* Don't expire messages at all */
#define EXPIRE_NUMMSGS   2 /* Keep only latest n messages */
#define EXPIRE_AGE   3 /* Expire messages after n days */
#define NODENAME   config.c_nodename
#define FQDN   config.c_fqdn
#define HUMANNODE   config.c_humannode
#define PHONENUM   config.c_phonenum
#define CTDLUID   config.c_ctdluid
#define CREATAIDE   config.c_creataide
#define REGISCALL   config.c_regiscall
#define TWITDETECT   config.c_twitdetect
#define TWITROOM   config.c_twitroom
#define RESTRICT_INTERNET   config.c_restrict
#define MM_VALID   4 /* New users need validating */
#define MES_NORMAL   65 /* Normal message */
#define MES_ANONONLY   66 /* "****" header */
#define MES_ANONOPT   67 /* "Anonymous" header */
#define MES_ERROR   (-1) /* Can't send message due to bad address */
#define MES_LOCAL   0 /* Local message, do no network processing */
#define MES_INTERNET   1 /* Convert msg and send as Internet mail */
#define MES_IGNET   2 /* Process recipient and send via Cit net */
#define F_INUSE   1 /* floor is in use */
#define NEWREGISTER   0 /* new user to register */
#define REREGISTER   1 /* existing user reregistering */
#define READ_HEADER   2
#define READ_MSGBODY   3
#define SB_NO_INTR   0 /* set to Citadel client mode, i/q disabled */
#define SB_YES_INTR   1 /* set to Citadel client mode, i/q enabled */
#define SB_SAVE   2 /* save settings */
#define SB_RESTORE   3 /* restore settings */
#define SB_LAST   4 /* redo the last command sent */
#define NEXT_KEY   15
#define STOP_KEY   3
#define RC_NO   0 /* always no */
#define RC_YES   1 /* always yes */
#define RC_DEFAULT   2 /* setting depends on user config */
#define GF_GOTO   0 /* <;G>oto floor mode */
#define GF_SKIP   1 /* <;S>kip floor mode */
#define GF_ZAP   2 /* <;Z>ap floor mode */
#define NUM_CONFIGS   70
#define SPOOLMIME   "application/x-citadel-delivery-list"
#define INTERNETCFG   "application/x-citadel-internet-config"
#define IGNETCFG   "application/x-citadel-ignet-config"
#define IGNETMAP   "application/x-citadel-ignet-map"
#define FILTERLIST   "application/x-citadel-filter-list"
#define SIEVECONFIG   "application/x-citadel-sieve-config"
#define XMPPMORTUARY   "application/x-citadel-xmpp-mortuary"
#define TRACE   syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
#define LONG_MAX   2147483647L
#define AUTHMODE_NATIVE   0 /* Native (self-contained or "black box") */
#define AUTHMODE_HOST   1 /* Authenticate against the host OS user database */
#define AUTHMODE_LDAP   2 /* Authenticate against an LDAP server with RFC 2307 schema */
#define AUTHMODE_LDAP_AD   3 /* Authenticate against non-standard MS Active Directory LDAP */

Typedefs

typedef struct ExpirePolicy
typedef struct march
typedef struct ctdluser
typedef struct ctdlroom
typedef struct floor

Enumerations

enum  { KA_NO, KA_YES, KA_HALF }

Class Documentation

struct ExpirePolicy

Definition at line 75 of file citadel.h.

Class Members
int expire_mode
int expire_value
struct march

Definition at line 92 of file citadel.h.

Collaboration diagram for march:
Class Members
int march_access
unsigned int march_flags
unsigned int march_flags2
char march_floor
char march_name
char march_order
struct march * next
struct ctdluser

Definition at line 117 of file citadel.h.

Class Members
cit_uint8_t axlevel
unsigned flags
char fullname
time_t lastcall
char password
long posted
long timescalled
uid_t uid
long usernum
int USuserpurge
int version
struct ctdlroom

Definition at line 142 of file citadel.h.

Class Members
int QRdefaultview
char QRdirname
unsigned QRflags
unsigned QRflags2
char QRfloor
time_t QRgen
long QRhighest
long QRinfo
time_t QRmtime
char QRname
long QRnumber
char QRorder
char QRpasswd
long QRroomaide
struct floor

Definition at line 184 of file citadel.h.

Class Members
unsigned short f_flags
char f_name
int f_ref_count

Define Documentation

#define AUTHMODE_HOST   1 /* Authenticate against the host OS user database */

Definition at line 255 of file citadel.h.

#define AUTHMODE_LDAP   2 /* Authenticate against an LDAP server with RFC 2307 schema */

Definition at line 256 of file citadel.h.

#define AUTHMODE_LDAP_AD   3 /* Authenticate against non-standard MS Active Directory LDAP */

Definition at line 257 of file citadel.h.

#define AUTHMODE_NATIVE   0 /* Native (self-contained or "black box") */

Definition at line 254 of file citadel.h.

#define CITADEL   PACKAGE_STRING

Definition at line 36 of file citadel.h.

Definition at line 107 of file citadel.h.

#define CTDLUID   config.c_ctdluid

Definition at line 106 of file citadel.h.

#define EXPIRE_AGE   3 /* Expire messages after n days */

Definition at line 83 of file citadel.h.

#define EXPIRE_MANUAL   1 /* Don't expire messages at all */

Definition at line 81 of file citadel.h.

#define EXPIRE_NEXTLEVEL   0 /* Inherit expiration policy */

Definition at line 80 of file citadel.h.

#define EXPIRE_NUMMSGS   2 /* Keep only latest n messages */

Definition at line 82 of file citadel.h.

#define EXPORT_REV_MIN   760 /* Oldest compatible export files */

Definition at line 50 of file citadel.h.

#define F_INUSE   1 /* floor is in use */

Definition at line 191 of file citadel.h.

#define FILTERLIST   "application/x-citadel-filter-list"

Definition at line 241 of file citadel.h.

#define FQDN   config.c_fqdn

Definition at line 103 of file citadel.h.

#define GF_GOTO   0 /* <;G>oto floor mode */

Definition at line 227 of file citadel.h.

#define GF_SKIP   1 /* <;S>kip floor mode */

Definition at line 228 of file citadel.h.

#define GF_ZAP   2 /* <;Z>ap floor mode */

Definition at line 229 of file citadel.h.

Definition at line 104 of file citadel.h.

#define IGNETCFG   "application/x-citadel-ignet-config"

Definition at line 239 of file citadel.h.

#define IGNETMAP   "application/x-citadel-ignet-map"

Definition at line 240 of file citadel.h.

#define INTERNETCFG   "application/x-citadel-internet-config"

Definition at line 238 of file citadel.h.

#define LIBCITADEL_MIN   812 /* Minimum required version of libcitadel */

Definition at line 51 of file citadel.h.

#define LONG_MAX   2147483647L

Definition at line 248 of file citadel.h.

#define MAX_EDITORS   5 /* # of external editors supported */

Definition at line 68 of file citadel.h.

#define MES_ANONONLY   66 /* "****" header */

Definition at line 170 of file citadel.h.

#define MES_ANONOPT   67 /* "Anonymous" header */

Definition at line 171 of file citadel.h.

#define MES_ERROR   (-1) /* Can't send message due to bad address */

Definition at line 173 of file citadel.h.

#define MES_IGNET   2 /* Process recipient and send via Cit net */

Definition at line 176 of file citadel.h.

#define MES_INTERNET   1 /* Convert msg and send as Internet mail */

Definition at line 175 of file citadel.h.

#define MES_LOCAL   0 /* Local message, do no network processing */

Definition at line 174 of file citadel.h.

#define MES_NORMAL   65 /* Normal message */

Definition at line 169 of file citadel.h.

#define MM_VALID   4 /* New users need validating */

Definition at line 136 of file citadel.h.

#define NEWREGISTER   0 /* new user to register */

Definition at line 198 of file citadel.h.

#define NEXT_KEY   15

Definition at line 211 of file citadel.h.

Definition at line 102 of file citadel.h.

#define NONCE_SIZE
Value:
128    /* Added by <bc> to allow for APOP auth 
                             * it is BIG becuase there is a hostname
                             * in the nonce, as per the APOP RFC.
                             */

Definition at line 65 of file citadel.h.

#define NUM_CONFIGS   70

Definition at line 232 of file citadel.h.

Definition at line 105 of file citadel.h.

#define RC_DEFAULT   2 /* setting depends on user config */

Definition at line 217 of file citadel.h.

#define RC_NO   0 /* always no */

Definition at line 215 of file citadel.h.

#define RC_YES   1 /* always yes */

Definition at line 216 of file citadel.h.

#define READ_HEADER   2

Definition at line 201 of file citadel.h.

#define READ_MSGBODY   3

Definition at line 202 of file citadel.h.

Definition at line 108 of file citadel.h.

#define REREGISTER   1 /* existing user reregistering */

Definition at line 199 of file citadel.h.

Definition at line 111 of file citadel.h.

#define REV_LEVEL   812 /* This version */

Definition at line 48 of file citadel.h.

#define REV_MIN   591 /* Oldest compatible database */

Definition at line 49 of file citadel.h.

#define ROOMNAMELEN   128 /* The size of a roomname string */

Definition at line 64 of file citadel.h.

#define SB_LAST   4 /* redo the last command sent */

Definition at line 209 of file citadel.h.

#define SB_NO_INTR   0 /* set to Citadel client mode, i/q disabled */

Definition at line 205 of file citadel.h.

#define SB_RESTORE   3 /* restore settings */

Definition at line 208 of file citadel.h.

#define SB_SAVE   2 /* save settings */

Definition at line 207 of file citadel.h.

#define SB_YES_INTR   1 /* set to Citadel client mode, i/q enabled */

Definition at line 206 of file citadel.h.

#define SERVER_TYPE
Value:
0                    /* zero for stock Citadel; other developers please
                                      obtain SERVER_TYPE codes for your implementations */

Definition at line 53 of file citadel.h.

#define SIEVECONFIG   "application/x-citadel-sieve-config"

Definition at line 242 of file citadel.h.

#define SPOOLMIME   "application/x-citadel-delivery-list"

Definition at line 237 of file citadel.h.

#define STOP_KEY   3

Definition at line 212 of file citadel.h.

#define TRACE   syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)

Definition at line 245 of file citadel.h.

Definition at line 109 of file citadel.h.

Definition at line 110 of file citadel.h.

#define UGLISTLEN   100 /* you get a ungoto list of this size */

Definition at line 63 of file citadel.h.

#define USERNAME_SIZE   64 /* The size of a username string */

Definition at line 67 of file citadel.h.

#define XMPPMORTUARY   "application/x-citadel-xmpp-mortuary"

Definition at line 243 of file citadel.h.


Typedef Documentation

typedef struct ctdlroom

Definition at line 141 of file citadel.h.

typedef struct ctdluser

Definition at line 116 of file citadel.h.

typedef struct ExpirePolicy

Definition at line 74 of file citadel.h.

typedef struct floor

Definition at line 183 of file citadel.h.

typedef struct march

Definition at line 91 of file citadel.h.


Enumeration Type Documentation

anonymous enum
Enumerator:
KA_NO 
KA_YES 
KA_HALF 

Definition at line 220 of file citadel.h.

     {