menu: added new Keywords tag to .desktop files
[barry.git] / src / r_message_base.h
blobd138f9eb3ce7cc36bd7f39f5a97eb54f619d3035
1 ///
2 /// \file r_message_base.h
3 /// Base class for email-oriented Blackberry database records
4 ///
6 /*
7 Copyright (C) 2005-2013, 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__
26 #include "dll.h"
27 #include "record.h"
28 #include <iosfwd>
29 #include <string>
30 #include <vector>
31 #include <map>
32 #include <stdint.h>
35 namespace Barry {
37 // forward declarations
38 class IConverter;
41 // NOTE: All classes here must be container-safe! Perhaps add sorting
42 // operators in the future.
45 class BXEXPORT MessageBase
47 public:
48 typedef Barry::UnknownsType UnknownsType;
50 uint8_t RecType;
51 uint32_t RecordId;
53 EmailAddressList From;
54 EmailAddressList To;
55 EmailAddressList Cc;
56 EmailAddressList Bcc;
57 EmailAddressList Sender; //< not available for PINMessage?
58 EmailAddressList ReplyTo; //< not available for PINMessage?
59 std::string Subject;
60 std::string Body;
61 std::string Attachment; //< not available for PINMessage?
63 uint32_t MessageRecordId; // in PINMessage, this happens to be
64 // the same as RecordId in my (CDF)
65 // testing, but interestingly, it is
66 // stored as a field *inside* the
67 // record, and not as part of the
68 // header... in effect, this record ID
69 // occurs twice in the protocol
70 uint32_t MessageReplyTo;
71 Barry::TimeT MessageDateSent;
72 Barry::TimeT MessageDateReceived;
74 // Message Flags
75 bool MessageTruncated;
76 bool MessageRead;
77 bool MessageReply;
78 bool MessageSaved;
79 bool MessageSavedDeleted;
81 enum PriorityType {
82 LowPriority = 0,
83 NormalPriority,
84 HighPriority,
85 UnknownPriority
87 PriorityType Priority;
89 enum SensitivityType {
90 NormalSensitivity = 0,
91 Personal,
92 Private,
93 Confidential,
94 UnknownSensitivity
96 SensitivityType Sensitivity;
98 UnknownsType Unknowns;
100 protected:
101 std::string SimpleFromAddress() const;
103 public:
104 const unsigned char* ParseField(const unsigned char *begin,
105 const unsigned char *end, const IConverter *ic = 0);
107 protected:
108 MessageBase();
109 ~MessageBase();
111 public:
112 // Parser / Builder API (see parser.h / builder.h)
113 void Validate() const;
114 uint8_t GetRecType() const { return RecType; }
115 uint32_t GetUniqueId() const { return RecordId; }
116 void SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
117 void ParseHeader(const Data &data, size_t &offset);
118 void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
119 void BuildHeader(Data &data, size_t &offset) const;
120 void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
122 // operations (common among record classes)
123 void Clear();
124 void Dump(std::ostream &os) const;
125 std::string GetDescription() const;
127 // sorting
128 bool operator<(const MessageBase &other) const;
131 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const MessageBase &msg) {
132 msg.Dump(os);
133 return os;
136 } // namespace Barry
138 #endif