see ChangeLog

Monotone-Revision: 9054022ef1ca8aeba6e34842d27d9b94ce002b89

Monotone-Author: dev-unix.inverse.qc.ca
Monotone-Date: 2006-06-15T19:34:10
Monotone-Branch: ca.inverse.sogo

SoObjects/Mailer/SOGoMailObject.h

@@ -0,0 +1,93 @@
+/*
+  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__
+
+#include <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 NSData, NSString, NSArray, NSCalendarDate, NSException, NSDictionary;
+@class NGImap4Envelope, 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;
+- (NSCalendarDate *)date;
+- (NSArray *)fromEnvelopeAddresses;
+- (NSArray *)toEnvelopeAddresses;
+- (NSArray *)ccEnvelopeAddresses;
+
+- (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;
+
+@end
+
+#endif /* __Mailer_SOGoMailObject_H__ */