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-2007, 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         Address From;
  49         Address To;
  50         Address Cc;
  51         Address Bcc;
  52         Address Sender;
  53         Address ReplyTo;
  54         std::string Subject;
  55         std::string Body;
  56         std::string Attachment;
  57         std::vector<UnknownField> Unknowns;
  58         uint32_t MessageRecordId;
  59         uint32_t MessageReplyTo;
  60         time_t MessageDateSent;
  61         time_t MessageDateReceived;
  62
  63         // Message Flags
  64         bool    MessageTruncated;
  65         bool    MessageRead;
  66         bool    MessageReply;
  67         bool    MessageSaved;
  68         bool    MessageSavedDeleted;
  69
  70         enum MessagePriorityType {
  71                 LowPriority = 0,
  72                 NormalPriority,
  73                 HighPriority,
  74                 UnknownPriority
  75         };
  76         MessagePriorityType MessagePriority;
  77
  78         enum MessageSensitivityType {
  79                 NormalSensitivity = 0,
  80                 Personal,
  81                 Private,
  82                 Confidential,
  83                 UnknownSensitivity
  84         };
  85         MessageSensitivityType MessageSensitivity;
  86
  87 protected:
  88         std::string SimpleEmailAddress() const;
  89
  90 public:
  91         const unsigned char* ParseField(const unsigned char *begin,
  92                 const unsigned char *end);
  93
  94 public:
  95         Message();
  96         ~Message();
  97
  98         // Parser / Builder API (see parser.h / builder.h)
  99         uint8_t GetRecType() const;
 100         uint32_t GetUniqueId() const;   // empty API, not required by protocol
 101         void SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
 102         void ParseHeader(const Data &data, size_t &offset);
 103         void ParseFields(const Data &data, size_t &offset);
 104         void BuildHeader(Data &data, size_t &offset) const;
 105         void BuildFields(Data &data, size_t &offset) const;
 106
 107         void Clear();
 108
 109         void Dump(std::ostream &os) const;
 110
 111         // sorting
 112         bool operator<(const Message &other) const { return Subject < other.Subject; }
 113
 114         // database name
 115         static const char * GetDBName() { return "Messages"; }
 116         static uint8_t GetDefaultRecType() { return 0; }
 117 };
 118
 119 inline std::ostream& operator<<(std::ostream &os, const Message &msg) {
 120         msg.Dump(os);
 121         return os;
 122 }
 123
 124 /// @}
 125
 126 } // namespace Barry
 127
 128 #endif
 129