Bounce ActiveX Reference Documentation

Bounce

Current Version: 10.1.0

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

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Bounce" instead of "Chilkat.Bounce"
For a specific major version, use "Chilkat.Bounce.<major_version>", such as "Chilkat.Bounce.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Bounce")

(AutoIt)
$obj = ObjCreate("Chilkat.Bounce")

(Visual Basic 6.0)
Dim obj As New ChilkatBounce

(VBScript)
set obj = CreateObject("Chilkat.Bounce")

(Delphi)
obj := TChilkatBounce.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Bounce')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Bounce")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Bounce', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Bounce");

Properties

BounceAddress
BounceAddress As String (read-only)

The bounced email address when a bounced email is recognized.

top
BounceData
BounceData As String (read-only)

The raw body of the bounced mail.

top
BounceType
BounceType As Long (read-only)

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
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
VerboseLogging As Long

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

top
Version
Version As String (read-only)

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

top

Methods

ExamineEmail
ExamineEmail(email As ChilkatEmail) As Long

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.

top
ExamineEml
ExamineEml(emlFilename As String) As Long

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.

top
ExamineMime
ExamineMime(mimeText As String) As Long

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.

top
UnlockComponent
UnlockComponent(unlockCode As String) As Long

Unlocks the component. This must be called once at the beginning of your program to unlock the component. A purchased unlock code is provided when the Bounce component is licensed.

A purchased unlock code for the bounce component/library will included the substring "BOUNCE", or can be a Bundle unlock code.

Returns 1 for success, 0 for failure.

top