2 /// \file r_message_base.h
3 /// Base class for email-oriented Blackberry database records
7 Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
8 Copyright (C) 2007, Brian Edginton (edge@edginton.net)
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 See the GNU General Public License in the COPYING file at the
20 root directory of this project for more details.
23 #ifndef __BARRY_RECORD_MESSAGE_BASE_H__
24 #define __BARRY_RECORD_MESSAGE_BASE_H__
37 // forward declarations
41 // NOTE: All classes here must be container-safe! Perhaps add sorting
42 // operators in the future.
45 class BXEXPORT MessageBase
51 EmailAddressList From
;
55 EmailAddressList Sender
; //< not available for PINMessage?
56 EmailAddressList ReplyTo
; //< not available for PINMessage?
59 std::string Attachment
; //< not available for PINMessage?
61 uint32_t MessageRecordId
; // in PINMessage, this happens to be
62 // the same as RecordId in my (CDF)
63 // testing, but interestingly, it is
64 // stored as a field *inside* the
65 // record, and not as part of the
66 // header... in effect, this record ID
67 // occurs twice in the protocol
68 uint32_t MessageReplyTo
;
69 time_t MessageDateSent
;
70 time_t MessageDateReceived
;
73 bool MessageTruncated
;
77 bool MessageSavedDeleted
;
79 enum MessagePriorityType
{
85 MessagePriorityType MessagePriority
;
87 enum MessageSensitivityType
{
88 NormalSensitivity
= 0,
94 MessageSensitivityType MessageSensitivity
;
96 std::vector
<UnknownField
> Unknowns
;
99 std::string
SimpleFromAddress() const;
102 const unsigned char* ParseField(const unsigned char *begin
,
103 const unsigned char *end
, const IConverter
*ic
= 0);
110 // Parser / Builder API (see parser.h / builder.h)
111 uint8_t GetRecType() const;
112 uint32_t GetUniqueId() const; // empty API, not required by protocol
113 void SetIds(uint8_t Type
, uint32_t Id
){ RecType
= Type
; RecordId
= Id
; }
114 void ParseHeader(const Data
&data
, size_t &offset
);
115 void ParseFields(const Data
&data
, size_t &offset
, const IConverter
*ic
= 0);
116 void BuildHeader(Data
&data
, size_t &offset
) const;
117 void BuildFields(Data
&data
, size_t &offset
, const IConverter
*ic
= 0) const;
121 void Dump(std::ostream
&os
) const;
124 bool operator<(const MessageBase
&other
) const
126 return Subject
< other
.Subject
;
130 BXEXPORT
inline std::ostream
& operator<<(std::ostream
&os
, const MessageBase
&msg
) {