Logo Search packages:      
Sourcecode: barry version File versions  Download package

r_pin_message.h

Go to the documentation of this file.
///
/// \file   r_pin_message.h
///         Blackberry database record parser class for pin message records.
///

/*
    Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
    Copyright (C) 2007, Brian Edginton (edge@edginton.net)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

    See the GNU General Public License in the COPYING file at the
    root directory of this project for more details.
*/

#ifndef __BARRY_RECORD_PIN_MESSAGE_H__
#define __BARRY_RECORD_PIN_MESSAGE_H__

#include "dll.h"
#include "record.h"
#include <iosfwd>
#include <string>
#include <vector>
#include <map>
#include <stdint.h>

namespace Barry {

//
// NOTE:  All classes here must be container-safe!  Perhaps add sorting
//        operators in the future.
//

/// \addtogroup RecordParserClasses
/// @{

class BXEXPORT PINMessage
{
public:
      uint8_t RecType;
      uint32_t RecordId;

      EmailAddress From;
      EmailAddress To;
      EmailAddress Cc;
      EmailAddress Bcc;
      std::string Subject;
      std::string Body;
      uint32_t MessageRecordId;     // this happens to be the same as
                              // RecordId in my (CDF) testing,
                              // but interestingly, it is stored
                              // as a field *inside* the record,
                              // and not as part of the header...
                              // in effect, this record ID occurs
                              // twice in the protocol
      uint32_t MessageReplyTo;
      time_t MessageDateSent;
      time_t MessageDateReceived;
      
      // Message Flags
      bool  MessageTruncated;
      bool  MessageRead;
      bool  MessageReply;
      bool  MessageSaved;
      bool  MessageSavedDeleted;
      
      enum MessagePriorityType {
            LowPriority = 0,
            NormalPriority,
            HighPriority,
            UnknownPriority
      };
      MessagePriorityType MessagePriority;
      
      enum MessageSensitivityType {
            NormalSensitivity = 0,
            Personal,
            Private,
            Confidential,
            UnknownSensitivity
      };
      MessageSensitivityType MessageSensitivity;
      
      std::vector<UnknownField> Unknowns;

public:
      const unsigned char* ParseField(const unsigned char *begin,
            const unsigned char *end);

public:
      PINMessage();
      ~PINMessage();

      // Parser / Builder API (see parser.h / builder.h)
      uint8_t GetRecType() const { return RecType; }
      uint32_t GetUniqueId() const { return RecordId; }
      void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
      void ParseHeader(const Data &data, size_t &offset);
      void ParseFields(const Data &data, size_t &offset);
      void BuildHeader(Data &data, size_t &offset) const;
      void BuildFields(Data &data, size_t &offset) const;

      void Clear();

      void Dump(std::ostream &os) const;

      // sorting
      bool operator<(const PINMessage &other) const { return Subject < other.Subject; }

      // database name
      static const char * GetDBName() { return "PIN Messages"; }
      static uint8_t GetDefaultRecType() { return 0; }
};

BXEXPORT inline std::ostream& operator<<(std::ostream &os, const PINMessage &msg) {
      msg.Dump(os);
      return os;
}

/// @}

} // namespace Barry

#endif // __BARRY_RECORD_PIN_MESSAGE_H__



Generated by  Doxygen 1.6.0   Back to index