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

Ruby 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

 

 

 

(Ruby) Async Methods Returning an Object

Demonstrates how to call an asynchronous method that returns an object. This example reads email from a POP3 server using the Async versions of the Chilkat methods.

Chilkat Ruby Downloads

Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# All Chilkat classes can be unlocked at once at the beginning of a program
# by calling UnlockBundle.  It requires a Bundle unlock code.
chilkatGlob = Chilkat::CkGlobal.new()
success = chilkatGlob.UnlockBundle("Anything for 30-day trial.")
if (success != true)
    print chilkatGlob.lastErrorText() + "\n";
    exit
end

mailman = Chilkat::CkMailMan.new()

# Set the POP3 server's hostname
mailman.put_MailHost("pop.someMailServer.com")

# Set the POP3 login/password and any other requirements..
mailman.put_PopUsername("myLogin")
mailman.put_PopPassword("myPassword")
mailman.put_PopSsl(true)
mailman.put_MailPort(995)

# Connect to the POP3 server:
# task is a CkTask
task = mailman.Pop3BeginSessionAsync()
if (mailman.get_LastMethodSuccess() == false)
    print mailman.lastErrorText() + "\n";
    exit
end

# Start the background task.
success = task.Run()
if (!success)
    print task.lastErrorText() + "\n";

    exit
end

# Wait for the POP3 connect task to finish.
# The true/false returned by Wait applies to the Wait method call, not the task.
maxWaitMs = 30000
success = task.Wait(maxWaitMs)
if (!success or (task.get_StatusInt() != 7) or (task.get_TaskSuccess() != true))
    if (!success)
        # The task.LastErrorText applies to the Wait method call.
        print task.lastErrorText() + "\n";
    else
        # The ResultErrorText applies to the underlying task method call (i.e. the Pop3BeginSession)
        print task.status() + "\n";
        print task.resultErrorText() + "\n";
    end

    exit
end

# Get the number of messages in the mailbox.
# task is a CkTask
task = mailman.GetMailboxCountAsync()

# To keep the example short, we'll skip handling failures.
# The failures would be handled in the same way as shown above.

success = task.Run()
success = task.Wait(maxWaitMs)
numMessages = task.GetResultInt()

if (numMessages == 0)
    exit
end

email = Chilkat::CkEmail.new()

for i in 1 .. numMessages

    # task is a CkTask
    task = mailman.FetchByMsgnumAsync(i)
    if (mailman.get_LastMethodSuccess() == false)
        print mailman.lastErrorText() + "\n";
        exit
    end

    success = task.Run()
    success = task.Wait(maxWaitMs)
    if (!success or (task.get_StatusInt() != 7) or (task.get_TaskSuccess() != true))
        if (!success)
            # The task.LastErrorText applies to the Wait method call.
            print task.lastErrorText() + "\n";
        else
            # The ResultErrorText applies to the underlying task method call (i.e. the FetchByMsgnum)
            print task.status() + "\n";
            print task.resultErrorText() + "\n";
        end

        exit
    end

    # Each Chilkat object that can be a return value of an asynchronous task will
    # have a method named LoadTaskResult.  The object returned in the underlying
    # asynchronous method call is retrieved by calling LoadTaskResult. 

    # To say it another way: The application will provide a pre-existing object of
    # the desired return type (in this case it is an email object).  This object is
    # loaded by calling LoadTaskResult.  

    success = email.LoadTaskResult(task)

    if (!success)
        print email.lastErrorText() + "\n";
        exit
    else
        print email.ck_from() + ": " + email.subject() + "\n" + "\n";
    end

end

 

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