Ruby

Send a Raw POP3 Command

Demonstrates the Chilkat MailMan.Pop3SendRawCommand method, which sends a raw command to the POP3 server and returns the server's response. The second argument specifies the charset to use if the command contains non-US-ASCII characters. This example sends the POP3 STAT command within an open session.

Background: POP3 is a simple line-based text protocol — the client sends short commands like STAT, LIST, UIDL, or RETR and the server replies with +OK or -ERR. This method is an escape hatch for issuing a command Chilkat doesn't wrap directly, or a server-specific extension. Note that the session must already be open, since a raw command assumes an authenticated connection.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the MailMan.Pop3SendRawCommand method, which sends a raw command to the POP3
#  server and returns the server's response.  The second argument is the charset used if the
#  command contains non-US-ASCII characters.

mailman = Chilkat::CkMailMan.new()

#  Configure the POP3 server connection.
mailman.put_MailHost("pop.example.com")
mailman.put_MailPort(995)
mailman.put_PopSsl(true)
mailman.put_PopUsername("user@example.com")
mailman.put_PopPassword("myPassword")

success = mailman.Pop3BeginSession()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

#  Send the raw POP3 STAT command, which returns the message count and maildrop size.
response = mailman.pop3SendRawCommand("STAT","us-ascii")
if (mailman.get_LastMethodSuccess() == false)
    print mailman.lastErrorText() + "\n";
    exit
end

print "STAT response: " + response + "\n";

success = mailman.Pop3EndSession()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end