CkBounce Ruby Reference Documentation

CkBounce

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

Object Creation

obj = Chilkat::CkBounce.new()

Properties

# strVal is a string
# ckStr is a CkString
bounce.get_BounceAddress(ckStr);
strVal = bounce.bounceAddress();

The bounced email address when a bounced email is recognized.

# strVal is a string
# ckStr is a CkString
bounce.get_BounceData(ckStr);
strVal = bounce.bounceData();

The raw body of the bounced mail.

# intVal is an integer
intVal = bounce.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.
14. Success DSN indicating that the message was successfully relayed.
15. Abuse/fraud feedback report.

# strVal is a string
# ckStr is a CkString
bounce.get_DebugLogFilePath(ckStr);
strVal = bounce.debugLogFilePath();
bounce.put_DebugLogFilePath(strVal);

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.

# strVal is a string
# ckStr is a CkString
bounce.get_LastErrorHtml(ckStr);
strVal = bounce.lastErrorHtml();

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.

# strVal is a string
# ckStr is a CkString
bounce.get_LastErrorText(ckStr);
strVal = bounce.lastErrorText();

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.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
bounce.get_LastErrorXml(ckStr);
strVal = bounce.lastErrorXml();

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.

# boolVal is a boolean
boolVal = bounce.get_LastMethodSuccess();
bounce.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
  • 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# boolVal is a boolean
boolVal = bounce.get_Utf8();
bounce.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

# boolVal is a boolean
boolVal = bounce.get_VerboseLogging();
bounce.put_VerboseLogging(boolVal);

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.

# strVal is a string
# ckStr is a CkString
bounce.get_Version(ckStr);
strVal = bounce.version();

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

Methods

# email is a CkEmail
status = bounce.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
status = bounce.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.

# mimeText is a string
status = bounce.ExamineMime(mimeText);

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.

# path is a string
status = bounce.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# unlockCode is a string
status = bounce.UnlockComponent(unlockCode);

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 true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information