Bounce C Reference Documentation
Bounce
Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
Recognize a variety of bounced email messages and extract the email address from a bounced email message.
Create/Dispose
HCkBounce instance = CkBounce_Create(); // ... CkBounce_Dispose(instance);
Creates an instance of the HCkBounce object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkBounce_Dispose.
Properties
BounceAddress
const char *CkBounce_bounceAddress(HCkBounce cHandle);
The bounced email address when a bounced email is recognized.
topBounceData
const char *CkBounce_bounceData(HCkBounce cHandle);
The raw body of the bounced mail.
topBounceType
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.
DebugLogFilePath
void CkBounce_putDebugLogFilePath(HCkBounce cHandle, const char *newVal);
const char *CkBounce_debugLogFilePath(HCkBounce cHandle);
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.
LastErrorHtml
const char *CkBounce_lastErrorHtml(HCkBounce cHandle);
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.
topLastErrorText
const char *CkBounce_lastErrorText(HCkBounce cHandle);
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.
LastErrorXml
const char *CkBounce_lastErrorXml(HCkBounce cHandle);
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.
topLastMethodSuccess
void CkBounce_putLastMethodSuccess(HCkBounce cHandle, BOOL newVal);
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.
topUtf8
void CkBounce_putUtf8(HCkBounce cHandle, BOOL newVal);
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.
topVerboseLogging
void CkBounce_putVerboseLogging(HCkBounce cHandle, BOOL newVal);
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.
topVersion
const char *CkBounce_version(HCkBounce cHandle);
Methods
ExamineEmail
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.
topExamineEml
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.
topExamineMime
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