sogo/SoObjects/Mailer/SOGoMailFolder.h

145 lines
4.2 KiB
Objective-C

/*
Copyright (C) 2009-2021 Inverse inc.
Copyright (C) 2004-2005 SKYRIX Software AG
This file is part of SOGo
SOGo is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.
SOGo is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with OGo; see the file COPYING. If not, write to the
Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/
#ifndef __Mailer_SOGoMailFolder_H__
#define __Mailer_SOGoMailFolder_H__
#include <Mailer/SOGoMailBaseObject.h>
#import <NGObjWeb/WOResponse.h>
/*
SOGoMailFolder
Parent object: the SOGoMailAccount
Child objects: SOGoMailObject or SOGoMailFolder
The SOGoMailFolder maps to an IMAP4 folder from NGImap4.
*/
@class NSData, NSArray, NSException, NSMutableArray, NSMutableDictionary;
@class NGImap4MailboxInfo;
@class WOResponse;
@interface SOGoMailFolder : SOGoMailBaseObject
{
NSMutableArray *filenames;
NSString *folderType;
NSDictionary *mailboxACL;
NSMutableDictionary *prefetchedInfos;
}
- (NSString *) absoluteImap4Name;
/* messages */
- (void) prefetchCoreInfosForMessageKeys: (NSArray *) keys;
- (NSArray *) toOneRelationshipKeys;
- (NSArray *) toManyRelationshipKeys;
- (NSDictionary *) statusForFlags: (NSArray *) flags;
- (unsigned int) unseenCount;
- (NSException *) deleteUIDs: (NSArray *) uids
useTrashFolder: (BOOL *) withTrash
inContext: (id) context;
- (WOResponse *) archiveUIDs: (NSArray *) uids
inArchiveNamed: (NSString *) archiveName
inContext: (id) context;
- (WOResponse *) archiveAllMessagesInContext: (id) localContext;
- (NSArray *) fetchUIDsMatchingQualifier: (id) _q sortOrdering: (id) _so;
- (NSArray *) fetchUIDsMatchingQualifier: (id) _q sortOrdering: (id) _so threaded: (BOOL) _threaded;
- (NSArray *) fetchUIDs: (NSArray *) _uids parts: (NSArray *) _parts;
- (NSArray *) fetchUIDsOfVanishedItems: (uint64_t) modseq;
- (WOResponse *) copyUIDs: (NSArray *) uids
toFolder: (NSString *) destinationFolder
inContext: (id) localContext;
- (WOResponse *) moveUIDs: (NSArray *) uids
toFolder: (NSString *) destinationFolder
inContext: (id) localContext;
- (WOResponse *) markMessagesAsJunkOrNotJunk: (NSArray *) uids
junk: (BOOL) isJunk;
- (NSException *) postData: (NSData *) _data flags: (id) _flags;
- (void) markForExpunge;
- (void) expungeLastMarkedFolder;
- (BOOL) exists;
- (BOOL) create;
- (BOOL) ensureTrashFolder;
- (NSException *) unsubscribe;
- (NSException *) expunge;
- (NSException *) renameTo: (NSString *) newName;
- (NSCalendarDate *) mostRecentMessageDate;
- (NSString *) davCollectionTag;
- (NSArray *) syncTokenFieldsWithProperties: (NSDictionary *) theProperties
matchingSyncToken: (NSString *) theSyncToken
fromDate: (NSCalendarDate *) theStartDate
initialLoad: (BOOL) initialLoadInProgress;
- (NSArray *) syncTokenFieldsWithProperties: (NSDictionary *) theProperties
matchingSyncToken: (NSString *) theSyncToken
fromDate: (NSCalendarDate *) theStartDate
initialLoad: (BOOL) initialLoadInProgress
sortOrdering: (id) theSortOrdering
threaded: (BOOL) isThreaded;
/* flags */
- (NSException *) addFlagsToAllMessages: (id) _f;
/* folder type */
- (NSArray *) subfolders;
- (BOOL) isSpecialFolder;
- (NSArray *) allFolderPaths;
- (NSArray *) allFolderURLs;
- (NSString *) userSpoolFolderPath;
- (BOOL) ensureSpoolFolderPath;
- (id) appendMessage: (NSData *) message
usingId: (int *) imap4id;
- (NSString *) className;
@end
@interface SOGoSpecialMailFolder : SOGoMailFolder
- (BOOL) isSpecialFolder;
@end
#endif /* __Mailer_SOGoMailFolder_H__ */