libpst.h

Go to the documentation of this file.

/***
 * libpst.h
 * Part of LibPST project
 * Written by David Smith
 *            dave.s@earthcorp.com
 */
// LibPST - Library for Accessing Outlook .pst files
// Dave Smith - davesmith@users.sourceforge.net

#ifndef __PST_LIBPST_H
#define __PST_LIBPST_H

#include "common.h"


// switch to maximal packing for all structures in the libpst interface
// this is reverted at the end of this file
#ifdef _MSC_VER
    #pragma pack(push, 1)
#endif
#if defined(__GNUC__) || defined (__SUNPRO_C) || defined(__SUNPRO_CC)
    #pragma pack(1)
#endif


#define PST_TYPE_NOTE        1
#define PST_TYPE_SCHEDULE    2
#define PST_TYPE_APPOINTMENT 8
#define PST_TYPE_CONTACT     9
#define PST_TYPE_JOURNAL    10
#define PST_TYPE_STICKYNOTE 11
#define PST_TYPE_TASK       12
#define PST_TYPE_OTHER      13
#define PST_TYPE_REPORT     14
#define PST_TYPE_MAX        15

// defines types of possible encryption
#define PST_NO_ENCRYPT   0
#define PST_COMP_ENCRYPT 1
#define PST_ENCRYPT      2

// defines different types of mappings
#define PST_MAP_ATTRIB (uint32_t)1
#define PST_MAP_HEADER (uint32_t)2

// define my custom email attributes.
#define PST_ATTRIB_HEADER -1

// defines types of free/busy values for appointment->showas
#define PST_FREEBUSY_FREE          0
#define PST_FREEBUSY_TENTATIVE     1
#define PST_FREEBUSY_BUSY          2
#define PST_FREEBUSY_OUT_OF_OFFICE 3

// defines labels for appointment->label
#define PST_APP_LABEL_NONE        0
#define PST_APP_LABEL_IMPORTANT   1
#define PST_APP_LABEL_BUSINESS    2
#define PST_APP_LABEL_PERSONAL    3
#define PST_APP_LABEL_VACATION    4
#define PST_APP_LABEL_MUST_ATTEND 5
#define PST_APP_LABEL_TRAVEL_REQ  6
#define PST_APP_LABEL_NEEDS_PREP  7
#define PST_APP_LABEL_BIRTHDAY    8
#define PST_APP_LABEL_ANNIVERSARY 9
#define PST_APP_LABEL_PHONE_CALL  10

// define type of recuring event
#define PST_APP_RECUR_NONE        0
#define PST_APP_RECUR_DAILY       1
#define PST_APP_RECUR_WEEKLY      2
#define PST_APP_RECUR_MONTHLY     3
#define PST_APP_RECUR_YEARLY      4

// define attachment types
#define PST_ATTACH_NONE             0
#define PST_ATTACH_BY_VALUE         1
#define PST_ATTACH_BY_REF           2
#define PST_ATTACH_BY_REF_RESOLV    3
#define PST_ATTACH_BY_REF_ONLY      4
#define PST_ATTACH_EMBEDDED         5
#define PST_ATTACH_OLE              6

// define flags
#define PST_FLAG_READ           0x01
#define PST_FLAG_UNMODIFIED     0x02
#define PST_FLAG_SUBMIT         0x04
#define PST_FLAG_UNSENT         0x08
#define PST_FLAG_HAS_ATTACHMENT 0x10
#define PST_FLAG_FROM_ME        0x20
#define PST_FLAG_ASSOCIATED     0x40
#define PST_FLAG_RESEND         0x80
#define PST_FLAG_RN_PENDING     0x100
#define PST_FLAG_NRN_PENDING    0x200


typedef struct pst_entryid {
    int32_t u1;
    char entryid[16];
    uint32_t id;
} pst_entryid;


typedef struct pst_index_ll {
    uint64_t i_id;
    uint64_t offset;
    uint64_t size;
    int64_t  u1;
} pst_index_ll;


typedef struct pst_id2_tree {
    uint64_t            id2;
    pst_index_ll        *id;
    struct pst_id2_tree *child;
    struct pst_id2_tree *next;
} pst_id2_tree;


typedef struct pst_desc_tree {
    uint64_t              d_id;
    uint64_t              parent_d_id;
    pst_index_ll         *desc;
    pst_index_ll         *assoc_tree;
    int32_t               no_child;
    struct pst_desc_tree *prev;
    struct pst_desc_tree *next;
    struct pst_desc_tree *parent;
    struct pst_desc_tree *child;
    struct pst_desc_tree *child_tail;
} pst_desc_tree;


typedef struct pst_string {
    int     is_utf8;
    char   *str;
} pst_string;


typedef struct pst_binary {
    size_t  size;
    char   *data;
} pst_binary;


typedef struct pst_item_email {
    FILETIME   *arrival_date;
    int         autoforward;
    pst_string  cc_address;
    pst_string  bcc_address;
    pst_binary  conversation_index;
    int         conversion_prohibited;
    int         delete_after_submit;
    int         delivery_report;
    pst_binary  encrypted_body;
    pst_binary  encrypted_htmlbody;
    pst_string  header;
    pst_string  htmlbody;
    int32_t     importance;
    pst_string  in_reply_to;
    int         message_cc_me;
    int         message_recip_me;
    int         message_to_me;
    pst_string  messageid;
    int32_t     original_sensitivity;
    pst_string  original_bcc;
    pst_string  original_cc;
    pst_string  original_to;
    pst_string  outlook_recipient;
    pst_string  outlook_recipient_name;
    pst_string  outlook_recipient2;
    pst_string  outlook_sender;
    pst_string  outlook_sender_name;
    pst_string  outlook_sender2;
    int32_t     priority;
    pst_string  processed_subject;
    int         read_receipt;
    pst_string  recip_access;
    pst_string  recip_address;
    pst_string  recip2_access;
    pst_string  recip2_address;
    int         reply_requested;
    pst_string  reply_to;
    pst_string  return_path_address;
    int32_t     rtf_body_char_count;
    int32_t     rtf_body_crc;
    pst_string  rtf_body_tag;
    pst_binary  rtf_compressed;
    int         rtf_in_sync;
    int32_t     rtf_ws_prefix_count;
    int32_t     rtf_ws_trailing_count;
    pst_string  sender_access;
    pst_string  sender_address;
    pst_string  sender2_access;
    pst_string  sender2_address;
    int32_t     sensitivity;
    FILETIME    *sent_date;
    pst_entryid *sentmail_folder;
    pst_string  sentto_address;
    pst_string  report_text;
    FILETIME   *report_time;
    int32_t     ndr_reason_code;
    int32_t     ndr_diag_code;
    pst_string  supplementary_info;
    int32_t     ndr_status_code;

    // elements added for .msg processing
    pst_string  outlook_received_name1;
    pst_string  outlook_sender_name2;
    pst_string  outlook_normalized_subject;
    pst_string  outlook_search_key;
} pst_item_email;


typedef struct pst_item_folder {
    int32_t  item_count;
    int32_t  unseen_item_count;
    int32_t  assoc_count;
    int      subfolder;
} pst_item_folder;


typedef struct pst_item_message_store {
    pst_entryid *top_of_personal_folder;
    pst_entryid *default_outbox_folder;
    pst_entryid *deleted_items_folder;
    pst_entryid *sent_items_folder;
    pst_entryid *user_views_folder;
    pst_entryid *common_view_folder;
    pst_entryid *search_root_folder;
    pst_entryid *top_of_folder;
    int32_t valid_mask;
    int32_t pwd_chksum;
} pst_item_message_store;


typedef struct pst_item_contact {
    pst_string  account_name;
    pst_string  address1;
    pst_string  address1a;
    pst_string  address1_desc;
    pst_string  address1_transport;
    pst_string  address2;
    pst_string  address2a;
    pst_string  address2_desc;
    pst_string  address2_transport;
    pst_string  address3;
    pst_string  address3a;
    pst_string  address3_desc;
    pst_string  address3_transport;
    pst_string  assistant_name;
    pst_string  assistant_phone;
    pst_string  billing_information;
    FILETIME   *birthday;
    pst_string  business_address;
    pst_string  business_city;
    pst_string  business_country;
    pst_string  business_fax;
    pst_string  business_homepage;
    pst_string  business_phone;
    pst_string  business_phone2;
    pst_string  business_po_box;
    pst_string  business_postal_code;
    pst_string  business_state;
    pst_string  business_street;
    pst_string  callback_phone;
    pst_string  car_phone;
    pst_string  company_main_phone;
    pst_string  company_name;
    pst_string  computer_name;
    pst_string  customer_id;
    pst_string  def_postal_address;
    pst_string  department;
    pst_string  display_name_prefix;
    pst_string  first_name;
    pst_string  followup;
    pst_string  free_busy_address;
    pst_string  ftp_site;
    pst_string  fullname;
    int16_t     gender;
    pst_string  gov_id;
    pst_string  hobbies;
    pst_string  home_address;
    pst_string  home_city;
    pst_string  home_country;
    pst_string  home_fax;
    pst_string  home_phone;
    pst_string  home_phone2;
    pst_string  home_po_box;
    pst_string  home_postal_code;
    pst_string  home_state;
    pst_string  home_street;
    pst_string  initials;
    pst_string  isdn_phone;
    pst_string  job_title;
    pst_string  keyword;
    pst_string  language;
    pst_string  location;
    int         mail_permission;
    pst_string  manager_name;
    pst_string  middle_name;
    pst_string  mileage;
    pst_string  mobile_phone;
    pst_string  nickname;
    pst_string  office_loc;
    pst_string  common_name;
    pst_string  org_id;
    pst_string  other_address;
    pst_string  other_city;
    pst_string  other_country;
    pst_string  other_phone;
    pst_string  other_po_box;
    pst_string  other_postal_code;
    pst_string  other_state;
    pst_string  other_street;
    pst_string  pager_phone;
    pst_string  personal_homepage;
    pst_string  pref_name;
    pst_string  primary_fax;
    pst_string  primary_phone;
    pst_string  profession;
    pst_string  radio_phone;
    int         rich_text;
    pst_string  spouse_name;
    pst_string  suffix;
    pst_string  surname;
    pst_string  telex;
    pst_string  transmittable_display_name;
    pst_string  ttytdd_phone;
    FILETIME   *wedding_anniversary;
    pst_string  work_address_street;
    pst_string  work_address_city;
    pst_string  work_address_state;
    pst_string  work_address_postalcode;
    pst_string  work_address_country;
    pst_string  work_address_postofficebox;
} pst_item_contact;


typedef struct pst_item_attach {
    pst_string      filename1;
    pst_string      filename2;
    pst_string      mimetype;
    pst_string      content_id;
    pst_binary      data;
    uint64_t        id2_val;
    uint64_t        i_id;
    pst_id2_tree    *id2_head;
    int32_t         method;
    int32_t         position;
    int32_t         sequence;
    struct pst_item_attach *next;
} pst_item_attach;


typedef struct pst_item_extra_field {
    char   *field_name;
    char   *value;
    struct pst_item_extra_field *next;
} pst_item_extra_field;


typedef struct pst_item_journal {
    FILETIME   *start;
    FILETIME   *end;
    pst_string  type;
    pst_string  description;
} pst_item_journal;


typedef struct pst_recurrence {
    uint32_t    signature;
    uint32_t    type;
    uint32_t    sub_type;
    uint32_t    parm1;
    uint32_t    parm2;
    uint32_t    parm3;
    uint32_t    parm4;
    uint32_t    parm5;
    uint32_t    termination;
    uint32_t    interval;
    uint32_t    bydaymask;
    uint32_t    dayofmonth;
    uint32_t    monthofyear;
    uint32_t    position;
    uint32_t    count;
    // there is more data, including the termination date,
    // but we can get that from other mapi elements.
} pst_recurrence;


typedef struct pst_item_appointment {
    FILETIME   *start;
    FILETIME   *end;
    pst_string  location;
    int         alarm;
    FILETIME   *reminder;
    int32_t     alarm_minutes;
    pst_string  alarm_filename;
    pst_string  timezonestring;
    int32_t     showas;
    int32_t     label;
    int         all_day;
    int         is_recurring;
    int32_t     recurrence_type;
    pst_string  recurrence_description;
    pst_binary  recurrence_data;
    FILETIME   *recurrence_start;
    FILETIME   *recurrence_end;
} pst_item_appointment;


typedef struct pst_item {
    struct pst_file        *pf;
    uint64_t               block_id;
    pst_item_email         *email;
    pst_item_folder        *folder;
    pst_item_contact       *contact;
    pst_item_attach        *attach;
    pst_item_message_store *message_store;
    pst_item_extra_field   *extra_fields;
    pst_item_journal       *journal;
    pst_item_appointment   *appointment;
    int         type;
    char       *ascii_type;
    int32_t     flags;
    pst_string  file_as;
    pst_string  comment;
    pst_string  body_charset;
    pst_string  body;
    pst_string  subject;
    int32_t     internet_cpid;
    int32_t     message_codepage;
    int32_t     message_size;
    pst_string  outlook_version;
    pst_binary  record_key;
    pst_binary  predecessor_change;
    int         response_requested;
    FILETIME   *create_date;
    FILETIME   *modify_date;
    int         private_member;
} pst_item;


typedef struct pst_x_attrib_ll {
    uint32_t mytype;
    uint32_t map;
    void     *data;
    struct pst_x_attrib_ll *next;
} pst_x_attrib_ll;


typedef struct pst_block_recorder {
    struct pst_block_recorder  *next;
    int64_t                     offset;
    size_t                      size;
    int                         readcount;
} pst_block_recorder;


typedef struct pst_file {
    FILE*   fp;
    char*   cwd;
    char*   fname;
    const char*   charset;
    pst_index_ll *i_table;
    size_t i_count, i_capacity;
    pst_desc_tree  *d_head, *d_tail;
    pst_x_attrib_ll *x_head;
    pst_block_recorder *block_head;

    int do_read64;
    uint64_t index1;
    uint64_t index1_back;
    uint64_t index2;
    uint64_t index2_back;
    uint64_t size;
    unsigned char encryption;
    unsigned char ind_type;
} pst_file;


int             pst_open(pst_file *pf, const char *name, const char *charset);


int             pst_reopen(pst_file *pf);


int             pst_load_index (pst_file *pf);


int             pst_load_extended_attributes(pst_file *pf);


int             pst_close(pst_file *pf);


pst_desc_tree*  pst_getTopOfFolders(pst_file *pf, const pst_item *root);


pst_binary      pst_attach_to_mem(pst_file *pf, pst_item_attach *attach);


size_t          pst_attach_to_file(pst_file *pf, pst_item_attach *attach, FILE* fp);


size_t          pst_attach_to_file_base64(pst_file *pf, pst_item_attach *attach, FILE* fp);


pst_desc_tree*  pst_getNextDptr(pst_desc_tree* d);


pst_item*       pst_parse_item (pst_file *pf, pst_desc_tree *d_ptr, pst_id2_tree *m_head);


void            pst_freeItem(pst_item *item);


pst_index_ll*   pst_getID(pst_file* pf, uint64_t i_id);


size_t          pst_ff_getIDblock_dec(pst_file *pf, uint64_t i_id, char **buf);


int pst_stricmp(char *a, char *b);


size_t          pst_fwrite(const void* ptr, size_t size, size_t nmemb, FILE* stream);


char*           pst_rfc2426_escape(char* str, char** result, size_t* resultlen);


char*           pst_rfc2425_datetime_format(const FILETIME* ft, int buflen, char* result);


char*           pst_rfc2445_datetime_format(const FILETIME* ft, int buflen, char* result);


char*           pst_rfc2445_datetime_format_now(int buflen, char* result);


const char*     pst_default_charset(pst_item *item, int buflen, char* result);


void            pst_rfc2231(pst_string *str);


void            pst_rfc2047(pst_item *item, pst_string *str, int needs_quote);


void            pst_convert_utf8_null(pst_item *item, pst_string *str);


void            pst_convert_utf8(pst_item *item, pst_string *str);


pst_recurrence* pst_convert_recurrence(pst_item_appointment* appt);


void            pst_free_recurrence(pst_recurrence* r);



// switch from maximal packing back to default packing
// undo the packing from the beginning of this file
#ifdef _MSC_VER
    #pragma pack(pop)
#endif
#if defined(__GNUC__) || defined (__SUNPRO_C) || defined(__SUNPRO_CC)
    #pragma pack()
#endif



#endif