Mht PureBasic Reference Documentation

Mht

Current Version: 10.1.0

Requires Chilkat Bundle License

Chilkat MHT can generate email objects from HTML files and URLs, and convert HTML to MHT or EML files.

Object Creation

obj.i = CkMht::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMht::ckDispose(obj);

Properties

AbortCurrent

Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)

Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

BaseUrl

Declare.s ckBaseUrl(obj.i)
Declare setCkBaseUrl(obj.i, value.s)

When processing an HTML file or string (not a website URL), this defines the base URL to be used when converting relative HREFs to absolute HREFs.

ConnectTimeout

Declare.i ckConnectTimeout(obj.i)
Declare setCkConnectTimeout(obj.i, value.i)

The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default value is 10 seconds.

DebugHtmlAfter

Declare.s ckDebugHtmlAfter(obj.i)
Declare setCkDebugHtmlAfter(obj.i, value.s)

A filename to save the result HTML when converting a URL, file, or HTML string. If problems are experienced, the before/after HTML can be analyzed to help determine the cause.

DebugHtmlBefore

Declare.s ckDebugHtmlBefore(obj.i)
Declare setCkDebugHtmlBefore(obj.i, value.s)

A filename to save the input HTML when converting a URL, file, or HTML string. If problems are experienced, the before/after HTML can be analyzed to help determine the cause.

DebugLogFilePath

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

DebugTagCleaning

Declare.i ckDebugTagCleaning(obj.i)
Declare setCkDebugTagCleaning(obj.i, value.i)

When 1 causes the Mht class to be much more verbose in its logging. The default is 0.

EmbedImages

Declare.i ckEmbedImages(obj.i)
Declare setCkEmbedImages(obj.i, value.i)

Controls whether images are embedded in the MHT/EML, or whether the IMG SRC attributes are left as external URL references. If false, the IMG SRC tags are converted to absolute URLs (if necessary) and the images are not embedded within the MHT/EML.

EmbedLocalOnly

Declare.i ckEmbedLocalOnly(obj.i)
Declare setCkEmbedLocalOnly(obj.i, value.i)

If 1, only images found on the local filesystem (i.e. links to files) will be embedded within the MHT.

FetchFromCache

Declare.i ckFetchFromCache(obj.i)
Declare setCkFetchFromCache(obj.i, value.i)

If 1, page parts such as images, style sheets, etc. will be fetched from the disk cache if possible. The disk cache root may be defined by calling AddCacheRoot. The default value is 0.

IgnoreMustRevalidate

Declare.i ckIgnoreMustRevalidate(obj.i)
Declare setCkIgnoreMustRevalidate(obj.i, value.i)

Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to 1, then Chilkat MHT will serve the page directly from cache without revalidating until the page is no longer fresh. (assuming that FetchFromCache is set to 1)

The default value of this property is 0.

IgnoreNoCache

Declare.i ckIgnoreNoCache(obj.i)
Declare setCkIgnoreNoCache(obj.i, value.i)

Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat MHT will adhere to this unless this property is set to 1.

The default value of this property is 0.

LastErrorHtml

Declare.s ckLastErrorHtml(obj.i) ; (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.

LastErrorText

Declare.s ckLastErrorText(obj.i) ; (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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Declare.s ckLastErrorXml(obj.i) ; (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.

LastMethodSuccess

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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.

NoScripts

Declare.i ckNoScripts(obj.i)
Declare setCkNoScripts(obj.i, value.i)

Only applies when creating MHT files. Scripts are always removed when creating EML or emails from HTML. If set to 1, then all scripts are removed, if set to 0 (the default) then scripts are not removed.

NtlmAuth

Declare.i ckNtlmAuth(obj.i)
Declare setCkNtlmAuth(obj.i, value.i)

Setting this property to 1 causes the MHT component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server.

The default value of this property is 0.

NumCacheLevels

Declare.i ckNumCacheLevels(obj.i)
Declare setCkNumCacheLevels(obj.i, value.i)

The number of directory levels to be used under each cache root. The default is 0, meaning that each cached item is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The MHT control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.

NumCacheRoots

Declare.i ckNumCacheRoots(obj.i) ; (read-only)

The number of cache roots to be used for the disk cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". To create a cache with four roots, call AddCacheRoot once for each directory root.

PreferIpv6

Declare.i ckPreferIpv6(obj.i)
Declare setCkPreferIpv6(obj.i, value.i)

If 1, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is 0, which will choose IPv4 over IPv6.

PreferMHTScripts

Declare.i ckPreferMHTScripts(obj.i)
Declare setCkPreferMHTScripts(obj.i, value.i)

This property provides a means for the noscript option to be selected when possible. If PreferMHTScripts = 0, then scripts with noscript alternatives are removed and the noscript content is kept. If 1 (the default), then scripts are preserved and the noscript options are discarded.

Proxy

Declare.s ckProxy(obj.i)
Declare setCkProxy(obj.i, value.s)

(Optional) A proxy host:port if a proxy is necessary to access the Internet. The proxy string should be formatted as "hostname:port", such as "www.chilkatsoft.com:100".

ProxyLogin

Declare.s ckProxyLogin(obj.i)
Declare setCkProxyLogin(obj.i, value.s)

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

ProxyPassword

Declare.s ckProxyPassword(obj.i)
Declare setCkProxyPassword(obj.i, value.s)

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

ReadTimeout

Declare.i ckReadTimeout(obj.i)
Declare setCkReadTimeout(obj.i, value.i)

The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long data transfer, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire data transfer.

The default value is 20 seconds.

RequireSslCertVerify

Declare.i ckRequireSslCertVerify(obj.i)
Declare setCkRequireSslCertVerify(obj.i, value.i)

If 1, then the HTTP client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is 0.

SocksHostname

Declare.s ckSocksHostname(obj.i)
Declare setCkSocksHostname(obj.i, value.s)

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

SocksPassword

Declare.s ckSocksPassword(obj.i)
Declare setCkSocksPassword(obj.i, value.s)

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

SocksPort

Declare.i ckSocksPort(obj.i)
Declare setCkSocksPort(obj.i, value.i)

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

SocksUsername

Declare.s ckSocksUsername(obj.i)
Declare setCkSocksUsername(obj.i, value.s)

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

SocksVersion

Declare.i ckSocksVersion(obj.i)
Declare setCkSocksVersion(obj.i, value.i)

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

UnpackDirect

Declare.i ckUnpackDirect(obj.i)
Declare setCkUnpackDirect(obj.i, value.i)

Introduced in version 9.5.0.47

If 1, then the UnpackMHT and UnpackMHTString methods will unpack the MHT directly with no transformations. Normally, the related parts are unpacked to a "parts" sub-directory, and the unpacked HTML is edited to update references to point to the unpacked image and script files. When unpacking direct, the HTML is not edited, and the related parts are unpacked to sub-directories rooted in the directory where HTML file is created (i.e. the unpack directory). When unpacking direct, the "partsSubDir" argument of the UnpackMHT* methods is unused.

Note: It is only possible to directly unpack MHT files where the Content-Location headers DO NOT contain URLs. The MHT must be such that the Content-Location headers of the related items contain relative paths.

Note: The default value of this property is 0.

UnpackUseRelPaths

Declare.i ckUnpackUseRelPaths(obj.i)
Declare setCkUnpackUseRelPaths(obj.i, value.i)

Controls whether absolute or relative paths are used when referencing images in the unpacked HTML. The default value is 1 indicating that relative paths will be used. To use absolute paths, set this property value equal to 0.

UpdateCache

Declare.i ckUpdateCache(obj.i)
Declare setCkUpdateCache(obj.i, value.i)

Controls whether the cache is automatically updated with the responses from HTTP GET requests. If 1, the disk cache is updated, if 0 (the default), the cache is not updated.

UseCids

Declare.i ckUseCids(obj.i)
Declare setCkUseCids(obj.i, value.i)

Controls whether CID URLs are used for embedded references when generating MHT or EML documents. If UseCids is 0, then URLs are left unchanged and the embedded items will contain "content-location" headers that match the URLs in the HTML. If 1, CIDs are generated and the URLs within the HTML are replaced with "CID:" links.

The default value of this property is 1.

UseFilename

Declare.i ckUseFilename(obj.i)
Declare setCkUseFilename(obj.i, value.i)

If 1, a "filename" attribute is added to each Content-Disposition MIME header field for each embedded item (image, style sheet, etc.). If 0, then no filename attribute is added.

The default value of this property is 1.

UseIEProxy

Declare.i ckUseIEProxy(obj.i)
Declare setCkUseIEProxy(obj.i, value.i)

If 1, the proxy host/port used by Internet Explorer will also be used by Chilkat MHT.

UseInline

Declare.i ckUseInline(obj.i)
Declare setCkUseInline(obj.i, value.i)

If 1, an "inline" attribute is added to each Content-Disposition MIME header field for each embedded item (image, style sheet, etc.). If 0, then no inline attribute is added.

The default value of this property is 1.

VerboseLogging

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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.

Version

Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

WebSiteLogin

Declare.s ckWebSiteLogin(obj.i)
Declare setCkWebSiteLogin(obj.i, value.s)

(Optional) Specifies the login if a a Web page is accessed that requires a login

WebSiteLoginDomain

Declare.s ckWebSiteLoginDomain(obj.i)
Declare setCkWebSiteLoginDomain(obj.i, value.s)

The optional domain name to be used with NTLM authentication.

WebSitePassword

Declare.s ckWebSitePassword(obj.i)
Declare setCkWebSitePassword(obj.i, value.s)

Optional) Specifies the password if a a Web page is accessed that requires a login and password

Methods

AddCacheRoot

Declare ckAddCacheRoot(obj.i, dir.s)

If disk caching is used, this must be called once for each cache root. For example, if the cache is spread across D:\cacheRoot, E:\cacheRoot, and F:\cacheRoot, an application would setup the cache object by calling AddRoot three times -- once with "D:\cacheRoot", once with "E:\cacheRoot", and once with "F:\cacheRoot".

More Information and Examples

Download Web Page to MHT with w/ Disk Cache

AddCustomHeader

Declare ckAddCustomHeader(obj.i, name.s, value.s)

Adds a custom HTTP header to all HTTP requests sent by the MHT component. To add multiple header fields, call this method once for each custom header.

AddExternalStyleSheet

Declare ckAddExternalStyleSheet(obj.i, url.s)

(This method rarely needs to be called.) Includes an additional style sheet that would not normally be included with the HTML. This method is provided for cases when style sheet names are constructed and dynamically included in Javascript such that MHT .NET cannot know beforehand what stylesheet to embed. MHT .NET by default downloads and embeds all stylesheets externally referenced by the HTML

ClearCustomHeaders

Declare ckClearCustomHeaders(obj.i)

Removes all custom headers that may have accumulated from previous calls to AddCustomHeader.

ExcludeImagesMatching

Declare ckExcludeImagesMatching(obj.i, pattern.s)

(This method rarely needs to be called.) Tells Chilkat MHT .NET to not embed any images whose URL matches a pattern. Sometimes images can be referenced within style sheets and not actually used when rendering the page. In cases like those, the image will appear as an attachment in the HTML email. This feature allows you to explicitly remove those images from the email so no attachments appear.

GetAndSaveEML

Declare.i ckGetAndSaveEML(obj.i, url_or_htmlFilepath.s, emlPath.s)

Creates an EML file from a web page or HTML file. All external images and style sheets are downloaded and embedded in the EML file.

Returns 1 for success, 0 for failure.

GetAndSaveEMLAsync ⁽¹⁾

Declare.i ckGetAndSaveEMLAsync(obj.i, url_or_htmlFilepath.s, emlPath.s)

Creates an asynchronous task to call the GetAndSaveEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetAndSaveMHT

Declare.i ckGetAndSaveMHT(obj.i, url_or_htmlFilepath.s, mhtPath.s)

Creates an MHT file from a web page or local HTML file. All external images, scripts, and style sheets are downloaded and embedded in the MHT file.

Returns 1 for success, 0 for failure.

More Information and Examples

Example to Download Web Page as MHT Archive Pack Local HTML File and Referenced Images as MHT Archive

GetAndSaveMHTAsync ⁽¹⁾

Declare.i ckGetAndSaveMHTAsync(obj.i, url_or_htmlFilepath.s, mhtPath.s)

Creates an asynchronous task to call the GetAndSaveMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetAndZipEML

Declare.i ckGetAndZipEML(obj.i, url_or_htmlFilepath.s, zipEntryFilename.s, zipFilename.s)

Creates an EML file from a web page or HTML file, compresses, and appends to a new or existing Zip file. All external images and style sheets are downloaded and embedded in the EML.

Returns 1 for success, 0 for failure.

GetAndZipEMLAsync ⁽¹⁾

Declare.i ckGetAndZipEMLAsync(obj.i, url_or_htmlFilepath.s, zipEntryFilename.s, zipFilename.s)

Creates an asynchronous task to call the GetAndZipEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetAndZipMHT

Declare.i ckGetAndZipMHT(obj.i, url_or_htmlFilepath.s, zipEntryFilename.s, zipFilename.s)

Creates an MHT file from a web page or HTML file, compresses, and appends to a new or existing Zip file. All external images and style sheets are downloaded and embedded in the MHT.

Returns 1 for success, 0 for failure.

GetAndZipMHTAsync ⁽¹⁾

Declare.i ckGetAndZipMHTAsync(obj.i, url_or_htmlFilepath.s, zipEntryFilename.s, zipFilename.s)

Creates an asynchronous task to call the GetAndZipMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetCacheRoot

Declare.s ckGetCacheRoot(obj.i, index.l)

Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetEML

Declare.s ckGetEML(obj.i, url_or_htmlFilepath.s)

Creates EML from a web page or HTML file, and returns the EML (MIME) message data as a string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetEMLAsync ⁽¹⁾

Declare.i ckGetEMLAsync(obj.i, url_or_htmlFilepath.s)

Creates an asynchronous task to call the GetEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetMHT

Declare.s ckGetMHT(obj.i, url_or_htmlFilepath.s)

Creates MHT from a web page or local HTML file, and returns the MHT (MIME) message data as a string

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetMHTAsync ⁽¹⁾

Declare.i ckGetMHTAsync(obj.i, url_or_htmlFilepath.s)

Creates an asynchronous task to call the GetMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

HtmlToEML

Declare.s ckHtmlToEML(obj.i, htmlText.s)

Creates an in-memory EML string from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the EML string that is returned.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

HtmlToEMLAsync ⁽¹⁾

Declare.i ckHtmlToEMLAsync(obj.i, htmlText.s)

Creates an asynchronous task to call the HtmlToEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

HtmlToEMLFile

Declare.i ckHtmlToEMLFile(obj.i, html.s, emlFilename.s)

Creates an EML file from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the EML file.

Returns 1 for success, 0 for failure.

HtmlToEMLFileAsync ⁽¹⁾

Declare.i ckHtmlToEMLFileAsync(obj.i, html.s, emlFilename.s)

Creates an asynchronous task to call the HtmlToEMLFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

HtmlToMHT

Declare.s ckHtmlToMHT(obj.i, htmlText.s)

Creates an in-memory MHT web archive from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the MHT string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

HtmlToMHTAsync ⁽¹⁾

Declare.i ckHtmlToMHTAsync(obj.i, htmlText.s)

Creates an asynchronous task to call the HtmlToMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

HtmlToMHTFile

Declare.i ckHtmlToMHTFile(obj.i, html.s, mhtFilename.s)

Creates an MHT file from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the MHT file.

Returns 1 for success, 0 for failure.

HtmlToMHTFileAsync ⁽¹⁾

Declare.i ckHtmlToMHTFileAsync(obj.i, html.s, mhtFilename.s)

Creates an asynchronous task to call the HtmlToMHTFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

RemoveCustomHeader

Declare ckRemoveCustomHeader(obj.i, name.s)

Removes a custom header by header field name.

RestoreDefaults

Declare ckRestoreDefaults(obj.i)

Restores the default property settings.

UnpackMHT

Declare.i ckUnpackMHT(obj.i, mhtFilename.s, unpackDir.s, htmlFilename.s, partsSubDir.s)

Unpacks the contents of a MHT file. The destination directory is specified by unpackDir. The name of the HTML file created is specified by htmlFilename, and supporting files (images, javascripts, etc.) are created in partsSubDir, which is automatically created if it does not already exist.

Returns 1 for success, 0 for failure.

More Information and Examples

Unpack MHT to Files

UnpackMHTString

Declare.i ckUnpackMHTString(obj.i, mhtString.s, unpackDir.s, htmlFilename.s, partsSubDir.s)

Same as UnpackMHT, except the MHT is passed in as an in-memory string.

Returns 1 for success, 0 for failure.

More Information and Examples

Extract all HTML Objects from a Web Page