2 * IMAP server for the Citadel system
4 * Copyright (C) 2000-2011 by Art Cancro and others.
5 * This code is released under the terms of the GNU General Public License.
7 * WARNING: the IMAP protocol is badly designed. No implementation of it
8 * is perfect. Indeed, with so much gratuitous complexity, *all* IMAP
9 * implementations have bugs.
11 * This program is open source software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <sys/types.h>
36 #if TIME_WITH_SYS_TIME
37 # include <sys/time.h>
41 # include <sys/time.h>
51 #include <libcitadel.h>
54 #include "citserver.h"
60 #include "internet_addressing.h"
61 #include "serv_imap.h"
62 #include "imap_tools.h"
63 #include "imap_list.h"
64 #include "imap_fetch.h"
65 #include "imap_search.h"
66 #include "imap_store.h"
68 #include "imap_metadata.h"
69 #include "imap_misc.h"
71 #include "ctdl_module.h"
73 HashList *ImapCmds = NULL;
74 void registerImapCMD(const char *First, long FLen,
75 const char *Second, long SLen,
81 h = (imap_handler_hook*) malloc(sizeof(imap_handler_hook));
82 memset(h, 0, sizeof(imap_handler_hook));
87 Put(ImapCmds, First, FLen, h, NULL);
91 memcpy(CMD, First, FLen);
92 memcpy(CMD+FLen, Second, SLen);
93 CMD[FLen+SLen] = '\0';
94 Put(ImapCmds, CMD, FLen + SLen, h, NULL);
98 void imap_cleanup(void)
100 DeleteHash(&ImapCmds);
103 const imap_handler_hook *imap_lookup(int num_parms, ConstStr *Params)
106 citimap *Imap = IMAP;
111 /* we abuse the Reply-buffer for uppercasing... */
112 StrBufPlain(Imap->Reply, CKEY(Params[1]));
113 StrBufUpCase(Imap->Reply);
115 syslog(LOG_DEBUG, "---- Looking up [%s] -----",
116 ChrPtr(Imap->Reply));
117 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v))
119 syslog(LOG_DEBUG, "Found.");
120 FlushStrBuf(Imap->Reply);
121 return (imap_handler_hook *) v;
126 syslog(LOG_DEBUG, "NOT Found.");
127 FlushStrBuf(Imap->Reply);
131 syslog(LOG_DEBUG, "---- Looking up [%s] -----",
132 ChrPtr(Imap->Reply));
133 StrBufAppendBufPlain(Imap->Reply, CKEY(Params[2]), 0);
134 StrBufUpCase(Imap->Reply);
135 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v))
137 syslog(LOG_DEBUG, "Found.");
138 FlushStrBuf(Imap->Reply);
139 return (imap_handler_hook *) v;
141 syslog(LOG_DEBUG, "NOT Found.");
142 FlushStrBuf(Imap->Reply);
146 /* imap_rename() uses this struct containing list of rooms to rename */
149 char irl_oldroom[ROOMNAMELEN];
150 char irl_newroom[ROOMNAMELEN];
154 /* Data which is passed between imap_rename() and imap_rename_backend() */
163 * If there is a message ID map in memory, free it
165 void imap_free_msgids(void)
167 citimap *Imap = IMAP;
168 if (Imap->msgids != NULL) {
174 if (Imap->flags != NULL) {
178 Imap->last_mtime = (-1);
183 * If there is a transmitted message in memory, free it
185 void imap_free_transmitted_message(void)
187 FreeStrBuf(&IMAP->TransmittedMessage);
192 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
193 * sets stored in the visit record for this user/room. Note that we have
194 * to parse each sequence set manually here, because calling the utility
195 * function is_msg_in_sequence_set() over and over again is too expensive.
197 * first_msg should be set to 0 to rescan the flags for every message in the
198 * room, or some other value if we're only interested in an incremental
201 void imap_set_seen_flags(int first_msg)
203 citimap *Imap = IMAP;
208 char setstr[64], lostr[64], histr[64];
211 if (Imap->num_msgs < 1) return;
212 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
214 for (i = first_msg; i < Imap->num_msgs; ++i) {
215 Imap->flags[i] = Imap->flags[i] & ~IMAP_SEEN;
216 Imap->flags[i] |= IMAP_RECENT;
217 Imap->flags[i] = Imap->flags[i] & ~IMAP_ANSWERED;
221 * Do the "\Seen" flag.
222 * (Any message not "\Seen" is considered "\Recent".)
224 num_sets = num_tokens(vbuf.v_seen, ',');
225 for (s=0; s<num_sets; ++s) {
226 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
228 extract_token(lostr, setstr, 0, ':', sizeof lostr);
229 if (num_tokens(setstr, ':') >= 2) {
230 extract_token(histr, setstr, 1, ':', sizeof histr);
231 if (!strcmp(histr, "*")) {
232 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
236 strcpy(histr, lostr);
241 for (i = first_msg; i < Imap->num_msgs; ++i) {
242 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
243 Imap->flags[i] |= IMAP_SEEN;
244 Imap->flags[i] = Imap->flags[i] & ~IMAP_RECENT;
249 /* Do the ANSWERED flag */
250 num_sets = num_tokens(vbuf.v_answered, ',');
251 for (s=0; s<num_sets; ++s) {
252 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
254 extract_token(lostr, setstr, 0, ':', sizeof lostr);
255 if (num_tokens(setstr, ':') >= 2) {
256 extract_token(histr, setstr, 1, ':', sizeof histr);
257 if (!strcmp(histr, "*")) {
258 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
262 strcpy(histr, lostr);
267 for (i = first_msg; i < Imap->num_msgs; ++i) {
268 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
269 Imap->flags[i] |= IMAP_ANSWERED;
279 * Back end for imap_load_msgids()
281 * Optimization: instead of calling realloc() to add each message, we
282 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
283 * allows the mapping to proceed much faster.
285 void imap_add_single_msgid(long msgnum, void *userdata)
287 citimap *Imap = IMAP;
290 if (Imap->num_msgs > Imap->num_alloc) {
291 Imap->num_alloc += REALLOC_INCREMENT;
292 Imap->msgids = realloc(Imap->msgids, (Imap->num_alloc * sizeof(long)) );
293 Imap->flags = realloc(Imap->flags, (Imap->num_alloc * sizeof(long)) );
295 Imap->msgids[Imap->num_msgs - 1] = msgnum;
296 Imap->flags[Imap->num_msgs - 1] = 0;
302 * Set up a message ID map for the current room (folder)
304 void imap_load_msgids(void)
306 struct cdbdata *cdbfr;
307 citimap *Imap = IMAP;
309 if (Imap->selected == 0) {
310 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
314 imap_free_msgids(); /* If there was already a map, free it */
316 /* Load the message list */
317 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
319 Imap->msgids = malloc(cdbfr->len);
320 memcpy(Imap->msgids, cdbfr->ptr, cdbfr->len);
321 Imap->num_msgs = cdbfr->len / sizeof(long);
322 Imap->num_alloc = cdbfr->len / sizeof(long);
326 if (Imap->num_msgs) {
327 Imap->flags = malloc(Imap->num_alloc * sizeof(long));
328 memset(Imap->flags, 0, (Imap->num_alloc * sizeof(long)) );
331 imap_set_seen_flags(0);
336 * Re-scan the selected room (folder) and see if it's been changed at all
338 void imap_rescan_msgids(void)
340 citimap *Imap = IMAP;
341 int original_num_msgs = 0;
342 long original_highest = 0L;
344 int message_still_exists;
345 struct cdbdata *cdbfr;
346 long *msglist = NULL;
350 if (Imap->selected == 0) {
351 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
356 * Check to see if the room's contents have changed.
357 * If not, we can avoid this rescan.
359 CtdlGetRoom(&CC->room, CC->room.QRname);
360 if (Imap->last_mtime == CC->room.QRmtime) { /* No changes! */
364 /* Load the *current* message list from disk, so we can compare it
365 * to what we have in memory.
367 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
369 msglist = malloc(cdbfr->len);
370 if (msglist == NULL) {
371 syslog(LOG_CRIT, "IMAP: malloc() failed");
372 CC->kill_me = KILLME_MALLOC_FAILED;
375 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
376 num_msgs = cdbfr->len / sizeof(long);
383 * Check to see if any of the messages we know about have been expunged
385 if (Imap->num_msgs > 0) {
387 for (i = 0; i < Imap->num_msgs; ++i) {
389 message_still_exists = 0;
391 for (j = jstart; j < num_msgs; ++j) {
392 if (msglist[j] == Imap->msgids[i]) {
393 message_still_exists = 1;
400 if (message_still_exists == 0) {
401 IAPrintf("* %d EXPUNGE\r\n", i + 1);
403 /* Here's some nice stupid nonsense. When a
404 * message is expunged, we have to slide all
405 * the existing messages up in the message
409 memcpy(&Imap->msgids[i],
410 &Imap->msgids[i + 1],
412 (Imap->num_msgs - i)));
413 memcpy(&Imap->flags[i],
416 (Imap->num_msgs - i)));
425 * Remember how many messages were here before we re-scanned.
427 original_num_msgs = Imap->num_msgs;
428 if (Imap->num_msgs > 0) {
429 original_highest = Imap->msgids[Imap->num_msgs - 1];
431 original_highest = 0L;
435 * Now peruse the room for *new* messages only.
436 * This logic is probably the cause of Bug # 368
437 * [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
440 for (j = 0; j < num_msgs; ++j) {
441 if (msglist[j] > original_highest) {
442 imap_add_single_msgid(msglist[j], NULL);
446 imap_set_seen_flags(original_num_msgs);
449 * If new messages have arrived, tell the client about them.
451 if (Imap->num_msgs > original_num_msgs) {
453 for (j = 0; j < num_msgs; ++j) {
454 if (Imap->flags[j] & IMAP_RECENT) {
459 IAPrintf("* %d EXISTS\r\n", Imap->num_msgs);
460 IAPrintf("* %d RECENT\r\n", num_recent);
466 Imap->last_mtime = CC->room.QRmtime;
471 * This cleanup function blows away the temporary memory and files used by
474 void imap_cleanup_function(void)
476 citimap *Imap = IMAP;
478 /* Don't do this stuff if this is not a Imap session! */
479 if (CC->h_command_function != imap_command_loop)
482 /* If there is a mailbox selected, auto-expunge it. */
483 if (Imap->selected) {
487 syslog(LOG_DEBUG, "Performing IMAP cleanup hook");
489 imap_free_transmitted_message();
491 if (Imap->cached_rfc822 != NULL) {
492 FreeStrBuf(&Imap->cached_rfc822);
493 Imap->cached_rfc822_msgnum = (-1);
494 Imap->cached_rfc822_withbody = 0;
497 if (Imap->cached_body != NULL) {
498 free(Imap->cached_body);
499 Imap->cached_body = NULL;
500 Imap->cached_body_len = 0;
501 Imap->cached_bodymsgnum = (-1);
503 FreeStrBuf(&Imap->Cmd.CmdBuf);
504 FreeStrBuf(&Imap->Reply);
505 if (Imap->Cmd.Params != NULL) free(Imap->Cmd.Params);
507 syslog(LOG_DEBUG, "Finished IMAP cleanup hook");
512 * Does the actual work of the CAPABILITY command (because we need to
513 * output this stuff in other places as well)
515 void imap_output_capability_string(void) {
516 IAPuts("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
519 if (!CC->redirect_ssl) IAPuts(" STARTTLS");
522 #ifndef DISABLE_IMAP_ACL
526 /* We are building a partial implementation of METADATA for the sole purpose
527 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
528 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
529 * metadata in a compatible and graceful way.
534 * LIST-EXTENDED was originally going to be required by the METADATA extension.
535 * It was mercifully removed prior to the finalization of RFC5464. We started
536 * implementing this but stopped when we learned that it would not be needed.
537 * If you uncomment this declaration you are responsible for writing a lot of new
540 * IAPuts(" LIST-EXTENDED")
546 * implements the CAPABILITY command
548 void imap_capability(int num_parms, ConstStr *Params)
551 imap_output_capability_string();
553 IReply("OK CAPABILITY completed");
558 * Implements the ID command (specified by RFC2971)
560 * We ignore the client-supplied information, and output a NIL response.
561 * Although this is technically a valid implementation of the extension, it
562 * is quite useless. It exists only so that we may see which clients are
563 * making use of this extension.
566 void imap_id(int num_parms, ConstStr *Params)
568 IAPuts("* ID NIL\r\n");
569 IReply("OK ID completed");
574 * Here's where our IMAP session begins its happy day.
576 void imap_greeting(void)
579 CitContext *CCC = CC;
581 strcpy(CCC->cs_clientname, "IMAP session");
582 CCC->session_specific_data = malloc(sizeof(citimap));
583 Imap = (citimap *)CCC->session_specific_data;
584 memset(Imap, 0, sizeof(citimap));
585 Imap->authstate = imap_as_normal;
586 Imap->cached_rfc822_msgnum = (-1);
587 Imap->cached_rfc822_withbody = 0;
588 Imap->Reply = NewStrBufPlain(NULL, SIZ * 10); /* 40k */
592 IAPuts("* BYE; Server busy, try later\r\n");
593 CCC->kill_me = KILLME_NOLOGIN;
599 imap_output_capability_string();
600 IAPrintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
606 * IMAPS is just like IMAP, except it goes crypto right away.
608 void imaps_greeting(void) {
609 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
611 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO; /* kill session if no crypto */
618 * implements the LOGIN command (ordinary username/password login)
620 void imap_login(int num_parms, ConstStr *Params)
625 if (Params[2].Key[0] == '{') {
626 IAPuts("+ go ahead\r\n");
627 IMAP->authstate = imap_as_expecting_multilineusername;
628 strcpy(IMAP->authseq, Params[0].Key);
632 IReply("BAD incorrect number of parameters");
636 if (CtdlLoginExistingUser(NULL, Params[2].Key) == login_ok) {
637 if (CtdlTryPassword(Params[3].Key, Params[3].len) == pass_ok) {
638 /* hm, thats not doable by IReply :-( */
639 IAPrintf("%s OK [", Params[0].Key);
640 imap_output_capability_string();
641 IAPrintf("] Hello, %s\r\n", CC->user.fullname);
646 IReplyPrintf("NO AUTHENTICATE %s failed",
651 IReply("BAD Login incorrect");
653 IReply("BAD incorrect number of parameters");
661 * Implements the AUTHENTICATE command
663 void imap_authenticate(int num_parms, ConstStr *Params)
667 if (num_parms != 3) {
668 IReply("BAD incorrect number of parameters");
673 IReply("BAD Already logged in.");
677 if (!strcasecmp(Params[2].Key, "LOGIN")) {
678 CtdlEncodeBase64(UsrBuf, "Username:", 9, 0);
679 IAPrintf("+ %s\r\n", UsrBuf);
680 IMAP->authstate = imap_as_expecting_username;
681 strcpy(IMAP->authseq, Params[0].Key);
685 if (!strcasecmp(Params[2].Key, "PLAIN")) {
686 // CtdlEncodeBase64(UsrBuf, "Username:", 9, 0);
687 // IAPuts("+ %s\r\n", UsrBuf);
689 IMAP->authstate = imap_as_expecting_plainauth;
690 strcpy(IMAP->authseq, Params[0].Key);
695 IReplyPrintf("NO AUTHENTICATE %s failed",
701 void imap_auth_plain(void)
703 citimap *Imap = IMAP;
704 const char *decoded_authstring;
711 memset(pass, 0, sizeof(pass));
712 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
714 decoded_authstring = ChrPtr(Imap->Cmd.CmdBuf);
715 safestrncpy(ident, decoded_authstring, sizeof ident);
716 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
717 len = safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
719 len = sizeof(pass) - 1;
721 Imap->authstate = imap_as_normal;
723 if (!IsEmptyStr(ident)) {
724 result = CtdlLoginExistingUser(user, ident);
727 result = CtdlLoginExistingUser(NULL, user);
730 if (result == login_ok) {
731 if (CtdlTryPassword(pass, len) == pass_ok) {
732 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
736 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
740 void imap_auth_login_user(long state)
743 citimap *Imap = IMAP;
746 case imap_as_expecting_username:
747 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
748 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
749 CtdlEncodeBase64(PWBuf, "Password:", 9, 0);
750 IAPrintf("+ %s\r\n", PWBuf);
752 Imap->authstate = imap_as_expecting_password;
754 case imap_as_expecting_multilineusername:
755 extract_token(PWBuf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(PWBuf));
756 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
757 IAPuts("+ go ahead\r\n");
758 Imap->authstate = imap_as_expecting_multilinepassword;
764 void imap_auth_login_pass(long state)
766 citimap *Imap = IMAP;
767 const char *pass = NULL;
772 case imap_as_expecting_password:
773 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
774 pass = ChrPtr(Imap->Cmd.CmdBuf);
775 len = StrLength(Imap->Cmd.CmdBuf);
777 case imap_as_expecting_multilinepassword:
778 pass = ChrPtr(Imap->Cmd.CmdBuf);
779 len = StrLength(Imap->Cmd.CmdBuf);
782 if (len > USERNAME_SIZE)
783 StrBufCutAt(Imap->Cmd.CmdBuf, USERNAME_SIZE, NULL);
785 if (CtdlTryPassword(pass, len) == pass_ok) {
786 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
788 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
790 Imap->authstate = imap_as_normal;
796 * implements the STARTTLS command (Citadel API version)
798 void imap_starttls(int num_parms, ConstStr *Params)
800 char ok_response[SIZ];
801 char nosup_response[SIZ];
802 char error_response[SIZ];
804 snprintf(ok_response, SIZ, "%s OK begin TLS negotiation now\r\n", Params[0].Key);
805 snprintf(nosup_response, SIZ, "%s NO TLS not supported here\r\n", Params[0].Key);
806 snprintf(error_response, SIZ, "%s BAD Internal error\r\n", Params[0].Key);
807 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
812 * implements the SELECT command
814 void imap_select(int num_parms, ConstStr *Params)
816 citimap *Imap = IMAP;
817 char towhere[ROOMNAMELEN];
818 char augmented_roomname[ROOMNAMELEN];
822 struct ctdlroom QRscratch;
828 /* Convert the supplied folder name to a roomname */
829 i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
831 IReply("NO Invalid mailbox name.");
835 floornum = (i & 0x00ff);
836 roomflags = (i & 0xff00);
838 /* First try a regular match */
839 c = CtdlGetRoom(&QRscratch, towhere);
841 /* Then try a mailbox name match */
843 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
844 c = CtdlGetRoom(&QRscratch, augmented_roomname);
846 safestrncpy(towhere, augmented_roomname, sizeof(towhere));
850 /* If the room exists, check security/access */
852 /* See if there is an existing user/room relationship */
853 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
855 /* normal clients have to pass through security */
861 /* Fail here if no such room */
863 IReply("NO ... no such room, or access denied");
867 /* If we already had some other folder selected, auto-expunge it */
871 * CtdlUserGoto() formally takes us to the desired room, happily returning
872 * the number of messages and number of new messages.
874 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
875 CtdlUserGoto(NULL, 0, 0, &msgs, &new);
878 if (!strcasecmp(Params[1].Key, "EXAMINE")) {
885 Imap->last_mtime = CC->room.QRmtime;
887 IAPrintf("* %d EXISTS\r\n", msgs);
888 IAPrintf("* %d RECENT\r\n", new);
890 IAPrintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
891 IAPrintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
893 /* Technically, \Deleted is a valid flag, but not a permanent flag,
894 * because we don't maintain its state across sessions. Citadel
895 * automatically expunges mailboxes when they are de-selected.
897 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
898 * some clients (particularly Thunderbird) to misbehave -- they simply
899 * elect not to transmit the flag at all. So we have to advertise
900 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
902 IAPuts("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
903 IAPuts("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
905 IReplyPrintf("OK [%s] %s completed",
906 (Imap->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key
912 * Does the real work for expunge.
914 int imap_do_expunge(void)
916 citimap *Imap = IMAP;
918 int num_expunged = 0;
919 long *delmsgs = NULL;
922 syslog(LOG_DEBUG, "imap_do_expunge() called");
923 if (Imap->selected == 0) {
927 if (Imap->num_msgs > 0) {
928 delmsgs = malloc(Imap->num_msgs * sizeof(long));
929 for (i = 0; i < Imap->num_msgs; ++i) {
930 if (Imap->flags[i] & IMAP_DELETED) {
931 delmsgs[num_delmsgs++] = Imap->msgids[i];
934 if (num_delmsgs > 0) {
935 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
937 num_expunged += num_delmsgs;
941 if (num_expunged > 0) {
942 imap_rescan_msgids();
945 syslog(LOG_DEBUG, "Expunged %d messages from <%s>", num_expunged, CC->room.QRname);
946 return (num_expunged);
951 * implements the EXPUNGE command syntax
953 void imap_expunge(int num_parms, ConstStr *Params)
955 int num_expunged = 0;
957 num_expunged = imap_do_expunge();
958 IReplyPrintf("OK expunged %d messages.", num_expunged);
963 * implements the CLOSE command
965 void imap_close(int num_parms, ConstStr *Params)
968 /* Yes, we always expunge on close. */
969 if (IMAP->selected) {
976 IReply("OK CLOSE completed");
981 * Implements the NAMESPACE command.
983 void imap_namespace(int num_parms, ConstStr *Params)
990 IAPuts("* NAMESPACE ");
992 /* All personal folders are subordinate to INBOX. */
993 IAPuts("((\"INBOX/\" \"/\")) ");
995 /* Other users' folders ... coming soon! FIXME */
998 /* Show all floors as shared namespaces. Neato! */
1000 for (i = 0; i < MAXFLOORS; ++i) {
1001 fl = CtdlGetCachedFloor(i);
1002 if (fl->f_flags & F_INUSE) {
1003 /* if (floors > 0) IAPuts(" "); samjam says this confuses javamail */
1005 snprintf(Namespace, sizeof(Namespace), "%s/", fl->f_name);
1006 plain_imap_strout(Namespace);
1013 /* Wind it up with a newline and a completion message. */
1015 IReply("OK NAMESPACE completed");
1020 * Implements the CREATE command
1023 void imap_create(int num_parms, ConstStr *Params)
1026 char roomname[ROOMNAMELEN];
1029 int newroomtype = 0;
1030 int newroomview = 0;
1031 char *notification_message = NULL;
1033 if (num_parms < 3) {
1034 IReply("NO A foder name must be specified");
1038 if (strchr(Params[2].Key, '\\') != NULL) {
1039 IReply("NO Invalid character in folder name");
1040 syslog(LOG_DEBUG, "invalid character in folder name");
1044 ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
1046 IReply("NO Invalid mailbox name or location");
1047 syslog(LOG_DEBUG, "invalid mailbox name or location");
1050 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
1051 flags = (ret & 0xff00); /* upper 8 bits = flags */
1053 if (flags & IR_MAILBOX) {
1054 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
1055 IReply("NO Personal folders must be created under INBOX");
1056 syslog(LOG_DEBUG, "not subordinate to inbox");
1061 if (flags & IR_MAILBOX) {
1062 newroomtype = 4; /* private mailbox */
1063 newroomview = VIEW_MAILBOX;
1065 newroomtype = 0; /* public folder */
1066 newroomview = VIEW_BBS;
1069 syslog(LOG_INFO, "IMAP: Create new room <%s> on floor <%d> with type <%d>",
1070 roomname, floornum, newroomtype);
1072 ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
1074 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
1075 IReply("NO Mailbox already exists, or create failed");
1077 IReply("OK CREATE completed");
1078 /* post a message in Aide> describing the new room */
1079 notification_message = malloc(1024);
1080 snprintf(notification_message, 1024,
1081 "A new room called \"%s\" has been created by %s%s%s%s\n",
1084 ((ret & QR_MAILBOX) ? " [personal]" : ""),
1085 ((ret & QR_PRIVATE) ? " [private]" : ""),
1086 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
1088 CtdlAideMessage(notification_message, "Room Creation Message");
1089 free(notification_message);
1091 syslog(LOG_DEBUG, "imap_create() completed");
1096 * Locate a room by its IMAP folder name, and check access to it.
1097 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1099 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok)
1102 char augmented_roomname[ROOMNAMELEN];
1103 char roomname[ROOMNAMELEN];
1105 struct ctdlroom QRscratch;
1109 ret = imap_roomname(roomname, sizeof roomname, foldername);
1114 /* First try a regular match */
1115 c = CtdlGetRoom(&QRscratch, roomname);
1117 /* Then try a mailbox name match */
1119 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
1120 &CC->user, roomname);
1121 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1123 safestrncpy(roomname, augmented_roomname, sizeof(roomname));
1126 /* If the room exists, check security/access */
1128 /* See if there is an existing user/room relationship */
1129 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1131 /* normal clients have to pass through security */
1132 if (ra & UA_KNOWN) {
1135 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1140 /* Fail here if no such room */
1142 strcpy(returned_roomname, "");
1145 safestrncpy(returned_roomname, QRscratch.QRname, ROOMNAMELEN);
1152 * Implements the STATUS command (sort of)
1155 void imap_status(int num_parms, ConstStr *Params)
1158 char roomname[ROOMNAMELEN];
1159 char imaproomname[SIZ];
1160 char savedroom[ROOMNAMELEN];
1163 ret = imap_grabroom(roomname, Params[2].Key, 1);
1165 IReply("NO Invalid mailbox name or location, or access denied");
1170 * CtdlUserGoto() formally takes us to the desired room, happily returning
1171 * the number of messages and number of new messages. (If another
1172 * folder is selected, save its name so we can return there!!!!!)
1174 if (IMAP->selected) {
1175 strcpy(savedroom, CC->room.QRname);
1177 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1180 * Tell the client what it wants to know. In fact, tell it *more* than
1181 * it wants to know. We happily IGnore the supplied status data item
1182 * names and simply spew all possible data items. It's far easier to
1183 * code and probably saves us some processing time too.
1185 imap_mailboxname(imaproomname, sizeof imaproomname, &CC->room);
1186 IAPuts("* STATUS ");
1187 plain_imap_strout(imaproomname);
1188 IAPrintf(" (MESSAGES %d ", msgs);
1189 IAPrintf("RECENT %d ", new); /* Initially, new==recent */
1190 IAPrintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1191 IAPrintf("UNSEEN %d)\r\n", new);
1194 * If another folder is selected, go back to that room so we can resume
1195 * our happy day without violent explosions.
1197 if (IMAP->selected) {
1198 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1202 * Oooh, look, we're done!
1204 IReply("OK STATUS completed");
1209 * Implements the SUBSCRIBE command
1212 void imap_subscribe(int num_parms, ConstStr *Params)
1215 char roomname[ROOMNAMELEN];
1216 char savedroom[ROOMNAMELEN];
1219 ret = imap_grabroom(roomname, Params[2].Key, 1);
1222 "NO Error %d: invalid mailbox name or location, or access denied",
1229 * CtdlUserGoto() formally takes us to the desired room, which has the side
1230 * effect of marking the room as not-zapped ... exactly the effect
1231 * we're looking for.
1233 if (IMAP->selected) {
1234 strcpy(savedroom, CC->room.QRname);
1236 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1239 * If another folder is selected, go back to that room so we can resume
1240 * our happy day without violent explosions.
1242 if (IMAP->selected) {
1243 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1246 IReply("OK SUBSCRIBE completed");
1251 * Implements the UNSUBSCRIBE command
1254 void imap_unsubscribe(int num_parms, ConstStr *Params)
1257 char roomname[ROOMNAMELEN];
1258 char savedroom[ROOMNAMELEN];
1261 ret = imap_grabroom(roomname, Params[2].Key, 1);
1263 IReply("NO Invalid mailbox name or location, or access denied");
1268 * CtdlUserGoto() formally takes us to the desired room.
1270 if (IMAP->selected) {
1271 strcpy(savedroom, CC->room.QRname);
1273 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1276 * Now make the API call to zap the room
1278 if (CtdlForgetThisRoom() == 0) {
1279 IReply("OK UNSUBSCRIBE completed");
1281 IReply("NO You may not unsubscribe from this folder.");
1285 * If another folder is selected, go back to that room so we can resume
1286 * our happy day without violent explosions.
1288 if (IMAP->selected) {
1289 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1295 * Implements the DELETE command
1298 void imap_delete(int num_parms, ConstStr *Params)
1301 char roomname[ROOMNAMELEN];
1302 char savedroom[ROOMNAMELEN];
1305 ret = imap_grabroom(roomname, Params[2].Key, 1);
1307 IReply("NO Invalid mailbox name, or access denied");
1312 * CtdlUserGoto() formally takes us to the desired room, happily returning
1313 * the number of messages and number of new messages. (If another
1314 * folder is selected, save its name so we can return there!!!!!)
1316 if (IMAP->selected) {
1317 strcpy(savedroom, CC->room.QRname);
1319 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1322 * Now delete the room.
1324 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1325 CtdlScheduleRoomForDeletion(&CC->room);
1326 IReply("OK DELETE completed");
1328 IReply("NO Can't delete this folder.");
1332 * If another folder is selected, go back to that room so we can resume
1333 * our happy day without violent explosions.
1335 if (IMAP->selected) {
1336 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1342 * Back end function for imap_rename()
1344 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1346 char foldername[SIZ];
1347 char newfoldername[SIZ];
1348 char newroomname[ROOMNAMELEN];
1350 struct irl *irlp = NULL; /* scratch pointer */
1351 struct irlparms *irlparms;
1353 irlparms = (struct irlparms *) data;
1354 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1356 /* Rename subfolders */
1357 if ((!strncasecmp(foldername, irlparms->oldname,
1358 strlen(irlparms->oldname))
1359 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1361 sprintf(newfoldername, "%s/%s",
1363 &foldername[strlen(irlparms->oldname) + 1]
1366 newfloor = imap_roomname(newroomname,
1368 newfoldername) & 0xFF;
1370 irlp = (struct irl *) malloc(sizeof(struct irl));
1371 strcpy(irlp->irl_newroom, newroomname);
1372 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1373 irlp->irl_newfloor = newfloor;
1374 irlp->next = *(irlparms->irl);
1375 *(irlparms->irl) = irlp;
1381 * Implements the RENAME command
1384 void imap_rename(int num_parms, ConstStr *Params)
1386 char old_room[ROOMNAMELEN];
1387 char new_room[ROOMNAMELEN];
1391 struct irl *irl = NULL; /* the list */
1392 struct irl *irlp = NULL; /* scratch pointer */
1393 struct irlparms irlparms;
1396 if (strchr(Params[3].Key, '\\') != NULL) {
1397 IReply("NO Invalid character in folder name");
1401 oldr = imap_roomname(old_room, sizeof old_room, Params[2].Key);
1402 newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1403 new_floor = (newr & 0xFF);
1405 r = CtdlRenameRoom(old_room, new_room, new_floor);
1407 if (r == crr_room_not_found) {
1408 IReply("NO Could not locate this folder");
1411 if (r == crr_already_exists) {
1412 IReplyPrintf("NO '%s' already exists.");
1415 if (r == crr_noneditable) {
1416 IReply("NO This folder is not editable.");
1419 if (r == crr_invalid_floor) {
1420 IReply("NO Folder root does not exist.");
1423 if (r == crr_access_denied) {
1424 IReply("NO You do not have permission to edit this folder.");
1428 IReplyPrintf("NO Rename failed - undefined error %d", r);
1432 /* If this is the INBOX, then RFC2060 says we have to just move the
1433 * contents. In a Citadel environment it's easier to rename the room
1434 * (already did that) and create a new inbox.
1436 if (!strcasecmp(Params[2].Key, "INBOX")) {
1437 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1440 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1442 irlparms.oldname = Params[2].Key;
1443 irlparms.newname = Params[3].Key;
1444 irlparms.irl = &irl;
1445 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1447 /* ... and now rename them. */
1448 while (irl != NULL) {
1449 r = CtdlRenameRoom(irl->irl_oldroom,
1453 /* FIXME handle error returns better */
1454 syslog(LOG_ERR, "IMAP: CtdlRenameRoom() error %d", r);
1462 snprintf(aidemsg, sizeof aidemsg, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1467 CtdlAideMessage(aidemsg, "IMAP folder rename");
1469 IReply("OK RENAME completed");
1474 * Main command loop for IMAP sessions.
1476 void imap_command_loop(void)
1478 struct timeval tv1, tv2;
1479 suseconds_t total_time = 0;
1480 int untagged_ok = 1;
1482 const char *pchs, *pche;
1483 const imap_handler_hook *h;
1485 gettimeofday(&tv1, NULL);
1486 CC->lastcmd = time(NULL);
1490 if (Imap->Cmd.CmdBuf == NULL)
1491 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1493 FlushStrBuf(Imap->Cmd.CmdBuf);
1495 if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1496 syslog(LOG_ERR, "IMAP: client disconnected: ending session.");
1497 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1501 if (Imap->authstate == imap_as_expecting_password) {
1502 syslog(LOG_INFO, "IMAP: <password>");
1504 else if (Imap->authstate == imap_as_expecting_plainauth) {
1505 syslog(LOG_INFO, "IMAP: <plain_auth>");
1507 else if ((Imap->authstate == imap_as_expecting_multilineusername) ||
1508 cbmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1509 syslog(LOG_INFO, "IMAP: LOGIN...");
1512 syslog(LOG_INFO, "IMAP: %s", ChrPtr(Imap->Cmd.CmdBuf));
1515 pchs = ChrPtr(Imap->Cmd.CmdBuf);
1516 pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1518 while ((pche > pchs) &&
1523 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1525 StrBufTrim(Imap->Cmd.CmdBuf);
1527 /* If we're in the middle of a multi-line command, handle that */
1528 switch (Imap->authstate){
1529 case imap_as_expecting_username:
1530 imap_auth_login_user(imap_as_expecting_username);
1533 case imap_as_expecting_multilineusername:
1534 imap_auth_login_user(imap_as_expecting_multilineusername);
1537 case imap_as_expecting_plainauth:
1541 case imap_as_expecting_password:
1542 imap_auth_login_pass(imap_as_expecting_password);
1545 case imap_as_expecting_multilinepassword:
1546 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1553 /* Ok, at this point we're in normal command mode.
1554 * If the command just submitted does not contain a literal, we
1555 * might think about delivering some untagged stuff...
1557 if (*(ChrPtr(Imap->Cmd.CmdBuf) + StrLength(Imap->Cmd.CmdBuf) - 1)
1562 /* Grab the tag, command, and parameters. */
1563 imap_parameterize(&Imap->Cmd);
1565 /* debug output the parsed vector */
1568 syslog(LOG_DEBUG, "----- %ld params", Imap->Cmd.num_parms);
1570 for (i=0; i < Imap->Cmd.num_parms; i++) {
1571 if (Imap->Cmd.Params[i].len != strlen(Imap->Cmd.Params[i].Key))
1572 syslog(LOG_DEBUG, "*********** %ld != %ld : %s",
1573 Imap->Cmd.Params[i].len,
1574 strlen(Imap->Cmd.Params[i].Key),
1575 Imap->Cmd.Params[i].Key);
1577 syslog(LOG_DEBUG, "%ld : %s",
1578 Imap->Cmd.Params[i].len,
1579 Imap->Cmd.Params[i].Key);
1583 /* Now for the command set. */
1584 h = imap_lookup(Imap->Cmd.num_parms, Imap->Cmd.Params);
1588 IReply("BAD command unrecognized");
1592 /* RFC3501 says that we cannot output untagged data during these commands */
1593 if ((h->Flags & I_FLAG_UNTAGGED) == 0) {
1595 /* we can put any additional untagged stuff right here in the future */
1598 * Before processing the command that was just entered... if we happen
1599 * to have a folder selected, we'd like to rescan that folder for new
1600 * messages, and for deletions/changes of existing messages. This
1601 * could probably be optimized better with some deep thought...
1603 if (Imap->selected) {
1604 imap_rescan_msgids();
1608 /* does our command require a logged-in state */
1609 if ((!CC->logged_in) && ((h->Flags & I_FLAG_LOGGED_IN) != 0)) {
1610 IReply("BAD Not logged in.");
1614 /* does our command require the SELECT state on a mailbox */
1615 if ((Imap->selected == 0) && ((h->Flags & I_FLAG_SELECT) != 0)){
1616 IReply("BAD no folder selected");
1619 h->h(Imap->Cmd.num_parms, Imap->Cmd.Params);
1621 /* If the client transmitted a message we can free it now */
1626 imap_free_transmitted_message();
1628 gettimeofday(&tv2, NULL);
1629 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1630 syslog(LOG_DEBUG, "IMAP command completed in %ld.%ld seconds",
1631 (total_time / 1000000),
1632 (total_time % 1000000)
1636 void imap_noop (int num_parms, ConstStr *Params)
1638 IReply("OK No operation");
1641 void imap_logout(int num_parms, ConstStr *Params)
1643 if (IMAP->selected) {
1644 imap_do_expunge(); /* yes, we auto-expunge at logout */
1646 IAPrintf("* BYE %s logging out\r\n", config.c_fqdn);
1647 IReply("OK Citadel IMAP session ended.");
1648 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
1652 const char *CitadelServiceIMAP="IMAP";
1653 const char *CitadelServiceIMAPS="IMAPS";
1657 * This function is called to register the IMAP extension with Citadel.
1659 CTDL_MODULE_INIT(imap)
1661 if (ImapCmds == NULL)
1662 ImapCmds = NewHash(1, NULL);
1664 RegisterImapCMD("NOOP", "", imap_noop, I_FLAG_NONE);
1665 RegisterImapCMD("CHECK", "", imap_noop, I_FLAG_NONE);
1666 RegisterImapCMD("ID", "", imap_id, I_FLAG_NONE);
1667 RegisterImapCMD("LOGOUT", "", imap_logout, I_FLAG_NONE);
1668 RegisterImapCMD("LOGIN", "", imap_login, I_FLAG_NONE);
1669 RegisterImapCMD("AUTHENTICATE", "", imap_authenticate, I_FLAG_NONE);
1670 RegisterImapCMD("CAPABILITY", "", imap_capability, I_FLAG_NONE);
1672 RegisterImapCMD("STARTTLS", "", imap_starttls, I_FLAG_NONE);
1675 /* The commans below require a logged-in state */
1676 RegisterImapCMD("SELECT", "", imap_select, I_FLAG_LOGGED_IN);
1677 RegisterImapCMD("EXAMINE", "", imap_select, I_FLAG_LOGGED_IN);
1678 RegisterImapCMD("LSUB", "", imap_list, I_FLAG_LOGGED_IN);
1679 RegisterImapCMD("LIST", "", imap_list, I_FLAG_LOGGED_IN);
1680 RegisterImapCMD("CREATE", "", imap_create, I_FLAG_LOGGED_IN);
1681 RegisterImapCMD("DELETE", "", imap_delete, I_FLAG_LOGGED_IN);
1682 RegisterImapCMD("RENAME", "", imap_rename, I_FLAG_LOGGED_IN);
1683 RegisterImapCMD("STATUS", "", imap_status, I_FLAG_LOGGED_IN);
1684 RegisterImapCMD("SUBSCRIBE", "", imap_subscribe, I_FLAG_LOGGED_IN);
1685 RegisterImapCMD("UNSUBSCRIBE", "", imap_unsubscribe, I_FLAG_LOGGED_IN);
1686 RegisterImapCMD("APPEND", "", imap_append, I_FLAG_LOGGED_IN);
1687 RegisterImapCMD("NAMESPACE", "", imap_namespace, I_FLAG_LOGGED_IN);
1688 RegisterImapCMD("SETACL", "", imap_setacl, I_FLAG_LOGGED_IN);
1689 RegisterImapCMD("DELETEACL", "", imap_deleteacl, I_FLAG_LOGGED_IN);
1690 RegisterImapCMD("GETACL", "", imap_getacl, I_FLAG_LOGGED_IN);
1691 RegisterImapCMD("LISTRIGHTS", "", imap_listrights, I_FLAG_LOGGED_IN);
1692 RegisterImapCMD("MYRIGHTS", "", imap_myrights, I_FLAG_LOGGED_IN);
1693 RegisterImapCMD("GETMETADATA", "", imap_getmetadata, I_FLAG_LOGGED_IN);
1694 RegisterImapCMD("SETMETADATA", "", imap_setmetadata, I_FLAG_LOGGED_IN);
1696 /* The commands below require the SELECT state on a mailbox */
1697 RegisterImapCMD("FETCH", "", imap_fetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1698 RegisterImapCMD("UID", "FETCH", imap_uidfetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1699 RegisterImapCMD("SEARCH", "", imap_search, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1700 RegisterImapCMD("UID", "SEARCH", imap_uidsearch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1701 RegisterImapCMD("STORE", "", imap_store, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1702 RegisterImapCMD("UID", "STORE", imap_uidstore, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1703 RegisterImapCMD("COPY", "", imap_copy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1704 RegisterImapCMD("UID", "COPY", imap_uidcopy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1705 RegisterImapCMD("EXPUNGE", "", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1706 RegisterImapCMD("UID", "EXPUNGE", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1707 RegisterImapCMD("CLOSE", "", imap_close, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1711 CtdlRegisterServiceHook(config.c_imap_port,
1712 NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1714 CtdlRegisterServiceHook(config.c_imaps_port,
1715 NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1717 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1718 CtdlRegisterCleanupHook(imap_cleanup);
1721 /* return our Subversion id for the Log */