src/r_saved_message.h

   1 ///
   2 /// \file       r_save_message.h
   3 ///             Blackberry database record parser class for saved email message records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, 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_SAVED_MESSAGE_H__
  24 #define __BARRY_RECORD_SAVED_MESSAGE_H__
  25
  26 #include "record.h"
  27 #include <iosfwd>
  28 #include <string>
  29 #include <vector>
  30 #include <map>
  31 #include <stdint.h>
  32
  33 namespace Barry {
  34
  35 //
  36 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  37 //        operators in the future.
  38 //
  39
  40 /// \addtogroup RecordParserClasses
  41 /// @{
  42
  43 class SavedMessage
  44 {
  45 public:
  46         uint8_t RecType;
  47         uint32_t RecordId;
  48
  49         Address From;
  50         Address To;
  51         Address Cc;
  52         Address Bcc;
  53         Address Sender;
  54         Address ReplyTo;
  55         std::string Subject;
  56         std::string Body;
  57         std::string Attachment;
  58         uint32_t MessageRecordId;
  59         std::vector<UnknownField> Unknowns;
  60
  61 public:
  62         const unsigned char* ParseField(const unsigned char *begin,
  63                 const unsigned char *end);
  64
  65 public:
  66         SavedMessage();
  67         ~SavedMessage();
  68
  69         // Parser / Builder API (see parser.h / builder.h)
  70         uint8_t GetRecType() const;
  71         uint32_t GetUniqueId() const;   // empty API, not required by protocol
  72         void SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
  73         void ParseHeader(const Data &data, size_t &offset);
  74         void ParseFields(const Data &data, size_t &offset);
  75         void BuildHeader(Data &data, size_t &offset) const;
  76         void BuildFields(Data &data, size_t &offset) const;
  77         void Clear();
  78         void Dump(std::ostream &os) const;
  79
  80         // sorting
  81         bool operator<(const SavedMessage &other) const { return Subject < other.Subject; }
  82
  83         // database name
  84         static const char * GetDBName() { return "Saved Email Messages"; }
  85         static uint8_t GetDefaultRecType() { return 3; }
  86 };
  87
  88 inline std::ostream& operator<<(std::ostream &os, const SavedMessage &msg) {
  89         msg.Dump(os);
  90         return os;
  91 }
  92
  93 std::ostream& operator<<(std::ostream &os, const Address &msga);
  94
  95
  96 /// @}
  97
  98 } // namespace Barry
  99
 100 #endif // __BARRY_RECORD_SAVED_MESSAGE_H__
 101
 102