PHP ActiveX Requires Chilkat v11.0.0+
PHP ActiveX
SendGrid: Schedule a reminder and cancel it by batch ID
See more SendGrid Examples
Schedule a reminder one hour from now. Save its batch ID when it is allocated. If the appointment is canceled, use that saved ID in the cancellation branch. Mail Send accepts a Unix timestamp up to 72 hours ahead; cancel at least 10 minutes before the send time. Cancellation applies to the entire batch.
Create a batch ID ยท Cancel a batch
Chilkat PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = 0;
$http = new COM("Chilkat.Http");
$http->RequireSslCertVerify = 1;
// Supply your API key from protected configuration; AuthToken adds the Bearer prefix.
$http->AuthToken = 'SENDGRID_API_KEY';
$resp = new COM("Chilkat.HttpResponse");
// On cancellation, set this to the batch ID saved with the original appointment.
// This branch does not create a new batch or send another reminder.
$batchToCancel = '';
if ($batchToCancel != '') {
$cancellation = new COM("Chilkat.JsonObject");
$cancellation->UpdateString('batch_id',$batchToCancel);
$cancellation->UpdateString('status','cancel');
$success = $http->HttpJson('POST','https://api.sendgrid.com/v3/user/scheduled_sends',$cancellation,'application/json',$resp);
if ($success != 1) {
if ($resp->StatusCode == 0) {
print $http->LastErrorText . "\n";
}
else {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
}
exit;
}
if ($resp->StatusCode != 201) {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
exit;
}
print 'Batch cancellation accepted.' . "\n";
exit;
}
$success = $http->HttpNoBody('POST','https://api.sendgrid.com/v3/mail/batch',$resp);
if ($success != 1) {
if ($resp->StatusCode == 0) {
print $http->LastErrorText . "\n";
}
else {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
}
exit;
}
if ($resp->StatusCode != 201) {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
exit;
}
$batch = new COM("Chilkat.JsonObject");
$success = $batch->Load($resp->BodyStr);
if ($success != 1) {
print 'Unexpected response: expected JSON.' . "\n";
exit;
}
$batchId = $batch->stringOf('batch_id');
if ($batch->HasMember('batch_id') != 1) {
print 'Missing batch_id in response.' . "\n";
exit;
}
// Allocate one batch per independently cancelable appointment.
print 'Save this batch ID with the appointment: ' . $batchId . "\n";
$sendTime = new COM("Chilkat.CkDateTime");
$sendTime->SetFromCurrentSystemTime();
$sendTime->AddSeconds(3600);
$message = new COM("Chilkat.JsonObject");
$message->UpdateString('batch_id',$batchId);
$message->UpdateInt('send_at',$sendTime->GetAsUnixTime(0));
$message->UpdateString('from.email','sender@example.com');
$message->UpdateString('personalizations[0].to[0].email','recipient@example.com');
$message->UpdateString('subject','Appointment reminder');
$message->UpdateString('content[0].type','text/plain');
$message->UpdateString('content[0].value','Your appointment is tomorrow at 9:30 AM Central.');
$success = $http->HttpJson('POST','https://api.sendgrid.com/v3/mail/send',$message,'application/json',$resp);
if ($success != 1) {
if ($resp->StatusCode == 0) {
print $http->LastErrorText . "\n";
}
else {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
}
exit;
}
if ($resp->StatusCode != 202) {
print 'HTTP ' . $resp->StatusCode . ': ' . $resp->BodyStr . "\n";
exit;
}
print 'Reminder scheduled for ' . $sendTime->getAsTimestamp(0) . "\n";
?>