libmapi/mapidump.c File Reference

Functions for displaying various data structures, mainly for debugging. More...

#include <libmapi/libmapi.h>

Defines

#define OC_ASSERT(x)

Functions

_PUBLIC_ const char * get_importance (uint32_t importance)
_PUBLIC_ const char * get_task_status (uint32_t status)
_PUBLIC_ void mapidump_appointment (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_contact (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_date (struct mapi_SPropValue_array *properties, uint32_t mapitag, const char *label)
_PUBLIC_ void mapidump_date_SPropValue (struct SPropValue lpProp, const char *label, const char *sep)
_PUBLIC_ void mapidump_foldercopied (struct FolderMoveCopyNotification *data, const char *sep)
_PUBLIC_ void mapidump_foldercreated (struct FolderCreatedNotification *data, const char *sep)
_PUBLIC_ void mapidump_folderdeleted (struct FolderDeletedNotification *data, const char *sep)
_PUBLIC_ void mapidump_foldermoved (struct FolderMoveCopyNotification *data, const char *sep)
_PUBLIC_ void mapidump_freebusy_date (uint32_t t, const char *sep)
_PUBLIC_ void mapidump_freebusy_event (struct Binary_r *bin, uint32_t month, uint32_t year, const char *sep)
_PUBLIC_ const char * mapidump_freebusy_month (uint32_t month, uint32_t year)
_PUBLIC_ uint32_t mapidump_freebusy_year (uint32_t month, uint32_t year)
_PUBLIC_ void mapidump_message (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_messagecopied (struct MessageMoveCopyNotification *data, const char *sep)
_PUBLIC_ void mapidump_messagecreated (struct MessageCreatedNotification *data, const char *sep)
_PUBLIC_ void mapidump_messagedeleted (struct MessageDeletedNotification *data, const char *sep)
_PUBLIC_ void mapidump_messagemodified (struct MessageModifiedNotification *data, const char *sep)
_PUBLIC_ void mapidump_messagemoved (struct MessageMoveCopyNotification *data, const char *sep)
_PUBLIC_ void mapidump_msgflags (uint32_t MsgFlags, const char *sep)
_PUBLIC_ void mapidump_newmail (struct NewMailNotification *newmail, const char *sep)
_PUBLIC_ void mapidump_note (struct mapi_SPropValue_array *properties, const char *id)
_PUBLIC_ void mapidump_PAB_entry (struct SRow *aRow)
_PUBLIC_ void mapidump_Recipients (const char **usernames, struct SRowSet *rowset, struct SPropTagArray *flaglist)
_PUBLIC_ void mapidump_SPropTagArray (struct SPropTagArray *SPropTagArray)
void mapidump_SPropValue (struct SPropValue lpProp, const char *sep)
_PUBLIC_ void mapidump_SRow (struct SRow *aRow, const char *sep)
_PUBLIC_ void mapidump_SRowSet (struct SRowSet *SRowSet, const char *sep)
_PUBLIC_ void mapidump_tags (enum MAPITAGS *Tags, uint16_t TagCount, const char *sep)
_PUBLIC_ void mapidump_task (struct mapi_SPropValue_array *properties, const char *id)

Detailed Description

Functions for displaying various data structures, mainly for debugging.


Define Documentation

#define OC_ASSERT (  ) 

Referenced by mapidump_SPropValue().


Function Documentation

_PUBLIC_ const char* get_importance ( uint32_t  importance  ) 
_PUBLIC_ const char* get_task_status ( uint32_t  status  ) 
_PUBLIC_ void mapidump_appointment ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

This function dumps the properties relating to an appointment to standard output

The expected way to obtain the properties array is to use OpenMessage() to obtain the appointment object, then to use GetPropsAll() to obtain all the properties.

Parameters:
properties array of appointment properties
id identification to display for the appointment (can be NULL)
See also:
mapidump_message, mapidump_contact, mapidump_task, mapidump_note
Examples:
fetchappointment.c.

References find_mapi_SPropValue_data(), get_task_status(), mapidump_date(), PidLidBusyStatus, PidLidContacts, PidLidLocation, PidLidPrivate, PidLidTimeZoneDescription, PR_CONVERSATION_TOPIC, PR_END_DATE, and PR_START_DATE.

_PUBLIC_ void mapidump_contact ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

This function dumps the properties relating to a contact (address book entry) to standard output

The expected way to obtain the properties array is to use OpenMessage() to obtain the contact object, then to use GetPropsAll() to obtain all the properties.

Parameters:
properties array of contact properties
id identification to display for the contact (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_task, mapidump_note

References find_mapi_SPropValue_data(), PidLidEmail1OriginalDisplayName, PidLidFileUnder, PR_BUSINESS_FAX_NUMBER, PR_BUSINESS_HOME_PAGE, PR_COMPANY_NAME, PR_CONVERSATION_TOPIC, PR_COUNTRY, PR_DEPARTMENT_NAME, PR_DISPLAY_NAME, PR_GIVEN_NAME, PR_HOME_TELEPHONE_NUMBER, PR_LOCALITY, PR_MOBILE_TELEPHONE_NUMBER, PR_OFFICE_TELEPHONE_NUMBER, PR_POSTAL_ADDRESS, PR_STATE_OR_PROVINCE, PR_STREET_ADDRESS, PR_SURNAME, and PR_TITLE.

_PUBLIC_ void mapidump_date ( struct mapi_SPropValue_array *  properties,
uint32_t  mapitag,
const char *  label 
)
_PUBLIC_ void mapidump_date_SPropValue ( struct SPropValue  lpProp,
const char *  label,
const char *  sep 
)

This function dumps a property containing a date / time to standard output

If the property does not contain a PT_SYSTIME type value, then no output will occur.

Parameters:
lpProp the property to dump
label the label to display prior to the time (e.g. the property tag)
sep a separator / spacer to insert in front of the label
Note:
Prior to OpenChange 0.9, this function took 2 arguments, assuming a default separator of a tab. You can get the old behaviour by using "\t" for sep.

References get_SPropValue_data().

Referenced by mapidump_SPropValue().

_PUBLIC_ void mapidump_foldercopied ( struct FolderMoveCopyNotification *  data,
const char *  sep 
)
_PUBLIC_ void mapidump_foldercreated ( struct FolderCreatedNotification *  data,
const char *  sep 
)

References mapidump_tags().

_PUBLIC_ void mapidump_folderdeleted ( struct FolderDeletedNotification *  data,
const char *  sep 
)
_PUBLIC_ void mapidump_foldermoved ( struct FolderMoveCopyNotification *  data,
const char *  sep 
)

Referenced by mapidump_foldercopied().

_PUBLIC_ void mapidump_freebusy_date ( uint32_t  t,
const char *  sep 
)
_PUBLIC_ void mapidump_freebusy_event ( struct Binary_r *  bin,
uint32_t  month,
uint32_t  year,
const char *  sep 
)
_PUBLIC_ const char* mapidump_freebusy_month ( uint32_t  month,
uint32_t  year 
)

Referenced by mapidump_freebusy_event().

_PUBLIC_ uint32_t mapidump_freebusy_year ( uint32_t  month,
uint32_t  year 
)

Referenced by mapidump_freebusy_event().

_PUBLIC_ void mapidump_message ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

This function dumps the properties relating to an email message to standard output

The expected way to obtain the properties array is to use OpenMessage() to obtain the message object, then to use GetPropsAll() to obtain all the properties.

Parameters:
properties array of message properties
id identification to display for the message (can be NULL)
See also:
mapidump_appointment, mapidump_contact, mapidump_task, mapidump_note
Examples:
fetchmail.c.

References find_mapi_SPropValue_data(), PR_BODY, PR_BODY_UNICODE, PR_CONVERSATION_TOPIC, PR_DISPLAY_BCC, PR_DISPLAY_CC, PR_DISPLAY_TO, PR_HASATTACH, PR_HTML, PR_INTERNET_MESSAGE_ID, PR_MESSAGE_CODEPAGE, and PR_SENT_REPRESENTING_NAME.

_PUBLIC_ void mapidump_messagecopied ( struct MessageMoveCopyNotification *  data,
const char *  sep 
)
_PUBLIC_ void mapidump_messagecreated ( struct MessageCreatedNotification *  data,
const char *  sep 
)

References mapidump_tags().

Referenced by mapidump_messagemodified().

_PUBLIC_ void mapidump_messagedeleted ( struct MessageDeletedNotification *  data,
const char *  sep 
)
_PUBLIC_ void mapidump_messagemodified ( struct MessageModifiedNotification *  data,
const char *  sep 
)
_PUBLIC_ void mapidump_messagemoved ( struct MessageMoveCopyNotification *  data,
const char *  sep 
)

Referenced by mapidump_messagecopied().

_PUBLIC_ void mapidump_msgflags ( uint32_t  MsgFlags,
const char *  sep 
)

Referenced by mapidump_newmail().

_PUBLIC_ void mapidump_newmail ( struct NewMailNotification *  newmail,
const char *  sep 
)

References mapidump_msgflags().

_PUBLIC_ void mapidump_note ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

This function dumps the properties relating to a note to standard output

The expected way to obtain the properties array is to use OpenMessage() to obtain the note object, then to use GetPropsAll() to obtain all the properties.

Parameters:
properties array of note properties
id identification to display for the note (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_contact, mapidump_task

References find_mapi_SPropValue_data(), mapidump_date(), PR_BODY, PR_BODY_HTML, PR_CLIENT_SUBMIT_TIME, and PR_CONVERSATION_TOPIC.

_PUBLIC_ void mapidump_PAB_entry ( struct SRow *  aRow  ) 
_PUBLIC_ void mapidump_Recipients ( const char **  usernames,
struct SRowSet *  rowset,
struct SPropTagArray *  flaglist 
)
_PUBLIC_ void mapidump_SPropTagArray ( struct SPropTagArray *  SPropTagArray  ) 

References get_proptag_name().

void mapidump_SPropValue ( struct SPropValue  lpProp,
const char *  sep 
)
_PUBLIC_ void mapidump_SRow ( struct SRow *  aRow,
const char *  sep 
)
_PUBLIC_ void mapidump_SRowSet ( struct SRowSet *  SRowSet,
const char *  sep 
)

References mapidump_SRow().

_PUBLIC_ void mapidump_tags ( enum MAPITAGS *  Tags,
uint16_t  TagCount,
const char *  sep 
)
_PUBLIC_ void mapidump_task ( struct mapi_SPropValue_array *  properties,
const char *  id 
)

This function dumps the properties relating to a task (to-do list entry) to standard output

The expected way to obtain the properties array is to use OpenMessage() to obtain the task object, then to use GetPropsAll() to obtain all the properties.

Parameters:
properties array of task properties
id identification to display for the task (can be NULL)
See also:
mapidump_message, mapidump_appointment, mapidump_contact, mapidump_note

References find_mapi_SPropValue_data(), get_importance(), get_task_status(), mapidump_date(), olTaskComplete, PidLidContacts, PidLidPercentComplete, PidLidPrivate, PidLidTaskDateCompleted, PidLidTaskDueDate, PidLidTaskStartDate, PidLidTaskStatus, PR_BODY, PR_CONVERSATION_TOPIC, and PR_IMPORTANCE.


Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/