Dkim C++ Reference Documentation
CkDkim
Current Version: 11.1.0
DomainKeys API for creating and verifying DKIM-Signature and DomainKey-Signature MIME (email) header fields. This API is included with the "Chilkat MIME" license. ("Chilkat MIME" may be referred to as "Chilkat S/MIME" on some chilkatsoft.com web pages. They are the same product.)
Object Creation
// Local variable on the stack CkDkim obj; // Dynamically allocate/delete CkDkim *pObj = new CkDkim(); // ... delete pObj;
Properties
AbortCurrent
void put_AbortCurrent(bool newVal);
When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)
DebugLogFilePath
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);
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.
DkimAlg
const char *dkimAlg(void);
void put_DkimAlg(const char *ansiOrUtf8Str);
The signing algorithm to be used in creating the DKIM-Signature. Possible values are rsa-sha256 and rsa-sha1. The default value is rsa-sha256.
DkimBodyLengthCount
void put_DkimBodyLengthCount(int newVal);
Optional body length count to set a maximum number of body bytes to be hashed when creating the DKIM-Signature field. The default value is 0, indicating that the entire body should be hashed.
topDkimCanon
const char *dkimCanon(void);
void put_DkimCanon(const char *ansiOrUtf8Str);
Canonicalization algorithm to be used for both header and body when creating the DKIM-Signature. Possible values are simple and relaxed. The default value is relaxed.
DkimDomain
const char *dkimDomain(void);
void put_DkimDomain(const char *ansiOrUtf8Str);
The domain name of the signing domain when creating the DKIM-Signature.
topDkimHeaders
const char *dkimHeaders(void);
void put_DkimHeaders(const char *ansiOrUtf8Str);
A colon-separated list of header field names that identify headers presented to the signing algorithm when creating the DKIM-Signature. The default value is: mime-version:date:message-id:subject:from:to:content-type.
DkimSelector
const char *dkimSelector(void);
void put_DkimSelector(const char *ansiOrUtf8Str);
The selector to be used to form the DNS query for the public key. This property applies to creating a DKIM-Signature. For example, if the selector is reykjavik and the domain is example-code.com, then the DNS query would be for reykjavik._domainkey.example-code.com.
DomainKeyAlg
const char *domainKeyAlg(void);
void put_DomainKeyAlg(const char *ansiOrUtf8Str);
The signing algorithm to be used in creating the DomainKey-Signature. The only possible value is rsa-sha1. The default value is rsa-sha1.
DomainKeyCanon
const char *domainKeyCanon(void);
void put_DomainKeyCanon(const char *ansiOrUtf8Str);
Canonicalization algorithm to be used for when creating the DomainKey-Signature. Possible values are simple and nofws. The default value is nofws.
DomainKeyDomain
const char *domainKeyDomain(void);
void put_DomainKeyDomain(const char *ansiOrUtf8Str);
The domain name of the signing domain when creating the DomainKey-Signature.
topDomainKeyHeaders
const char *domainKeyHeaders(void);
void put_DomainKeyHeaders(const char *ansiOrUtf8Str);
A colon-separated list of header field names that identify headers presented to the signing algorithm when creating the DomainKey-Signature. The default value is: mime-version:date:message-id:subject:from:to:content-type.
DomainKeySelector
const char *domainKeySelector(void);
void put_DomainKeySelector(const char *ansiOrUtf8Str);
The selector to be used to form the DNS query for the public key. This property applies to creating a DomainKey-Signature. For example, if the selector is reykjavik and the domain is example-code.com, then the DNS query would be for reykjavik._domainkey.example-code.com.
HeartbeatMs
void put_HeartbeatMs(int newVal);
The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.
LastErrorHtml
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
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
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 put_LastMethodSuccess(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.
Utf8
void put_Utf8(bool newVal);
When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.
VerboseLogging
void put_VerboseLogging(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.
VerifyInfo
Contains JSON with information about the last DKIM or DomainKey signature verified (or verification failure). The JSON will contain information like this:
{
"domain": "amazonses.com",
"selector": "7v7vs6w47njt4pimodk5mmttbegzsi6n",
"publicKey": "MIGfMA0GCSq...z6uqeQIDAQAB",
"canonicalization": "relaxed/simple",
"algorithm": "rsa-sha256",
"signedHeaders": "Subject:From:To:Date:Mime-Version:Content-Type:References:Message-Id:Feedback-ID",
"verified": "yes"
}
Version
Methods
DkimSign
Constructs and prepends a DKIM-Signature header to the MIME passed in mimeData. Prior to calling this method, your program must set both the DkimDomain and DkimSelector properties, and it must load a private key by calling SetDkimPrivateKey.
Returns true for success, false for failure.
DkimVerify
Verifies the Nth DKIM-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.
On return, the VerifyInfo property will contain additional information about the DKIM-Signature that was verified (or not verified).
Returns true for success, false for failure.
DomainKeySign
Constructs and prepends a DomainKey-Signature header to the MIME passed in mimeData. Prior to calling this method, your program must set both the DomainKeyDomain and DomainKeySelector properties, and it must load a private key by calling SetDomainKeyPrivateKey.
Returns true for success, false for failure.
topDomainKeyVerify
Verifies the Nth DomainKey-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.
On return, the VerifyInfo property will contain additional information about the DKIM-Signature that was verified (or not verified).
Returns true for success, false for failure.
LoadPublicKey
Caches a public key to be used for verifying DKIM and DomainKey signatures for a given selector and domain. The publicKey is a string containing an RSA public key in any text format, such as XML, PEM, etc. This method will automatically detect the format and load the public key correctly. This method is useful for testing DKIM and DomainKey verification when your public key has not yet been installed in DNS.
Returns true for success, false for failure.
topLoadPublicKeyFile
Caches a public key to be used for verifying DKIM and DomainKey signatures for a given selector and domain. The publicKeyFilepath is a filepath of an RSA public key in any format. This method will automatically detect the format and load the public key correctly. This method is useful for testing DKIM and DomainKey verification when your public key has not yet been installed in DNS.
Returns true for success, false for failure.
topLoadTaskCaller
NumDkimSigs
Returns the number of DKIM-Signature header fields found in mimeData.
NumDomainKeySigs
Returns the number of DomainKey-Signature header fields found in mimeData.
PrefetchPublicKey
Useful if your application is going to verify many emails from a single domain (or a few domains). This eliminates the need to do a DNS lookup to fetch the public key each time an email's DKIM or DomainKey signature is verified.
This method may be called multiple times -- once for each selector/domain to be pre-fetched. The verify methods (VerifyDkimSignature and VerifyDomainKeySignature) will use a pre-fetched key if the selector and domain match.
Returns true for success, false for failure.
topPrefetchPublicKeyAsync (1)
Creates an asynchronous task to call the PrefetchPublicKey method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
SetDkimPrivateKey
Sets the private key file to be used for creating a DKIM-Signature.
Returns true for success, false for failure.
topSetDomainKeyPrivateKey
Sets the private key file to be used for creating a DomainKey-Signature.
Returns true for success, false for failure.
topEvents
To implement an event callback, your application would define and implement a class that inherits from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.
For example:
CkDkim dkim; MyDkimProgress callbackObj; dkim.put_EventCallbackObject(&callbackObj);
MyDkimProgress example:
#include "CkBaseProgress.h"
class MyDkimProgress : public CkBaseProgress {
public:
MyDkimProgress();
virtual ~MyDkimProgress();
void AbortCheck(bool *abort);
void PercentDone(int pctDone, bool *abort);
void ProgressInfo(const char *name, const char *value);
void TaskCompleted(CkTask &task);
};AbortCheck
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.