Bounce Delphi DLL Reference Documentation

Bounce

Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
Requires Chilkat Bundle License

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

Create/Dispose

var
myObject: HCkBounce;

begin
myObject := CkBounce_Create();

// ...

CkBounce_Dispose(myObject);
end;
function CkBounce_Create: HCkBounce; stdcall;

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

procedure CkBounce_Dispose(handle: HCkBounce); stdcall;

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.

Properties

BounceAddress
procedure CkBounce_getBounceAddress(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__bounceAddress(objHandle: HCkBounce): PWideChar; stdcall;

The bounced email address when a bounced email is recognized.

See the notes about PWideChar memory ownership and validity.

top
BounceData
procedure CkBounce_getBounceData(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__bounceData(objHandle: HCkBounce): PWideChar; stdcall;

The raw body of the bounced mail.

See the notes about PWideChar memory ownership and validity.

top
BounceType
function CkBounce_getBounceType(objHandle: HCkBounce): Integer; stdcall;

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.
15. Abuse/fraud feedback report.

top
DebugLogFilePath
procedure CkBounce_getDebugLogFilePath(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
procedure CkBounce_putDebugLogFilePath(objHandle: HCkBounce; newPropVal: PWideChar); stdcall;
function CkBounce__debugLogFilePath(objHandle: HCkBounce): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
procedure CkBounce_getLastErrorHtml(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__lastErrorHtml(objHandle: HCkBounce): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastErrorText
procedure CkBounce_getLastErrorText(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__lastErrorText(objHandle: HCkBounce): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
procedure CkBounce_getLastErrorXml(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__lastErrorXml(objHandle: HCkBounce): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastMethodSuccess
function CkBounce_getLastMethodSuccess(objHandle: HCkBounce): wordbool; stdcall;
procedure CkBounce_putLastMethodSuccess(objHandle: HCkBounce; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
VerboseLogging
function CkBounce_getVerboseLogging(objHandle: HCkBounce): wordbool; stdcall;
procedure CkBounce_putVerboseLogging(objHandle: HCkBounce; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
procedure CkBounce_getVersion(objHandle: HCkBounce; outPropVal: HCkString); stdcall;
function CkBounce__version(objHandle: HCkBounce): PWideChar; stdcall;

Version of the component/library, such as "10.1.0"

See the notes about PWideChar memory ownership and validity.

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

ExamineEmail
function CkBounce_ExamineEmail(objHandle: HCkBounce;
    email: HCkEmail): wordbool; stdcall;

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.

top
ExamineEml
function CkBounce_ExamineEml(objHandle: HCkBounce;
    emlFilename: PWideChar): wordbool; stdcall;

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.

top
ExamineMime
function CkBounce_ExamineMime(objHandle: HCkBounce;
    mimeText: PWideChar): wordbool; stdcall;

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.

top