React Native

Set a TLS Client Certificate for IMAP

Demonstrates the Chilkat Imap.SetSslClientCert method, which supplies a client certificate for TLS client-certificate authentication. The only argument is a Cert object that must provide access to its private key. Call it before connecting. This example loads the certificate from a PFX file.

Note: The certificate path is relative to the application's current working directory. Supply the path to your own certificate file.

Background: Most IMAP servers authenticate with a username and password only. A few high-security deployments additionally require mutual TLS, where the client presents its own certificate during the handshake. Because that happens as part of connecting, the certificate must be set before Connect — setting it afterward has no effect on the already-established connection.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { Cert, Imap } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the Imap.SetSslClientCert method, which supplies a client certificate for TLS
  // client-certificate authentication.  The only argument is a Cert object.  It must be called
  // before connecting.

  const imap = new Imap();

  imap.ssl = true;
  imap.port = 993;

  // The PFX password is not hard-coded in source.  Insert code here to obtain it from an
  // interactive prompt, environment variable, or a secrets vault.
  const pfxPassword = '';

  // Load the client certificate (and its private key) from a PFX file.
  const cert = new Cert();
  try {
    cert.loadPfxFile('qa_data/client.pfx', pfxPassword);
  } catch {
    console.log(cert.lastErrorText);
    return;
  }

  // Provide the client certificate BEFORE connecting.
  try {
    imap.setSslClientCert(cert);
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.connectAsync('imap.example.com');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.loginAsync('user@example.com', 'myPassword');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.disconnectAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }
}