PHP-MAPI extension

Zarafa

Version 6.10


Table of Contents

1. Introduction
Summary - An introduction to the PHP MAPI Extension
2. Programming
Properties - Explanation of MAPI properties.
Checking Errors - How to handle errors from the extension.
Restrictions - Using restrictions on tables.
Attachments - Adding attachments to messages.
Messages - Reading messages.
Recipients - Using the recipient table.
3. PHP-MAPI Reference
General Functions - Functions that are not directly MAPI related.
Logon Functions - This section describes the various logon functions.
Store Functions - This section describes functions which are performed on MAPI Store objects.
Folder Functions - This section describes functions which are performed on MAPI Folder objects.
Table Functions - This section describes functions which are performed on MAPI Table objects.
Rules Functions - This section describes functions which are performed on the rules table.
Message Functions - This section describes functions which are performed on MAPI Message objects.
Attachment Functions - This section describes functions which are performed on MAPI Attachment objects.
Stream Functions - This section describes functions to create streams to objects and how to use these streams.
Addressbook Functions - This section describes functions to use the addressbook for user and e-mail address lookups.
Freebusy Functions - This section describes freebusy specific functions to see the freebusy data of the users.
Zarafa specific text functions - This section describes special functions used to handle texts of a mailbody.
Zarafa specific functions - This section describes Zarafa specific functions to manage users and groups and get and set permissions on folders.

List of Examples

2.1. Property definitions
2.2. Checking property errors in an object
2.3. Checking for errors or warnings
2.4. Checking last MAPI returned error code
2.5. Simple restriction example
2.6. RES_SUBRESTRICTION + RES_COMMENT example
2.7. Recipient table
3.1. Checking an error
3.2. Checking the last MAPI HRESULT
3.3. Creating an SCODE error value
3.4. Getting the ID of a propertytag
3.5. Getting the type of a propertytag
3.6. Making a PR_SUBJECT
3.7. Mapping start and end named properties for calendar items
3.8. Get names from IDs
3.9. Getting the properties of a store
3.10. Setting the properties of a message
3.11. Saving changes to a message
3.12. Deleting a property of a message
3.13. Getting a property
3.14. Creating a one-off entry identifier
3.15. Listing the Zarafa users
3.16. Logging on to the default profile
3.17. Logging on to the Zarafa server using the unix socket
3.18. Logging on to a PST-file
3.19. Opening the stores of a Zarafa session
3.20. Getting the table with the stores
3.21. Opening a Zarafa message store
3.22. Opening multiple Zarafa message stores
3.23. Opening multiple Zarafa message stores
3.24. Opening the inbox of a store
3.25. Opening an entry from a messagestore
3.26. Opening a Zarafa message store
3.27. Opening the special multistore table
3.28. Getting the hierarchytable
3.29. Getting the getcontentstable
3.30. Creating a new message
3.31. Creating and removing a message
3.32. Moving messages to the wastebasket
3.33. Emptying a folder
3.34. Move a complete folder, with subtree, to a new destination
3.35. Deleting a folder
3.36. Creating a folder
3.37. Marking messages in a folder read
3.38. Requesting the IExchangeModifyTable interface
3.39. Reading the rows from a table
3.40. Reading the rows from a table
3.41. Getting the the rows one by one from a table
3.42. Sorting and retrieving the rows of a table by subject
3.43. Restriction on a mapitable
3.44. Retrieving the rules table
3.45. Modifying the rules table
3.46. Marking all messages as read in the inbox
3.47. Opening the attachmenttable of a message
3.48. Opening a recipienttable
3.49. Modifying recipients
3.50. Opening an attachment
3.51. Creating an attachment
3.52. Deleting an attachment
3.53. Submitting a message
3.54. Getting attachment data
3.55. Getting the attachment message
3.56. Reading a stream
3.57. Creating a new stream
3.58. Reading from a stream
3.59. Seeking in a stream
3.60. Setting the size of a stream
3.61. Committing a stream
3.62. Writing data into a stream
3.63. Getting the statistics from a stream
3.64. Open the Addressbook
3.65. Requesting the top-level AddressBook container
3.66. Resolving a user to e-mail address
3.67. Opening the default Addressbook Directory
3.68. Open a freebusysupport object
3.69. Close a freebusysupport object
3.70. Get freebusydata object of one user
3.71. Get freebusyupdate object of one user
3.72. Get freebusy enumblock object of one user and read some data
3.73. Get freebusy publish range
3.74. Sets the freebusy range of time.
3.75. Sets the cursor to the beginning
3.76. Skips 2 blocks of free/busy data.
3.77. Restricts the enumeration to a specified time period.
3.78. Gets the next 10 blocks of free/busy data.
3.79. Remove all current free/busy data
3.80. Publish 2 blocks of free/busy data
3.81. Save the free/busy data
3.82. Decompress a RTF body
3.83. Decoding RTF
3.84. Encoding HTML
3.85. Compress an RTF body
3.86. Creating a user
3.87. Setting user information
3.88. Creating a store
3.89. Deleting a user
3.90. Listing the Zarafa users
3.91. Getting user information
3.92. Getting user information
3.93. Getting group information
3.94. Getting group information
3.95. Changing group information
3.96. Listing groups
3.97. Creating a group
3.98. Deleting a group
3.99. Adding a user to a group
3.100. Deleting a user from a group
3.101. Getting groups of a user
3.102. Getting users of a group
3.103. Creating a company
3.104. Deleting a company
3.105. Getting company information
3.106. Getting company information
3.107. Listing companies
3.108. Add a company to the remote view list of a different company
3.109. Delete a company from the remote view list of a different company
3.110. List all companies in the remote view list
3.111. Add a user to the remote admin list of a different company
3.112. Delete a user from the admin list of a company
3.113. List all users in the remote admin list
3.114. Add a recipient to the recipient list of a company
3.115. Delete a recipient from the recipient list of a company
3.116. List all users in the recipient list
3.117. Getting the ACL list of the store.
3.118. Setting the ACL list on the inbox.