Mht Xojo Plugin 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

Dim mht As New Chilkat.Mht

Properties

AbortCurrent

AbortCurrent As Boolean

Introduced in version 9.5.0.58

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.)

BaseUrl

BaseUrl As String

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

ConnectTimeout As Int32

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

DebugHtmlAfter

DebugHtmlAfter As String

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

DebugHtmlBefore As String

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

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:

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

DebugTagCleaning As Boolean

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

EmbedImages

EmbedImages As Boolean

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

EmbedLocalOnly As Boolean

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

FetchFromCache

FetchFromCache As Boolean

If True, 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 False.

HeartbeatMs

HeartbeatMs As Int32

The time interval, in milliseconds, between AbortCheck event callbacks. The heartbeat/AbortCheck provides a means for an application to abort any MHT method before completion.

The default value is 0, which means that no AbortCheck events will be fired.

IgnoreMustRevalidate

IgnoreMustRevalidate As Boolean

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 True, 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 True)

The default value of this property is False.

IgnoreNoCache

IgnoreNoCache As Boolean

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 True.

The default value of this property is False.

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.

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

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.

LastMethodSuccess

LastMethodSuccess As Boolean

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.

NoScripts

NoScripts As Boolean

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

NtlmAuth

NtlmAuth As Boolean

Setting this property to True 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 False.

NumCacheLevels

NumCacheLevels As Int32

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

NumCacheRoots As Int32 (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

PreferIpv6 As Boolean

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

PreferMHTScripts

PreferMHTScripts As Boolean

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

Proxy

Proxy As String

(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

ProxyLogin As String

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

ProxyPassword

ProxyPassword As String

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

ReadTimeout

ReadTimeout As Int32

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

RequireSslCertVerify As Boolean

If True, 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 False.

SocksHostname

SocksHostname As String

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

SocksPassword As String

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

SocksPort

SocksPort As Int32

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

SocksUsername As String

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

SocksVersion

SocksVersion As Int32

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

UnpackDirect As Boolean

Introduced in version 9.5.0.47

If True, 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 False.

UnpackUseRelPaths

UnpackUseRelPaths As Boolean

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

UpdateCache

UpdateCache As Boolean

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

UseCids

UseCids As Boolean

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

The default value of this property is True.

UseFilename

UseFilename As Boolean

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

The default value of this property is True.

UseIEProxy

UseIEProxy As Boolean

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

UseInline

UseInline As Boolean

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

The default value of this property is True.

VerboseLogging

VerboseLogging As Boolean

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.

Version

Version As String (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

WebSiteLogin As String

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

WebSiteLoginDomain

WebSiteLoginDomain As String

The optional domain name to be used with NTLM authentication.

WebSitePassword

WebSitePassword As String

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

Methods

AddCacheRoot

Sub AddCacheRoot(dir As String)

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

Sub AddCustomHeader(name As String, value As String)

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

Sub AddExternalStyleSheet(url As String)

(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

Sub ClearCustomHeaders()

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

ExcludeImagesMatching

Sub ExcludeImagesMatching(pattern As String)

(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

Function GetAndSaveEML(url_or_htmlFilepath As String, emlPath As String) As Boolean

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 True for success, False for failure.

GetAndSaveEMLAsync ⁽¹⁾

Function GetAndSaveEMLAsync(url_or_htmlFilepath As String, emlPath As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

GetAndSaveMHT

Function GetAndSaveMHT(url_or_htmlFilepath As String, mhtPath As String) As Boolean

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 True for success, False 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 ⁽¹⁾

Function GetAndSaveMHTAsync(url_or_htmlFilepath As String, mhtPath As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

GetAndZipEML

Function GetAndZipEML(url_or_htmlFilepath As String, zipEntryFilename As String, zipFilename As String) As Boolean

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 True for success, False for failure.

GetAndZipEMLAsync ⁽¹⁾

Function GetAndZipEMLAsync(url_or_htmlFilepath As String, zipEntryFilename As String, zipFilename As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

GetAndZipMHT

Function GetAndZipMHT(url_or_htmlFilepath As String, zipEntryFilename As String, zipFilename As String) As Boolean

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 True for success, False for failure.

GetAndZipMHTAsync ⁽¹⁾

Function GetAndZipMHTAsync(url_or_htmlFilepath As String, zipEntryFilename As String, zipFilename As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

GetCacheRoot

Function GetCacheRoot(index As Int32) As String

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

Returns Nil on failure

GetEML

Function GetEML(url_or_htmlFilepath As String) As String

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

Returns Nil on failure

GetEMLAsync ⁽¹⁾

Function GetEMLAsync(url_or_htmlFilepath As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

GetMHT

Function GetMHT(url_or_htmlFilepath As String) As String

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

Returns Nil on failure

GetMHTAsync ⁽¹⁾

Function GetMHTAsync(url_or_htmlFilepath As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

HtmlToEML

Function HtmlToEML(htmlText As String) As String

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 Nil on failure

HtmlToEMLAsync ⁽¹⁾

Function HtmlToEMLAsync(htmlText As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

HtmlToEMLFile

Function HtmlToEMLFile(html As String, emlFilename As String) As Boolean

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 True for success, False for failure.

HtmlToEMLFileAsync ⁽¹⁾

Function HtmlToEMLFileAsync(html As String, emlFilename As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

HtmlToMHT

Function HtmlToMHT(htmlText As String) As String

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 Nil on failure

HtmlToMHTAsync ⁽¹⁾

Function HtmlToMHTAsync(htmlText As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

HtmlToMHTFile

Function HtmlToMHTFile(html As String, mhtFilename As String) As Boolean

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 True for success, False for failure.

HtmlToMHTFileAsync ⁽¹⁾

Function HtmlToMHTFileAsync(html As String, mhtFilename As String) As Chilkat.Task

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

LoadTaskCaller

Function LoadTaskCaller(task As Chilkat.Task) As Boolean

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

RemoveCustomHeader

Sub RemoveCustomHeader(name As String)

Removes a custom header by header field name.

RestoreDefaults

Sub RestoreDefaults()

Restores the default property settings.

UnpackMHT

Function UnpackMHT(mhtFilename As String, unpackDir As String, htmlFilename As String, partsSubDir As String) As Boolean

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 True for success, False for failure.

More Information and Examples

Unpack MHT to Files

UnpackMHTString

Function UnpackMHTString(mhtString As String, unpackDir As String, htmlFilename As String, partsSubDir As String) As Boolean

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

Returns True for success, False for failure.

More Information and Examples

Extract all HTML Objects from a Web Page

Events

To implement events, your application would define and implement a class that is a subclass of Chilkat.Mht. Your custom class would implement (i.e. override) some or all of the event methods.

For example:

class MyMht
    Inherits Chilkat.Mht

    Function AbortCheck() As Boolean

    Function PercentDone(pctDone As Int32) As Boolean

    Sub ProgressInfo(name As String, value As String)

    Sub TaskCompleted(task As Chilkat.Task)


End Class

AbortCheck

Function AbortCheck() As Boolean

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

PercentDone

Function PercentDone(pctDone As Int32) As Boolean

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to True will cause the method to abort and return a failed status (or whatever return value indicates failure).

ProgressInfo

Sub ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

TaskCompleted

Sub TaskCompleted(task As Chilkat.Task)

Called in the background thread when an asynchronous task completes.

top