src/r_saved_message.h

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