Tcl

Fetch One POP3 Message by UIDL

Demonstrates the Chilkat MailMan.FetchByUidl method, which retrieves one message by UIDL and stores it in an Email object. The arguments are the UIDL, headerOnly, numBodyLines, and the Email. The message remains on the POP3 server. This example fetches a specific message by its UIDL.

Background: Because a UIDL is stable across sessions, fetching by UIDL is the reliable way to retrieve exactly the message you mean — the foundation of "leave on server" clients that remember which UIDLs they've already processed and download only the new ones. You can obtain the mailbox's UIDLs from FetchUidls or GetMailboxInfoXml.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the MailMan.FetchByUidl method, which retrieves one message by UIDL and
#  stores it in an Email object.  The arguments are the UIDL, headerOnly, numBodyLines, and
#  the Email.  The message remains on the server.

set mailman [new_CkMailMan]

#  Configure the POP3 server connection.
CkMailMan_put_MailHost $mailman "pop.example.com"
CkMailMan_put_MailPort $mailman 995
CkMailMan_put_PopSsl $mailman 1
CkMailMan_put_PopUsername $mailman "user@example.com"
CkMailMan_put_PopPassword $mailman "myPassword"

#  Fetch a specific message by UIDL in full.  headerOnly=0 (fetch the entire message).
#  Note: numBodyLines only applies when headersOnly is 1 (it sets how many lines of the
#  body to include along with the headers).  When headersOnly is 0, the entire message
#  is fetched and numBodyLines is ignored.
set email [new_CkEmail]

set success [CkMailMan_FetchByUidl $mailman "0000000123abcdef" 0 0 $email]
if {$success == 0} then {
    puts [CkMailMan_lastErrorText $mailman]
    delete_CkMailMan $mailman
    delete_CkEmail $email
    exit
}

puts "Subject: [CkEmail_subject $email]"

#  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
#  connects and authenticates -- using the property settings above -- whenever a server
#  operation requires it.  Calling the explicit connect/authenticate methods can still be
#  helpful to determine whether a failure occurs while connecting or while authenticating.

delete_CkMailMan $mailman
delete_CkEmail $email