Kopano PHP Language Binding

Edition 8.0.0 - The Kopano Team

This document, the Kopano PHP MAPI Language Interface document, describes how to fully access Kopano’s messaging api (MAPI) via the interface provided by php-mapi.

Table of contents

• 1. Introduction
  • 1.1. Other documentation
  • 1.2. Target audience
• 2. Conventions
  • 2.1. Properties
  • 2.2. Checking errors
  • 2.3. Restrictions
  • 2.4. Attachments
  • 2.5. Messages
    • 2.5.1. RTF
    • 2.5.2. Embedded HTML in RTF
    • 2.5.3. HTML text
    • 2.5.4. Plain text
  • 2.6. Recipients
• 3. Getting Started
  • 3.1. General MAPI Functions
    • 3.1.1. mapi_getprops
  • 3.2. Handling MAPI Items
  • 3.3. Opening a mail
  • 3.4. Reading recipients
  • 3.5. Reading attachments
• 4. Function Reference
  • 4.1. General functions
    • 4.1.1. php_mapi_error
    • 4.1.2. mapi_last_hresult
    • 4.1.3. mapi_make_scode
    • 4.1.4. mapi_prop_id
    • 4.1.5. mapi_prop_type
    • 4.1.6. mapi_prop_tag
    • 4.1.7. mapi_getidsfromnames
    • 4.1.8. mapi_getnamesfromids
    • 4.1.9. mapi_getprops
    • 4.1.10. mapi_setprops
    • 4.1.11. mapi_copyto
    • 4.1.12. mapi_savechanges
    • 4.1.13. mapi_deleteprops
    • 4.1.14. mapi_openproperty
    • 4.1.15. mapi_createoneoff
    • 4.1.16. mapi_parseoneoff
    • 4.1.17. mapi_sink_create
  • 4.2. Logon functions
    • 4.2.1. mapi_logon
    • 4.2.2. mapi_logon_zarafa
    • 4.2.3. mapi_openmsgstore
    • 4.2.4. mapi_openentry
    • 4.2.5. mapi_getmsgstorestable
    • 4.2.6. mapi_openprofilesection
  • 4.3. Store functions
    • 4.3.1. mapi_msgstore_getreceivefolder
    • 4.3.2. mapi_msgstore_openentry
    • 4.3.3. mapi_msgstore_createentryid
    • 4.3.4. mapi_msgstore_openmultistoretable
    • 4.3.5. mapi_msgstore_entryidfromsourcekey
    • 4.3.6. mapi_msgstore_advise
    • 4.3.7. mapi_msgstore_unadvise
  • 4.4. Folder functions
    • 4.4.1. mapi_folder_gethierarchytable
    • 4.4.2. mapi_folder_getcontentstable
    • 4.4.3. mapi_folder_createmessage
    • 4.4.4. mapi_folder_deletemessages
    • 4.4.5. mapi_folder_copymessages
    • 4.4.6. mapi_folder_emptyfolder
    • 4.4.7. mapi_folder_copyfolder
    • 4.4.8. mapi_folder_deletefolder
    • 4.4.9. mapi_folder_createfolder
    • 4.4.10. mapi_folder_setreadflags
    • 4.4.11. mapi_folder_openmodifytable
    • 4.4.12. mapi_folder_setsearchcriteria
    • 4.4.13. mapi_folder_getsearchcriteria
  • 4.5. Table functions
    • 4.5.1. mapi_table_queryallrows
    • 4.5.2. mapi_table_queryrows
    • 4.5.3. mapi_table_getrowcount
    • 4.5.4. mapi_table_sort
    • 4.5.5. mapi_table_restrict
  • 4.6. Rules functions
    • 4.6.1. mapi_rules_gettable
    • 4.6.2. mapi_rules_modifytable
  • 4.7. Message functions
    • 4.7.1. mapi_message_setreadflag
    • 4.7.2. mapi_message_getattachmenttable
    • 4.7.3. mapi_message_getrecipienttable
    • 4.7.4. mapi_message_modifyrecipients
    • 4.7.5. mapi_message_openattach
    • 4.7.6. mapi_message_createattach
    • 4.7.7. mapi_message_deleteattach
    • 4.7.8. mapi_message_submitmessage
  • 4.8. Attachment functions
    • 4.8.1. mapi_attach_openbin
    • 4.8.2. mapi_attach_openobj
  • 4.9. Stream functions
    • 4.9.1. mapi_openpropertytostream
    • 4.9.2. mapi_stream_create
    • 4.9.3. mapi_stream_read
    • 4.9.4. mapi_stream_seek
    • 4.9.5. mapi_stream_setsize
    • 4.9.6. mapi_stream_commit
    • 4.9.7. mapi_stream_write
    • 4.9.8. mapi_stream_stat
  • 4.10. Addressbook functions
    • 4.10.1. mapi_openaddressbook
    • 4.10.2. mapi_ab_openentry
    • 4.10.3. mapi_ab_resolvename
    • 4.10.4. mapi_ab_getdefaultdir
  • 4.11. Freebusy functions
    • 4.11.1. mapi_freebusysupport_open
    • 4.11.2. mapi_freebusysupport_close
    • 4.11.3. mapi_freebusysupport_loaddata
    • 4.11.4. mapi_freebusysupport_loadupdate
    • 4.11.5. mapi_freebusydata_enumblocks
    • 4.11.6. mapi_freebusydata_getpublishrange
    • 4.11.7. mapi_freebusydata_setrange
    • 4.11.8. mapi_freebusyenumblock_reset
    • 4.11.9. mapi_freebusyenumblock_skip
    • 4.11.10. mapi_freebusyenumblock_restrict
    • 4.11.11. mapi_freebusyenumblock_next
    • 4.11.12. mapi_freebusyupdate_reset
    • 4.11.13. mapi_freebusyupdate_publish
    • 4.11.14. mapi_freebusyupdate_savechanges
  • 4.12. Kopano specific text functions
    • 4.12.1. mapi_decompressrtf
  • 4.13. Kopano specific functions
    • 4.13.1. mapi_zarafa_createuser
    • 4.13.2. mapi_zarafa_setuser
    • 4.13.3. mapi_zarafa_createstore
    • 4.13.4. mapi_zarafa_deleteuser
    • 4.13.5. mapi_zarafa_getuserlist
    • 4.13.6. mapi_zarafa_getuser_by_id
    • 4.13.7. mapi_zarafa_getuser_by_name
    • 4.13.8. mapi_zarafa_getuser
    • 4.13.9. mapi_zarafa_getgroup_by_id
    • 4.13.10. mapi_zarafa_getgroup_by_name
    • 4.13.11. mapi_zarafa_getgroup
    • 4.13.12. mapi_zarafa_setgroup
    • 4.13.13. mapi_zarafa_getgrouplist
    • 4.13.14. mapi_zarafa_creategroup
    • 4.13.15. mapi_zarafa_deletegroup
    • 4.13.16. mapi_zarafa_addgroupmember
    • 4.13.17. mapi_zarafa_deletegroupmember
    • 4.13.18. mapi_zarafa_getgrouplistofuser
    • 4.13.19. mapi_zarafa_getuserlistofgroup
    • 4.13.20. mapi_zarafa_createcompany
    • 4.13.21. mapi_zarafa_deletecompany
    • 4.13.22. mapi_zarafa_getcompany_by_id
    • 4.13.23. mapi_zarafa_getcompany_by_name
    • 4.13.24. mapi_zarafa_getcompanylist
    • 4.13.25. mapi_zarafa_add_company_remote_viewlist
    • 4.13.26. mapi_zarafa_del_company_remote_viewlist
    • 4.13.27. mapi_zarafa_get_remote_viewlist
    • 4.13.28. mapi_zarafa_add_user_remote_adminlist
    • 4.13.29. mapi_zarafa_del_user_remote_adminlist
    • 4.13.30. mapi_zarafa_get_remote_adminlist
    • 4.13.31. mapi_zarafa_add_quota_recipient
    • 4.13.32. mapi_zarafa_del_quota_recipient
    • 4.13.33. mapi_zarafa_get_quota_recipientlist
    • 4.13.34. mapi_zarafa_getpermissionrules
    • 4.13.35. mapi_zarafa_setpermissionrules
    • 4.13.36. mapi_inetmapi_imtoinet
    • 4.13.37. mapi_inetmapi_imtomapi
    • 4.13.38. mapi_mapitoical
    • 4.13.39. mapi_icaltomapi
• 5. Legal Notice