(PHP ActiveX) IMAP Read Encrypted Email

See more IMAP Examples

Demonstrates how to read encrypted email from an IMAP mailbox.

Reading encrypted email works the same as reading non-encrypted email. If the required certificate and private key are available on the system (e.g., in the macOS Keychain or Windows Certificate Store), Chilkat will automatically locate them, decrypt the email, and handle the process seamlessly.

Information about the original encrypted state of the email is available after it has been downloaded and decrypted.

Note: This example requires Chilkat v10.1.2 or later because it uses the Secrets class.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Imap')
$imap = new COM("Chilkat.Imap");

$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('imap.example2.com');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// We'll get the IMAP email account's password from the Apple Keychain or Windows Credentials Manager.
// See how we originally saved the email credentials to the Keychain here:
// Save Email Credentials in Apple Keychain or Windows Credentials Manager
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Secrets')
$secrets = new COM("Chilkat.Secrets");

// On Windows, this is the Windows Credentials Manager
// On MacOS/iOS, it is the Apple Keychain
$secrets->Location = 'local_manager';

// Specify the name of the secret.
// service and username are required.
// appName and domain are optional.
// Note: The values are arbitrary and can be anything you want.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('appName','MyEmailApp');
$json->UpdateString('service','IMAP');
$json->UpdateString('domain','example2.com');
$json->UpdateString('username','jane@example2.com');

$password = $secrets->getSecretStr($json);
if ($secrets->LastMethodSuccess == 0) {
    print $secrets->LastErrorText . "\n";
    exit;
}

$success = $imap->Login('jane@example2.com',$password);
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Select an IMAP mailbox
$success = $imap->SelectMailbox('Inbox');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// This example: Send Encrypted Email using Certificate in Apple Keychain
// sent an email with the subject "This email is encrypted".
// Let's download an email with the word "encrypted" in the subject.
// messageSet is a Chilkat.MessageSet
$messageSet = $imap->Search('SUBJECT encrypted',1);
if ($imap->LastMethodSuccess == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

if ($messageSet->Count == 0) {
    print 'No messages found.' . "\n";

    exit;
}

// Reading encrypted email works the same as reading non-encrypted email. 
// If the required certificate and private key are available on the system (e.g., in the macOS Keychain or Windows Certificate Store), 
// Chilkat will automatically locate them, decrypt the email, and handle the process seamlessly.

$uid = $messageSet->GetId(0);
// email is a Chilkat.Email
$email = $imap->FetchSingle($uid,1);
if ($imap->LastMethodSuccess == 0) {
    print $imap->LastErrorText . "\n";

    exit;
}

// Here we can show if the email was received encrypted, if it was successfully decrypted, and
// which certificate was used to decrypt.
print 'Email received encrypted: ' . $email->ReceivedEncrypted . "\n";
// Was it successfully decrypted?
print 'Successfully decrypted: ' . $email->Decrypted . "\n";
// What cert was used to decrypt?
print 'Encrypted by: ' . $email->EncryptedBy . "\n";
// cert is a Chilkat.Cert
$cert = $email->GetEncryptedByCert();
if ($email->LastMethodSuccess == 1) {
    print 'Certificate DN: ' . $cert->SubjectDN . "\n";

}

// Show the decrypted email body.
print $email->Body . "\n";

$imap->Disconnect();

?>