Bounce C Library Reference

Bounce

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

Create/Dispose

HCkBounce CkBounce_Create(void);

Creates an instance of the CkBounce object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkBounce_Dispose(HCkBounce handle);

Objects created by calling CkBounce_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

C "Properties"

void CkBounce_getBounceAddress(HCkBounce handle, HCkString retval);

The bounced email address when a bounced email is recognized.

void CkBounce_getBounceData(HCkBounce handle, HCkString retval);

The raw body of the bounced mail.

int CkBounce_getBounceType(HCkBounce handle);

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.

void CkBounce_getLastErrorHtml(HCkBounce handle, HCkString retval);

Error information in HTML format for the last method called.

void CkBounce_getLastErrorText(HCkBounce handle, HCkString retval);

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

void CkBounce_getLastErrorXml(HCkBounce handle, HCkString retval);

Error information in XML format for the last method called.

BOOL CkBounce_getUtf8(HCkBounce handle);
void CkBounce_putUtf8(HCkBounce handle, BOOL newVal);

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.

void CkBounce_getVersion(HCkBounce handle, HCkString retval);

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

C "Methods"

BOOL CkBounce_ExamineEmail(HCkBounce handle, HCkEmail 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.

BOOL CkBounce_ExamineEml(HCkBounce handle, const char *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.

BOOL CkBounce_ExamineMime(HCkBounce handle, HCkString 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.

BOOL CkBounce_SaveLastError(HCkBounce handle, const char *filename);

Saves the last error information to an XML formatted file.

BOOL CkBounce_UnlockComponent(HCkBounce handle, const char *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.

const char *CkBounce_bounceAddress(HCkBounce handle);

The bounced email address when a bounced email is recognized.

const char *CkBounce_bounceData(HCkBounce handle);

The raw body of the bounced mail.

const char *CkBounce_lastErrorHtml(HCkBounce handle);

Error information in HTML format for the last method called.

const char *CkBounce_lastErrorText(HCkBounce handle);

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

const char *CkBounce_lastErrorXml(HCkBounce handle);

Error information in XML format for the last method called.

const char *CkBounce_version(HCkBounce handle);

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