release: update README + changelog

Author: grammmike

README.rst

@@ -19,10 +19,27 @@ headers.
 .. |shield-loc| image:: https://img.shields.io/github/languages/code-size/grommunio/mapi-header-php
                 :target: https://github.com/grommunio/mapi-header-php/
 
+Features
+========
+
+* **MS-OX* Protocol Compliance**: Full compliance with Microsoft Exchange
+  protocols (MS-OXOCAL, MS-OXOTASK, MS-OXOMSG, MS-OXCICAL, etc.)
+* **Meeting Request Handling**: Complete lifecycle management for meeting
+  requests, responses, updates, and cancellations
+* **Recurrence Support**: Comprehensive recurrence pattern parsing and
+  generation for appointments and tasks (daily, weekly, monthly, yearly)
+* **Task Management**: Full task request and delegation support with
+  multi-assignee capabilities
+* **Exception Handling**: Robust error handling with detailed MAPI exception
+  mapping
+* **Authentication**: KeyCloak SSO integration and JWT token management
+* **Free/Busy**: Calendar free/busy message and folder utilities
+
 Compatibility
 =============
 
-* PHP 7.4+, PHP 8.x
+* **PHP 8.2+** (Version 2.0+)
+* Requires PHP MAPI extension
 
 Support
 =======
@@ -48,3 +65,199 @@ Coding style
 
 This repository follows a custom coding style, which can be validated anytime
 using the repository's provided `configuration file <.phpcs>`_.
+
+Installation
+============
+
+Via Composer
+------------
+
+.. code-block:: bash
+
+    composer require grommunio/mapi-header-php
+
+Manual Installation
+-------------------
+
+.. code-block:: bash
+
+    git clone https://github.com/grommunio/mapi-header-php.git
+    cd mapi-header-php
+    make install
+
+This installs the PHP files to ``/usr/share/php-mapi/``.
+
+Library Structure
+=================
+
+Core Components
+---------------
+
+**Definition Files**
+
+* ``mapidefs.php`` - Core MAPI constants, property types, object types
+* ``mapiguid.php`` - MAPI GUID constants for property sets (PSETID_*)
+* ``mapitags.php`` - Custom property tag definitions
+* ``mapi.util.php`` - Utility functions for MAPI operations
+* ``bootstrap.php`` - Bootstrap loader for all headers
+
+**Class Files**
+
+* ``class.meetingrequest.php`` - Meeting request lifecycle management
+* ``class.recurrence.php`` - Appointment recurrence handling
+* ``class.taskrecurrence.php`` - Task-specific recurrence
+* ``class.taskrequest.php`` - Task delegation and request handling
+* ``class.baserecurrence.php`` - Abstract recurrence base class
+* ``class.baseexception.php`` - Base exception with display messages
+* ``class.mapiexception.php`` - MAPI-specific exception handling
+* ``class.freebusy.php`` - Free/busy utilities
+* ``class.keycloak.php`` - KeyCloak SSO integration
+* ``class.token.php`` - JWT token parsing and validation
+
+Key Classes
+-----------
+
+Meetingrequest
+~~~~~~~~~~~~~~
+
+Handles the complete lifecycle of meeting requests:
+
+* **Sending**: Create and send meeting requests to attendees
+* **Receiving**: Process incoming meeting requests, responses, cancellations
+* **Updating**: Update existing meetings with counter-proposals
+* **Tracking**: Monitor attendee responses and track status
+* **Resources**: Automatic resource booking and conflict detection
+
+Example:
+
+.. code-block:: php
+
+    <?php
+    require_once '/usr/share/php-mapi/bootstrap.php';
+
+    $mr = new Meetingrequest($store, $message, $session);
+
+    // Check if it's a meeting request
+    if ($mr->isMeetingRequest()) {
+        // Accept the meeting
+        $mr->doAccept(false, true, true);
+    }
+
+Recurrence
+~~~~~~~~~~
+
+Parse and generate recurrence patterns according to MS-OXOCAL:
+
+* Daily, weekly, monthly, yearly patterns
+* Exception handling (modified and deleted occurrences)
+* Timezone support
+* Occurrence expansion within date ranges
+
+Example:
+
+.. code-block:: php
+
+    <?php
+    $recurrence = new Recurrence($store, $message);
+
+    // Get occurrences in a date range
+    $items = $recurrence->getCalendarItems(
+        $store,
+        $calendarFolder,
+        $startDate,
+        $endDate
+    );
+
+TaskRequest
+~~~~~~~~~~~
+
+Manage task assignments and delegation:
+
+* Task assignment to multiple recipients
+* Task acceptance/declination workflow
+* Task history tracking
+* Status updates and completion tracking
+
+BaseException & MAPIException
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Structured error handling:
+
+* User-friendly display messages
+* Technical details for debugging
+* MAPI error code mapping
+* Exception handling state tracking
+
+Testing
+=======
+
+This library includes a comprehensive PHPUnit test suite. See `tests/README.md
+<tests/README.md>`_ for details.
+
+Run tests:
+
+.. code-block:: bash
+
+    composer install
+    vendor/bin/phpunit
+
+Run with coverage:
+
+.. code-block:: bash
+
+    vendor/bin/phpunit --coverage-html coverage
+
+Code Quality
+============
+
+The codebase maintains high quality standards:
+
+* **PHP-CS-Fixer**: Automated code style enforcement
+* **PHPUnit**: Comprehensive unit test coverage
+* **Type Safety**: Extensive use of PHP 7.4+/8.x type hints
+* **PHPstan***: Static code analysis
+
+Check code style:
+
+.. code-block:: bash
+
+    vendor/bin/php-cs-fixer fix --dry-run --diff
+
+Apply fixes:
+
+.. code-block:: bash
+
+    vendor/bin/php-cs-fixer fix
+
+Static code analysis:
+
+.. code-block:: bash
+
+    vendor/bin/php-cs-fixer analyze
+
+MS-OXPROPS Compliance
+=====================
+
+This library follows Microsoft Exchange protocol specifications:
+
+* **MS-OXOCAL**: Calendar and Appointment Objects
+* **MS-OXOTASK**: Task Objects
+* **MS-OXOMSG**: Message Objects
+* **MS-OXCICAL**: iCalendar to Appointment Object Conversion
+* **MS-OXPROPS**: Property Set Definitions
+
+All named properties use the PidLid naming convention and are resolved via
+``getPropIdsFromStrings()`` to ensure compatibility.
+
+Changelog
+=========
+
+See `doc/changelog.rst <doc/changelog.rst>`_ for version history and release
+notes.
+
+License
+=======
+
+AGPL-3.0-only. See LICENSE.txt for details.
+
+Copyright 2020-2025 grommunio GmbH

doc/changelog.rst

@@ -1,3 +1,15 @@
+2.0 (2025-10-24)
+================
+* Correct logic bug in TaskRequest::isTaskRequestUpdated() that could
+  cause soft-deleted task requests to be incorrectly processed when an
+  associated task exists in the active folder
+* Enhanced recurrence pattern validation with better error handling for 
+  invalid nday values
+* More robust address book entry comparison in compareABEntryIDs()
+* Code quality improvements and stricter type safety throughout
+* Performance optimizations through optimized function usage (str*)
+
+
 1.7 (2025-09-26)
 ================
 * Drop support for PHP <= 8.1