CkBounce Python Programming
Reference Documentation

CkBounce

Recognize a variety of bounced email messages and extract the email address from a bounced email message.

Properties

# bouncedEmailAddr is a CkString object (output)
get_BounceAddress( bouncedEmailAddr )

The bounced email address when a bounced email is recognized.

# mailBodyText is a CkString object (output)
get_BounceData( mailBodyText )

The raw body of the bounced mail.

# Returns an integer value
get_BounceType( )

A number representing the type of bounce that was recognized.
A value of 0 indicates "No Bounce". Other values are:

1. Hard Bounce. The email could not be delivered and BounceAddress contains the failed email address.
2. Soft Bounce. A temporary condition exists causing the email delivery to fail. The BounceAddress property contains the failed email address.
3. General Bounced Mail, cannot determine if it is hard or soft, and the email address is not available.
4. General Bounced Mail, cannot determine if it is hard or soft, but an email address is available.
5. Mail Block. A bounce occured because the sender was blocked.
6. Auto-Reply/Out-of-Office email.
7. Transient message, such as "Delivery Status / No Action Required".
8. Subscribe request.
9. Unsubscribe request.
10. Virus email notification.
11. Suspected Bounce, but no other information is available
12. Challenge/Response - Auto-reply message sent by SPAM software where only verified email addresses are accepted.
13. Address Change Notification Messages.

# str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

# str is a CkString object (output)
get_Version( str )

The version of the component, such as "2.0.0".

Methods

# email is a CkEmail object (input)
# Returns a boolean value
ExamineEmail( email )

Examines an email and sets the properties (BounceType, BounceAddress, BounceData) according to how the email is classified. This feature can only be used if Chilkat Mail is downloaded and installed, and it also requires Chilkat Mail to be licensed in addition to Chilkat Bounce.

Returns True for success, False for failure.

# emlFilename is a string (input)
# Returns a boolean value
ExamineEml( emlFilename )

Examines an email from a .eml file and sets the properties (BounceType, BounceAddress, BounceData) according to how the email is classified.

Returns True for success, False for failure.

# mimeString is a CkString object (input)
# Returns a boolean value
ExamineMime( mimeString )

Examines an email represented as raw MIME text and sets the properties (BounceType, BounceAddress, BounceData) according to how the email is classified. The return value is 1 for a successful classification, or 0 for a failure.

Returns True for success, False for failure.

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# unlockCode is a string (input)
# Returns a boolean value
UnlockComponent( unlockCode )

Unlocks the component. This must be called once at the beginning of your program to unlock the component. A permanent unlock code is provided when the Bounce component is licensed. A 30-day trial code can be obtained by registering at http://www.chilkatsoft.com/register30.asp

Returns True for success, False for failure.

# Returns a string
bounceAddress( )

The bounced email address when a bounced email is recognized.

# Returns a string
bounceData( )

The raw body of the bounced mail.

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.