Sample code for 30+ languages & platforms
PHP ActiveX Requires Chilkat v11.6.0+

Outlook Calendar: Create a Recurring Event and List Its Instances

See more Outlook Calendar Examples

Create three daily one-hour appointments beginning tomorrow in UTC, then list the occurrences and exceptions for the next seven days. A recurring event combines a pattern with a range. Save the series-master ID separately from each occurrence ID. To modify one occurrence later, use that occurrence's ID; a change to the master applies to the series. The instances endpoint does not include cancelled occurrences.

UTC avoids ambiguous local clock times in this example. For a recurring appointment at a fixed local time, use a mailbox-supported time zone consistently in the start/end and recurrence range so daylight-saving transitions are interpreted by the calendar service.

Live creation: this posts a real calendar item. The request file is saved before sending, including its transactionId, and a receipt records the returned ID. Reuse the saved payload after an uncertain outcome; use a new filename pair for a deliberately new operation. A saved receipt prevents repeat creation on a later successful run. Keep request/receipt files private, per account, and use one writer. See the basic creation example for the same pattern.

Follow the complete @odata.nextLink, retain the same Prefer header on every page, and treat IDs as case-sensitive strings. The example checks the Graph host and repeated links, and has a 100-page demonstration limit. Save a continuation URL privately if a larger scan must resume.

Delegated permission: Calendars.ReadWrite.

Uses Microsoft Graph v1.0 in the global cloud with a delegated access token saved by the calendar OAuth2 example. Both personal Outlook.com accounts and Microsoft 365 work/school accounts with a mailbox can use this flow. The app registration must support the selected account type. A token for SMTP/IMAP/POP or another API is not a Graph token.

/me means the signed-in user and requires delegated authentication. An unattended Microsoft 365 service instead needs application permissions and administrator consent, and addresses an explicit mailbox through /users/{id-or-userPrincipalName}. That client-credentials flow does not apply to personal Outlook.com accounts. These samples target the global cloud; national clouds use different authority and Graph hosts.

HTTP methods can return false for an HTTP error as well as a connection failure. The code distinguishes those cases and checks the expected status before reading JSON. For 401, refresh the access token or authorize again; for 403, check permissions, mailbox access, and tenant policy. For 429, honor Retry-After before a bounded retry. Do not automatically repeat a write after an uncertain outcome. Keep detailed errors and calendar data private.

Microsoft documentation

Chilkat PHP ActiveX Downloads

PHP ActiveX
<?php

$success = 0;

//  Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = 0;
//  Obtain a delegated Microsoft Graph token using the calendar authorization example.
//  See Authorize Outlook Calendar with OAuth2 and PKCE.
$token = new COM("Chilkat.JsonObject");
$token->Strict = 1;
$success = $token->LoadFile('qa_data/tokens/outlookCalendar.json');
if ($success != 1) {
    print 'Could not read the private calendar token cache.' . "\n";
    exit;
}

if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
    print 'Expected a nonempty access_token in the JSON.' . "\n";
    exit;
}

$http = new COM("Chilkat.Http");
$http->AuthToken = $token->stringOf('access_token');
$http->RequireSslCertVerify = 1;
$http->FollowRedirects = 0;
$http->ConnectTimeout = 20;
$http->ReadTimeout = 30;
$http->SetRequestHeader('Accept','application/json');
$resp = new COM("Chilkat.HttpResponse");
$result = new COM("Chilkat.JsonObject");
$result->Strict = 1;
$http->SetRequestHeader('Prefer','outlook.timezone=\'UTC\', IdType=\'ImmutableId\'');
//  Live write: creates an appointment in the signed-in user's default calendar.
//  Keep one request file per logical operation and account. Do not run concurrent copies.
$requestFile = 'qa_data/outlookCalendar/create-recurring-request.json';
$resultFile = 'qa_data/outlookCalendar/created-recurring.json';
$fac = new COM("Chilkat.FileAccess");
$success = $fac->DirEnsureExists('qa_data/outlookCalendar');
if ($success != 1) {
    print 'Could not create the private operation directory.' . "\n";
    exit;
}

$body = new COM("Chilkat.JsonObject");
$body->Strict = 1;
if ($fac->FileExists($requestFile) == 1) {
    $success = $body->LoadFile($requestFile);
    if ($success != 1) {
        print 'Could not read the saved create request; nothing sent.' . "\n";
        exit;
    }

    //  Retry the same saved body and transactionId after an uncertain result.
}
else {
    $when = new COM("Chilkat.CkDateTime");
    $success = $when->SetFromCurrentSystemTime();
    if ($success != 1) {
        print 'Could not get the time.' . "\n";
        exit;
    }

    $success = $when->AddDays(1);
    if ($success != 1) {
        print 'Could not calculate tomorrow.' . "\n";
        exit;
    }

    $body->UpdateString('subject','Recurring appointment');
    $body->UpdateString('body.contentType','text');
    $body->UpdateString('body.content','Sample event details.');
    $body->UpdateString('start.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
    $body->UpdateString('start.timeZone','UTC');
    $success = $when->AddSeconds(3600);
    if ($success != 1) {
        print 'Could not calculate the end.' . "\n";
        exit;
    }

    $body->UpdateString('end.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
    $body->UpdateString('end.timeZone','UTC');
    $body->UpdateString('recurrence.pattern.type','daily');
    $body->UpdateInt('recurrence.pattern.interval',1);
    $body->UpdateString('recurrence.range.type','numbered');
    $body->UpdateInt('recurrence.range.numberOfOccurrences',3);
    $body->UpdateString('recurrence.range.recurrenceTimeZone','UTC');
    $recurrenceDate = new COM("Chilkat.StringBuilder");
    $recurrenceDate->Append($body->stringOf('start.dateTime'));
    $startDate = $recurrenceDate->getBefore('T',0);
    $body->UpdateString('recurrence.range.startDate',$startDate);
    //  No attendees: this is an appointment, so the request does not send invitations.
    $crypt = new COM("Chilkat.Crypt2");
    $transactionId = $crypt->generateUuid();
    if ($crypt->LastMethodSuccess != 1) {
        print 'Could not create a transaction ID.' . "\n";
        exit;
    }

    $body->UpdateString('transactionId',$transactionId);
    $success = $body->WriteFile($requestFile);
    if ($success != 1) {
        print 'Could not save the request before sending; nothing sent.' . "\n";
        exit;
    }

}

if (($body->JsonTypeOf('transactionId') != 1) or ($body->StringOfEquals('transactionId','',1) == 1)) {
    print 'Expected a nonempty transactionId in the JSON.' . "\n";
    exit;
}

//  A previous successful run leaves a small receipt. Do not submit it again.
if ($fac->FileExists($resultFile) == 1) {
    $receipt = new COM("Chilkat.JsonObject");
    $receipt->Strict = 1;
    $success = $receipt->LoadFile($resultFile);
    if ($success != 1) {
        print 'Could not read the existing receipt; nothing sent.' . "\n";
        exit;
    }

    if (($receipt->JsonTypeOf('id') != 1) or ($receipt->StringOfEquals('id','',1) == 1)) {
        print 'Expected a nonempty id in the JSON.' . "\n";
        exit;
    }

    if ($receipt->StringOfEquals('transactionId',$body->stringOf('transactionId'),1) != 1) {
        print 'The receipt belongs to another operation; nothing sent.' . "\n";
        exit;
    }

    print 'Already created event ID: ' . $receipt->stringOf('id') . "\n";
    exit;
}

$success = $http->HttpJson('POST','https://graph.microsoft.com/v1.0/me/events',$body,'application/json',$resp);
//  A false result can still include an HTTP error response.
if (($success != 1) and ($resp->StatusCode == 0)) {
    print 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.' . "\n";
    exit;
}

if ($resp->StatusCode != 201) {
    print 'Unexpected HTTP status: ' . $resp->StatusCode . "\n";
    print 'Request ID: ' . $resp->getHeaderField('request-id') . "\n";
    if ($resp->StatusCode == 429) {
        print 'Retry-After: ' . $resp->getHeaderField('Retry-After') . "\n";
    }

    if ($resp->StatusCode == 401) {
        print 'Refresh the Graph access token or authorize again.' . "\n";
    }

    exit;
}

$success = $result->Load($resp->BodyStr);
if ($success != 1) {
    print 'Expected a well-formed JSON response.' . "\n";
    exit;
}

if (($result->JsonTypeOf('id') != 1) or ($result->StringOfEquals('id','',1) == 1)) {
    print 'Expected a nonempty id in the JSON.' . "\n";
    exit;
}

$saved = new COM("Chilkat.JsonObject");
$saved->UpdateString('id',$result->stringOf('id'));
$saved->UpdateString('transactionId',$body->stringOf('transactionId'));
//  Display the ID even if saving the receipt fails: the server has already created the event.
print 'Created event ID: ' . $result->stringOf('id') . "\n";
$success = $saved->WriteFile($resultFile);
if ($success != 1) {
    print 'The event was created, but its receipt could not be saved. Reconcile before retrying.' . "\n";
    exit;
}

print 'Start: ' . $result->stringOf('start.dateTime') . ' (' . $result->stringOf('start.timeZone') . ')' . "\n";
print 'End: ' . $result->stringOf('end.dateTime') . ' (' . $result->stringOf('end.timeZone') . ')' . "\n";
print 'Event receipt saved.' . "\n";
//  Inspect occurrences only after the series ID has been recorded.
$seriesId = $result->stringOf('id');
$utcStart = new COM("Chilkat.StringBuilder");
$utcStart->Append($body->stringOf('start.dateTime'));
$utcStart->Append('Z');
$windowStart = $utcStart->getAsString();
$rangeEnd = new COM("Chilkat.CkDateTime");
$success = $rangeEnd->SetFromTimestamp($windowStart);
if ($success != 1) {
    print 'Could not parse the saved series start.' . "\n";
    exit;
}

$success = $rangeEnd->AddDays(7);
if ($success != 1) {
    print 'Could not set the instance range.' . "\n";
    exit;
}

$windowEnd = $rangeEnd->getAsTimestamp(0);
$endpoint = new COM("Chilkat.StringBuilder");
$endpoint->Append('https://graph.microsoft.com/v1.0/me/events/');
$endpoint->Append($http->urlEncode($seriesId));
$endpoint->Append('/instances?startDateTime=');
$endpoint->Append($http->urlEncode($windowStart));
$endpoint->Append('&endDateTime=');
$endpoint->Append($http->urlEncode($windowEnd));
$endpoint->Append('&$select=id,subject,start,end,type,seriesMasterId&$top=50');
$url = $endpoint->getAsString();
$nextLink = new COM("Chilkat.StringBuilder");
$seenLinks = new COM("Chilkat.StringArray");
$pageCount = 0;
while (($pageCount < 100)) {
    //  Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
    $nextLink->Clear();
    $nextLink->Append($url);
    if ($nextLink->StartsWith('https://graph.microsoft.com/v1.0/',1) != 1) {
        print 'Unexpected pagination host or API version; no request sent.' . "\n";
        exit;
    }

    if ($seenLinks->Find($url,0) >= 0) {
        print 'Repeated pagination URL; stopping.' . "\n";
        exit;
    }

    $seenLinks->Append($url);
    $success = $http->HttpNoBody('GET',$url,$resp);
    //  A false result can still include an HTTP error response.
    if (($success != 1) and ($resp->StatusCode == 0)) {
        print 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.' . "\n";
        exit;
    }

    if ($resp->StatusCode != 200) {
        print 'Unexpected HTTP status: ' . $resp->StatusCode . "\n";
        print 'Request ID: ' . $resp->getHeaderField('request-id') . "\n";
        if ($resp->StatusCode == 429) {
            print 'Retry-After: ' . $resp->getHeaderField('Retry-After') . "\n";
        }

        if ($resp->StatusCode == 401) {
            print 'Refresh the Graph access token or authorize again.' . "\n";
        }

        exit;
    }

    $success = $result->Load($resp->BodyStr);
    if ($success != 1) {
        print 'Expected a well-formed JSON response.' . "\n";
        exit;
    }

    if ($result->JsonTypeOf('value') != 4) {
        print 'Expected a value array.' . "\n";
        exit;
    }

    $i = 0;
    while (($i < $result->SizeOfArray('value'))) {
        $result->I = $i;
        if (($result->JsonTypeOf('value[i].id') != 1) or ($result->StringOfEquals('value[i].id','',1) == 1)) {
            print 'Expected a nonempty value[i].id in the JSON.' . "\n";
            exit;
        }

        print 'Event ID: ' . $result->stringOf('value[i].id') . "\n";
        print 'Subject: ' . $result->stringOf('value[i].subject') . "\n";
        print 'Start: ' . $result->stringOf('value[i].start.dateTime') . ' (' . $result->stringOf('value[i].start.timeZone') . ')' . "\n";
        print 'End: ' . $result->stringOf('value[i].end.dateTime') . "\n";
        print 'Type: ' . $result->stringOf('value[i].type') . "\n";
        $i = $i + 1;
    }

    $pageCount = $pageCount + 1;
    //  Quote the member name because @odata.nextLink contains a literal period.
    $nextType = $result->JsonTypeOf('\'@odata.nextLink\'');
    if (($nextType == -1) or ($nextType == 6)) {
        print 'Completed pages: ' . $pageCount . "\n";
        exit;
    }

    if (($nextType != 1) or ($result->StringOfEquals('\'@odata.nextLink\'','',1) == 1)) {
        print 'Invalid continuation link; cannot establish completeness.' . "\n";
        exit;
    }

    $url = $result->stringOf('\'@odata.nextLink\'');
}

print 'Stopped at the example's 100-page limit. Save the continuation URL privately to resume.' . "\n";

?>