Objective-C

Share an Existing SSH Tunnel (Socket) with IMAP

Demonstrates the Chilkat Imap.UseSshTunnel method, which uses an existing SSH tunnel, represented by a Socket object, for IMAP connections. The only argument is the Socket. Call it before Connect. This example opens and authenticates the tunnel on a Socket, then routes IMAP through it.

Background: A Socket object can open and hold an SSH tunnel that several Chilkat objects share. This is the approach when the tunnel is managed independently of any one protocol object — for example a long-lived tunnel reused across IMAP, POP3, and SMTP sessions — whereas SshOpenTunnel ties the tunnel's lifetime to the Imap object.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoImap.h>
#import <CkoSocket.h>
#import <NSString.h>

BOOL success = NO;

//  Demonstrates the Imap.UseSshTunnel method, which uses an existing SSH tunnel (represented by
//  a Socket) for IMAP connections.  The only argument is the Socket.  Call it before Connect.

CkoImap *imap = [[CkoImap alloc] init];

//  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
//  other Chilkat objects.
CkoSocket *sshTunnel = [[CkoSocket alloc] init];
int sshPort = 22;
success = [sshTunnel SshOpenTunnel: @"ssh.example.com" sshPort: [NSNumber numberWithInt: sshPort]];
if (success == NO) {
    NSLog(@"%@",sshTunnel.LastErrorText);
    return;
}

//  The SSH password is not hard-coded in source.  Insert code here to obtain it from an
//  interactive prompt, environment variable, or a secrets vault.
NSString *sshPassword = 0;

success = [sshTunnel SshAuthenticatePw: @"sshUser" sshPassword: sshPassword];
if (success == NO) {
    NSLog(@"%@",sshTunnel.LastErrorText);
    return;
}

//  Tell the Imap object to use the existing tunnel.
success = [imap UseSshTunnel: sshTunnel];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

//  Now connect and log in to the IMAP server through the tunnel.
imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];
success = [imap Connect: @"imap.example.com"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Login: @"user@example.com" password: @"myPassword"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Disconnect];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}