lib: added start of libbarrybackup, and copied tarfile support from gui
[barry.git] / src / r_message_base.h
blobc69f4670cac1e4515a628bff3ee901ca630edc20
1 ///
2 /// \file r_message_base.h
3 /// Base class for email-oriented Blackberry database records
4 ///
6 /*
7 Copyright (C) 2005-2010, 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 uint8_t RecType;
49 uint32_t RecordId;
51 EmailAddressList From;
52 EmailAddressList To;
53 EmailAddressList Cc;
54 EmailAddressList Bcc;
55 EmailAddressList Sender; //< not available for PINMessage?
56 EmailAddressList ReplyTo; //< not available for PINMessage?
57 std::string Subject;
58 std::string Body;
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;
72 // Message Flags
73 bool MessageTruncated;
74 bool MessageRead;
75 bool MessageReply;
76 bool MessageSaved;
77 bool MessageSavedDeleted;
79 enum PriorityType {
80 LowPriority = 0,
81 NormalPriority,
82 HighPriority,
83 UnknownPriority
85 PriorityType Priority;
87 enum SensitivityType {
88 NormalSensitivity = 0,
89 Personal,
90 Private,
91 Confidential,
92 UnknownSensitivity
94 SensitivityType Sensitivity;
96 std::vector<UnknownField> Unknowns;
98 protected:
99 std::string SimpleFromAddress() const;
101 public:
102 const unsigned char* ParseField(const unsigned char *begin,
103 const unsigned char *end, const IConverter *ic = 0);
105 protected:
106 MessageBase();
107 ~MessageBase();
109 public:
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;
119 void Clear();
121 void Dump(std::ostream &os) const;
123 // sorting
124 bool operator<(const MessageBase &other) const;
127 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const MessageBase &msg) {
128 msg.Dump(os);
129 return os;
132 } // namespace Barry
134 #endif