src/r_message.h

   1 ///
   2 /// \file       r_message.h
   3 ///             Blackberry database record parser class for email records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_RECORD_MESSAGE_H__
  23 #define __BARRY_RECORD_MESSAGE_H__
  24
  25 #include "record.h"
  26 #include <iosfwd>
  27 #include <string>
  28 #include <vector>
  29 #include <map>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 //
  35 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  36 //        operators in the future.
  37 //
  38
  39 /// \addtogroup RecordParserClasses
  40 /// @{
  41
  42 class Message
  43 {
  44 public:
  45         uint8_t RecType;
  46         uint32_t RecordId;
  47
  48         EmailAddress From;
  49         EmailAddress To;
  50         EmailAddress Cc;
  51         EmailAddress Bcc;
  52         EmailAddress Sender;
  53         EmailAddress ReplyTo;
  54         std::string Subject;
  55         std::string Body;
  56         std::string Attachment;
  57         uint32_t MessageRecordId;
  58         uint32_t MessageReplyTo;
  59         time_t MessageDateSent;
  60         time_t MessageDateReceived;
  61
  62         // Message Flags
  63         bool    MessageTruncated;
  64         bool    MessageRead;
  65         bool    MessageReply;
  66         bool    MessageSaved;
  67         bool    MessageSavedDeleted;
  68
  69         enum MessagePriorityType {
  70                 LowPriority = 0,
  71                 NormalPriority,
  72                 HighPriority,
  73                 UnknownPriority
  74         };
  75         MessagePriorityType MessagePriority;
  76
  77         enum MessageSensitivityType {
  78                 NormalSensitivity = 0,
  79                 Personal,
  80                 Private,
  81                 Confidential,
  82                 UnknownSensitivity
  83         };
  84         MessageSensitivityType MessageSensitivity;
  85
  86         std::vector<UnknownField> Unknowns;
  87
  88 protected:
  89         std::string SimpleEmailAddress() const;
  90
  91 public:
  92         const unsigned char* ParseField(const unsigned char *begin,
  93                 const unsigned char *end);
  94
  95 public:
  96         Message();
  97         ~Message();
  98
  99         // Parser / Builder API (see parser.h / builder.h)
 100         uint8_t GetRecType() const;
 101         uint32_t GetUniqueId() const;   // empty API, not required by protocol
 102         void SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
 103         void ParseHeader(const Data &data, size_t &offset);
 104         void ParseFields(const Data &data, size_t &offset);
 105         void BuildHeader(Data &data, size_t &offset) const;
 106         void BuildFields(Data &data, size_t &offset) const;
 107
 108         void Clear();
 109
 110         void Dump(std::ostream &os) const;
 111
 112         // sorting
 113         bool operator<(const Message &other) const { return Subject < other.Subject; }
 114
 115         // database name
 116         static const char * GetDBName() { return "Messages"; }
 117         static uint8_t GetDefaultRecType() { return 0; }
 118 };
 119
 120 inline std::ostream& operator<<(std::ostream &os, const Message &msg) {
 121         msg.Dump(os);
 122         return os;
 123 }
 124
 125 /// @}
 126
 127 } // namespace Barry
 128
 129 #endif
 130