1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*
** CWLocalMessage.h
**
** Copyright (c) 2001-2007 Ludovic Marcotte
**
** Author: Ludovic Marcotte <ludovic@Sophos.ca>
**
** This library 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.1 of the License, or (at your option) any later version.
**
** This library 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 General Public License
** along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _Pantomime_H_CWLocalMessage
#define _Pantomime_H_CWLocalMessage
#include <Pantomime/CWMessage.h>
#import <Foundation/NSCoder.h>
#import <Foundation/NSData.h>
#import <Foundation/NSString.h>
/*!
@class CWLocalMessage
@discussion This class, which extends CWMessage, adds local specific
information and redefines the behavior of some methods
from its superclass.
*/
@interface CWLocalMessage : CWMessage <NSCoding>
{
@private
NSString *_mailFilename; // Name of file in which the message is stored (if using maildir)
PantomimeFolderFormat _type; // PantomimeFormatMbox or PantomimeFormatMaildir
long int _file_position;
}
- (id) initWithCacheRecord: (cache_record) cr;
/*!
@method filePosition
@discussion This method is used to obtain the position in the mbox file
from which the message begins at. This method isn't really
helpful if -type returns something other than PantomimeFormatMbox.
@result The position in the file.
*/
- (long int) filePosition;
/*!
@method setFilePosition:
@discussion This method is used to set the position in the mbox file
from which the message begins at. This method isn't really
helpful if -type returns something other than PantomimeFormatMbox.
@param theFilePosition The position in the file.
*/
- (void) setFilePosition: (long int) theFilePosition;
/*!
@method type
@discussion This method is used to obtain the type of receiver.
Possible values are part of the PantomimeFolderFormat enum.
@result The type of the message.
*/
- (PantomimeFolderFormat) type;
/*!
@method setType:
@discussion This method is used to set the type of receiver.
Accepted values are part of the PantomimeFolderFormat enum.
@param theType The type of the receiver.
*/
- (void) setType: (PantomimeFolderFormat) theType;
/*!
@method mailFilename
@discussion This method is used to obtain the associated filename
of the receiver, if -type is PantomimeFormatMaildir.
@result The filename, nil if none was defined or if -type returns
something other than PantomimeFormatMaildir.
*/
- (NSString *) mailFilename;
/*!
@method setMailFilename:
@discussion This method is used to set the associated filename
for the receiver. This is useful and required if
-type returns PantomimeFormatMaildir.
@param theFilename The name of the file.
*/
- (void) setMailFilename: (NSString *) theFilename;
@end
#endif // _Pantomime_H_CWLocalMessage
|
