sogo/SoObjects/Mailer/SOGoMailObject.h

109 lines
2.8 KiB
Objective-C

/*
Copyright (C) 2004-2005 SKYRIX Software AG
This file is part of OpenGroupware.org.
OGo 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.
OGo 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_SOGoMailObject_H__
#define __Mailer_SOGoMailObject_H__
#import <SoObjects/Mailer/SOGoMailBaseObject.h>
/*
SOGoMailObject
Parent object: the SOGoMailFolder
Child objects: SOGoMailBodyPart's
Represents a single mail as retrieved using NGImap4. Since IMAP4 can parse
MIME structures on the server side, which we map into child objects of the
message.
The child objects are accessed using integer IDs, eg:
/INBOX/12345/1/2/3
would address the MIME part 1.2.3 of the mail 12345 in the folder INBOX.
*/
@class NSArray;
@class NSCalendarDate;
@class NSData;
@class NSDictionary;
@class NSException;
@class NSString;
@class NGImap4Envelope;
@class NGImap4EnvelopeAddress;
@interface SOGoMailObject : SOGoMailBaseObject
{
id coreInfos;
id headerPart;
NSDictionary *headers;
}
/* message */
- (id)fetchParts:(NSArray *)_parts; /* Note: 'parts' are fetch keys here */
/* core infos */
- (BOOL) doesMailExist;
- (id) fetchCoreInfos; // TODO: what does it do?
- (NGImap4Envelope *) envelope;
- (NSString *) subject;
- (NSString *) decodedSubject;
- (NSCalendarDate *) date;
- (NSArray *) fromEnvelopeAddresses;
- (NSArray *) replyToEnvelopeAddresses;
- (NSArray *) toEnvelopeAddresses;
- (NSArray *) ccEnvelopeAddresses;
- (NSDictionary *) mailHeaders;
- (id) bodyStructure;
- (id) lookupInfoForBodyPart:(id)_path;
/* content */
- (NSData *) content;
- (NSString *) contentAsString;
/* bulk fetching of plain/text content */
- (NSArray *) plainTextContentFetchKeys;
- (NSDictionary *) fetchPlainTextParts:(NSArray *)_fetchKeys;
- (NSDictionary *) fetchPlainTextParts;
- (NSDictionary *) fetchPlainTextStrings:(NSArray *)_fetchKeys;
/* flags */
- (NSException *) addFlags:(id)_f;
- (NSException *) removeFlags:(id)_f;
/* deletion */
- (BOOL) isDeletionAllowed;
- (NSException *) trashInContext:(id)_ctx;
- (NSException *) copyToFolderNamed: (NSString *) folderName
inContext: (id)_ctx;
- (NSException *) moveToFolderNamed: (NSString *) folderName
inContext: (id)_ctx;
@end
#endif /* __Mailer_SOGoMailObject_H__ */