src/r_message_base.h

   1 ///
   2 /// \file       r_message_base.h
   3 ///             Base class for email-oriented Blackberry database records
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2007, Brian Edginton (edge@edginton.net)
   9
  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.
  14
  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.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #ifndef __BARRY_RECORD_MESSAGE_BASE_H__
  24 #define __BARRY_RECORD_MESSAGE_BASE_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <iosfwd>
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32 #include <stdint.h>
  33
  34
  35 namespace Barry {
  36
  37 // forward declarations
  38 class IConverter;
  39
  40 //
  41 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  42 //        operators in the future.
  43 //
  44
  45 class BXEXPORT MessageBase
  46 {
  47 public:
  48         uint8_t RecType;
  49         uint32_t RecordId;
  50
  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?
  60
  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;
  71
  72         // Message Flags
  73         bool    MessageTruncated;
  74         bool    MessageRead;
  75         bool    MessageReply;
  76         bool    MessageSaved;
  77         bool    MessageSavedDeleted;
  78
  79         enum PriorityType {
  80                 LowPriority = 0,
  81                 NormalPriority,
  82                 HighPriority,
  83                 UnknownPriority
  84         };
  85         PriorityType Priority;
  86
  87         enum SensitivityType {
  88                 NormalSensitivity = 0,
  89                 Personal,
  90                 Private,
  91                 Confidential,
  92                 UnknownSensitivity
  93         };
  94         SensitivityType Sensitivity;
  95
  96         std::vector<UnknownField> Unknowns;
  97
  98 protected:
  99         std::string SimpleFromAddress() const;
 100
 101 public:
 102         const unsigned char* ParseField(const unsigned char *begin,
 103                 const unsigned char *end, const IConverter *ic = 0);
 104
 105 protected:
 106         MessageBase();
 107         ~MessageBase();
 108
 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;
 118
 119         void Clear();
 120
 121         void Dump(std::ostream &os) const;
 122
 123         // sorting
 124         bool operator<(const MessageBase &other) const;
 125 };
 126
 127 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const MessageBase &msg) {
 128         msg.Dump(os);
 129         return os;
 130 }
 131
 132 } // namespace Barry
 133
 134 #endif
 135