Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PureBasic Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PureBasic) IMAP SSH Tunneling (Port Forwarding)

Demonstrates how to setup and use an SSH tunnel for IMAP.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkEmail.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The SSH hostname may be a hostname or an 
    ; IP address, such as "192.168.1.108".
    ; The port is typically 22 (the standard port for SSH).
    sshHostname.s = "www.mysshserver.com"
    sshPort.i = 22

    ; Connect to an SSH server and establish the SSH tunnel:
    success.i = CkImap::ckSshOpenTunnel(imap,sshHostname,sshPort)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Authenticate with the SSH server via a login/password
    ; or with a public key.
    ; This example demonstrates SSH password authentication.
    ; Note: This is not authenticating with the IMAP server, it is
    ; for authenticating with the SSH server, which is separate.
    success = CkImap::ckSshAuthenticatePw(imap,"mySshLogin","mySshPassword")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; OK, the SSH tunnel is setup.  The IMAP component may
    ; be used exactly the same as usual, except all communications
    ; are sent through the SSH tunnel.

    ; Connect to an IMAP server via the SSH tunnel.
    ; Because the SSH tunnel has been previously setup,
    ; this does not establish a direct connection with the IMAP
    ; server.  It directs the SSH server to establish the connection.

    ; In this example, the IMAP server requires SSL/TLS.  The TLS connection
    ; will be enclosed within the SSH tunnel.
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"imap.my-imap-server.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Authenticate with the IMAP server via the SSH tunnel.
    success = CkImap::ckLogin(imap,"myLogin","myPassword")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; How many messages in Inbox?
    msgCount.i = CkImap::ckNumMessages(imap)
    If msgCount = 0
        Debug "No messages found."
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    upperBound.i = 10
    If msgCount < upperBound
        upperBound = msgCount
    EndIf

    ; Download up to the 1st 10 messages.
    i.i
    bUid.i = 0
    For i = 1 To upperBound

        email.i = CkImap::ckFetchSingle(imap,i,bUid)
        If CkImap::ckLastMethodSuccess(imap) = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            ProcedureReturn

        Else
            Debug CkEmail::ckFrom(email)
            Debug CkEmail::ckSubject(email)
            Debug "----"

            CkEmail::ckDispose(email)

        EndIf

    Next

    ; Disconnect from the IMAP server.
    ; The SSH tunnel remains open.
    success = CkImap::ckDisconnect(imap)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; It is possible to re-use the existing SSH tunnel for the next connection:
    success = CkImap::ckConnect(imap,"imap.my-imap-server2.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Review the LastErrorText to see that the connection was made via the SSH tunnel:
    Debug CkImap::ckLastErrorText(imap)

    success = CkImap::ckDisconnect(imap)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Finally, close the SSH tunnel.
    success = CkImap::ckSshCloseTunnel(imap)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    Debug "IMAP SSH tunneling example completed."


    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.