TChilkatBounce Delphi Reference

TChilkatBounce

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

Object Creation

var
obj: TChilkatBounce;
...
begin
obj := TChilkatBounce.Create(Self);

Properties

property BounceAddress: WideString readonly

The bounced email address when a bounced email is recognized.

property BounceData: WideString readonly

The raw body of the bounced mail.

property BounceType: Integer readonly

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.
14. Success DSN indicating that the message was successfully relayed.

property LastErrorHtml: WideString readonly

Error information in HTML format for the last method called.

property LastErrorText: WideString readonly

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

property LastErrorXml: WideString readonly

Error information in XML format for the last method called.

property Version: WideString readonly

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

Methods

function ExamineEmail(iEmail: TChilkatEmail2): Integer;

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 1 for success, 0 for failure.

function ExamineEml(filename: WideString): Integer;

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

Returns 1 for success, 0 for failure.

function ExamineMail(iEmail: TChilkatEmail2): Integer;

Examines an email 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.This feature can only be used if the Chilkat Mail ActiveX is downloaded and installed, and it also requires Chilkat Mail to be licensed in addition to Chilkat Bounce.

Returns 1 for success, 0 for failure.

function ExamineMime(msg: WideString): Integer;

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 1 for success, 0 for failure.

function SaveLastError(filename: WideString): Integer;

Saves the last error information to an XML formatted file.

function UnlockComponent(unlockCode: WideString): Integer;

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 1 for success, 0 for failure.