eudora-mac/Include/imapmailboxes.h

/* Copyright (c) 2017, Computer History Museum 
All rights reserved. 
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to 
the limitations in the disclaimer below) provided that the following conditions are met: 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 
   disclaimer in the documentation and/or other materials provided with the distribution. 
 * Neither the name of Computer History Museum nor the names of its contributors may be used to endorse or promote products 
   derived from this software without specific prior written permission. 
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE 
COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
DAMAGE. */

/* Copyright (c) 1998 by QUALCOMM Incorporated */

//must have already included imapnetlib.h

/**********************************************************************
 *	imapmailboxes.h
 *
 *		This file contains declarations for the functions that maintain
 *	a list of remote IMAP mailboxes.
 *
 **********************************************************************/

#ifndef IMAPMAILBOXES_H
#define IMAPMAILBOXES_H

// MailboxNeedsEnum - what a mailboxNode needs
typedef enum
{
	kNeedsNothing	= 0x00000000,		// mailbox is idle
	kNeedsFilter	= 0x00000001,		// mailbox needs to be filtered
	kNeedsResync	= 0x00000002,		// mailbox needs to be resynced
	kNeedsExpunge	= 0x00000004,		// mailbox needs to be expunged
	kNeedsSelect	= 0x00000008,		// need to select new mail in this mailbox
	kNeedsSortLock	= 0x00000010,		// need to disable sorting in this mailbox
	kNeedsPoll		= 0x00000020,		// need to poll this mailbox
	kNeedsExecCmd	= 0x00000040,		// need to execute queued commands for this mailbox
	kNeedsAutoExp	= 0x00000080,		// this mailbox has deleted messages and should be expunged
	kNeedsSearch	= 0x00000100,		// this mailbox has changed and incremental searches should be updated
	kShowDeleted	= 0x00010000,		// show deleted messages in this mailbox		
} MailboxNeedsEnum;

// IMAP message flags
typedef enum
{
	kDeleted=1,
	kSeen,
	kFlagged,
	kAnswered,
	kDraft,
	kRecent,
	kLastImapFlag
} IMAPMessFlagEnum;

// LocalFlagChangeStruct.  Used to keep track changes to IMAP message flags in the local cache.
typedef struct LocalFlagChangeStruct LocalFlagChangeStruct, *LocalFlagChangePtr, **LocalFlagChangeHandle;
struct LocalFlagChangeStruct
{
	unsigned long uid;              // uid of affected message
	UIDVALIDITY mailbox;            // UIDVALIDITY of mailbox that contains this message

	// Note, these MUST be in the same order as in IMAPFLAGS!
	unsigned short deleted:1;
	unsigned short seen:1;          
	unsigned short flagged:1;
	unsigned short answered:1;
	unsigned short draft:1;
	unsigned short recent:1;

	unsigned short unUsed:8;		// spare bits
	
	unsigned short trashed:1;		// true if the message is to be trashed
	unsigned short processed:1;		// used to mark change as processed
};

// Mailboxnode - the thing mailboxTrees are made of
typedef struct MailboxNode MailboxNode, *MailboxNodePtr, **MailboxNodeHandle;
struct MailboxNode
{
	char* mailboxName;						// name of the mailbox on the server
	char delimite