(Tcl) Bounced Email Handling

Demonstrates how to examine emails and detect which are bounced (automated) replies. Classifies each email according to the type of bounce.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set bounce [new_CkBounce]

# The mailman object is used for receiving (POP3) 
# and sending (SMTP) email.
set mailman [new_CkMailMan]

# Set the POP3 server's hostname
CkMailMan_put_MailHost $mailman "mail.chilkatsoft.com"

# Set the POP3 login/password.
CkMailMan_put_PopUsername $mailman "myLogin"
CkMailMan_put_PopPassword $mailman "myPassword"

# Copy the all email from the user's POP3 mailbox 
# into a bundle object.  The email remains on the server.
# (There are other methods for deleting email from a POP3 server.)
# bundle is a CkEmailBundle
set bundle [CkMailMan_CopyMail $mailman]
if {[CkMailMan_get_LastMethodSuccess $mailman] == 0} then {
    puts [CkMailMan_lastErrorText $mailman]
    delete_CkBounce $bounce
    delete_CkMailMan $mailman
    exit
}

set i 0
# email is a CkEmail

while {$i < [CkEmailBundle_get_MessageCount $bundle]} {
    set email [CkEmailBundle_GetEmail $bundle $i]

    set success [CkBounce_ExamineEmail $bounce $email]
    if {$success == 0} then {
        puts [CkBounce_lastErrorText $bounce]
        delete_CkEmailBundle $bundle

        delete_CkBounce $bounce
        delete_CkMailMan $mailman
        exit
    }

    if {[CkBounce_get_BounceType $bounce] == 1} then {
        # Hard bounce, log the email address
        puts "Hard Bounce: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 2} then {
        # Soft bounce, log the email address
        puts "Soft Bounce: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 3} then {
        # General bounce, no email address available.
        puts "General Bounce: No email address"
    }

    if {[CkBounce_get_BounceType $bounce] == 4} then {
        # General bounce, log the email address
        puts "General Bounce: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 5} then {
        # Mail blocked, log the email address
        # A bounce occured because the sender was blocked. 
        puts "Mail Blocked: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 6} then {
        # Auto-reply, log the email address
        puts "Auto-Reply: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 7} then {
        # Transient (recoverable) Failure, log the email address
        puts "Transient Failure: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 8} then {
        # Subscribe request, log the email address
        puts "Subscribe Request: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 9} then {
        # Unsubscribe Request, log the email address
        puts "Unsubscribe Request: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 10} then {
        # Virus Notification, log the email address
        puts "Virus Notification: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 11} then {
        # Suspected bounce.
        # This should be rare.  It indicates that the Bounce
        # component found strong evidence that this is a bounced
        # email, but couldn't quite recognize everything it
        # needed to be 100% sure.  Feel free to notify
        # support@chilkatsoft.com regarding emails having this
        # bounce type.
        puts "Suspected Bounce!"
    }

    if {[CkBounce_get_BounceType $bounce] == 12} then {
        # Challenge/Response - Auto-reply message sent by SPAM software 
        # where only verified email addresses are accepted. 
        puts "Challenge: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 13} then {
        # Address Change Notification Message.
        puts "Address Change: [CkBounce_bounceAddress $bounce]"
    }

    if {[CkBounce_get_BounceType $bounce] == 14} then {
        # Success DSN indicating that the message was successfully relayed.
        puts "DSN Successful Relay: "
    }

    delete_CkEmail $email

    set i [expr $i + 1]
}

delete_CkEmailBundle $bundle

set success [CkMailMan_Pop3EndSession $mailman]

delete_CkBounce $bounce
delete_CkMailMan $mailman