CkMht Ruby Reference Documentation

CkMht

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

Object Creation

obj = Chilkat::CkMht.new()

Properties

# boolVal is a boolean
boolVal = mht.get_AbortCurrent();
mht.put_AbortCurrent(boolVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_BaseUrl(ckStr);
strVal = mht.baseUrl();
mht.put_BaseUrl(strVal);

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.

# intVal is an integer
intVal = mht.get_ConnectTimeout();
mht.put_ConnectTimeout(intVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_DebugHtmlAfter(ckStr);
strVal = mht.debugHtmlAfter();
mht.put_DebugHtmlAfter(strVal);

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.

# strVal is a string
# ckStr is a CkString
mht.get_DebugHtmlBefore(ckStr);
strVal = mht.debugHtmlBefore();
mht.put_DebugHtmlBefore(strVal);

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.

# strVal is a string
# ckStr is a CkString
mht.get_DebugLogFilePath(ckStr);
strVal = mht.debugLogFilePath();
mht.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.

# boolVal is a boolean
boolVal = mht.get_DebugTagCleaning();
mht.put_DebugTagCleaning(boolVal);

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

# boolVal is a boolean
boolVal = mht.get_EmbedImages();
mht.put_EmbedImages(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_EmbedLocalOnly();
mht.put_EmbedLocalOnly(boolVal);

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

# boolVal is a boolean
boolVal = mht.get_FetchFromCache();
mht.put_FetchFromCache(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_IgnoreMustRevalidate();
mht.put_IgnoreMustRevalidate(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_IgnoreNoCache();
mht.put_IgnoreNoCache(boolVal);

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.

# strVal is a string
# ckStr is a CkString
mht.get_LastErrorHtml(ckStr);
strVal = mht.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
mht.get_LastErrorText(ckStr);
strVal = mht.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.

# strVal is a string
# ckStr is a CkString
mht.get_LastErrorXml(ckStr);
strVal = mht.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 = mht.get_LastMethodSuccess();
mht.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 = mht.get_NoScripts();
mht.put_NoScripts(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_NtlmAuth();
mht.put_NtlmAuth(boolVal);

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.

# intVal is an integer
intVal = mht.get_NumCacheLevels();
mht.put_NumCacheLevels(intVal);

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.

# intVal is an integer
intVal = mht.get_NumCacheRoots();

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.

# boolVal is a boolean
boolVal = mht.get_PreferIpv6();
mht.put_PreferIpv6(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_PreferMHTScripts();
mht.put_PreferMHTScripts(boolVal);

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.

# strVal is a string
# ckStr is a CkString
mht.get_Proxy(ckStr);
strVal = mht.proxy();
mht.put_Proxy(strVal);

(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".

# strVal is a string
# ckStr is a CkString
mht.get_ProxyLogin(ckStr);
strVal = mht.proxyLogin();
mht.put_ProxyLogin(strVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_ProxyPassword(ckStr);
strVal = mht.proxyPassword();
mht.put_ProxyPassword(strVal);

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

# intVal is an integer
intVal = mht.get_ReadTimeout();
mht.put_ReadTimeout(intVal);

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.

# boolVal is a boolean
boolVal = mht.get_RequireSslCertVerify();
mht.put_RequireSslCertVerify(boolVal);

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.

# strVal is a string
# ckStr is a CkString
mht.get_SocksHostname(ckStr);
strVal = mht.socksHostname();
mht.put_SocksHostname(strVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_SocksPassword(ckStr);
strVal = mht.socksPassword();
mht.put_SocksPassword(strVal);

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

# intVal is an integer
intVal = mht.get_SocksPort();
mht.put_SocksPort(intVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_SocksUsername(ckStr);
strVal = mht.socksUsername();
mht.put_SocksUsername(strVal);

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

# intVal is an integer
intVal = mht.get_SocksVersion();
mht.put_SocksVersion(intVal);

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.

# boolVal is a boolean
boolVal = mht.get_UnpackDirect();
mht.put_UnpackDirect(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_UnpackUseRelPaths();
mht.put_UnpackUseRelPaths(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_UpdateCache();
mht.put_UpdateCache(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_UseCids();
mht.put_UseCids(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_UseFilename();
mht.put_UseFilename(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_UseIEProxy();
mht.put_UseIEProxy(boolVal);

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

# boolVal is a boolean
boolVal = mht.get_UseInline();
mht.put_UseInline(boolVal);

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.

# boolVal is a boolean
boolVal = mht.get_Utf8();
mht.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 = mht.get_VerboseLogging();
mht.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
mht.get_Version(ckStr);
strVal = mht.version();

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

# strVal is a string
# ckStr is a CkString
mht.get_WebSiteLogin(ckStr);
strVal = mht.webSiteLogin();
mht.put_WebSiteLogin(strVal);

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

# strVal is a string
# ckStr is a CkString
mht.get_WebSiteLoginDomain(ckStr);
strVal = mht.webSiteLoginDomain();
mht.put_WebSiteLoginDomain(strVal);

The optional domain name to be used with NTLM / Kerberos / Negotiate authentication.

# strVal is a string
# ckStr is a CkString
mht.get_WebSitePassword(ckStr);
strVal = mht.webSitePassword();
mht.put_WebSitePassword(strVal);

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

Methods

# dir is a string
mht.AddCacheRoot(dir);

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

Download Web Page to MHT with w/ Disk Cache

# name is a string
# value is a string
mht.AddCustomHeader(name, value);

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.

# url is a string
mht.AddExternalStyleSheet(url);

(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

mht.ClearCustomHeaders();

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

# pattern is a string
mht.ExcludeImagesMatching(pattern);

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

# url_or_htmlFilepath is a string
# emlPath is a string
status = mht.GetAndSaveEML(url_or_htmlFilepath, emlPath);

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.

# returns a CkTask
# url_or_htmlFilepath is a string
# emlPath is a string
ret_task = mht.GetAndSaveEMLAsync(url_or_htmlFilepath, emlPath);

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

How to Run an Asynchronous Task

# url_or_htmlFilepath is a string
# mhtPath is a string
status = mht.GetAndSaveMHT(url_or_htmlFilepath, mhtPath);

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.

# returns a CkTask
# url_or_htmlFilepath is a string
# mhtPath is a string
ret_task = mht.GetAndSaveMHTAsync(url_or_htmlFilepath, mhtPath);

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

How to Run an Asynchronous Task

# url_or_htmlFilepath is a string
# zipEntryFilename is a string
# zipFilename is a string
status = mht.GetAndZipEML(url_or_htmlFilepath, zipEntryFilename, zipFilename);

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.

# returns a CkTask
# url_or_htmlFilepath is a string
# zipEntryFilename is a string
# zipFilename is a string
ret_task = mht.GetAndZipEMLAsync(url_or_htmlFilepath, zipEntryFilename, zipFilename);

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

How to Run an Asynchronous Task

# url_or_htmlFilepath is a string
# zipEntryFilename is a string
# zipFilename is a string
status = mht.GetAndZipMHT(url_or_htmlFilepath, zipEntryFilename, zipFilename);

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.

# returns a CkTask
# url_or_htmlFilepath is a string
# zipEntryFilename is a string
# zipFilename is a string
ret_task = mht.GetAndZipMHTAsync(url_or_htmlFilepath, zipEntryFilename, zipFilename);

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

How to Run an Asynchronous Task

# index is an integer
# outStr is a CkString (output)
status = mht.GetCacheRoot(index, outStr);
retStr = mht.getCacheRoot(index);

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

Returns true for success, false for failure.

# url_or_htmlFilepath is a string
# outStr is a CkString (output)
status = mht.GetEML(url_or_htmlFilepath, outStr);
retStr = mht.getEML(url_or_htmlFilepath);

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

Returns true for success, false for failure.

# returns a CkTask
# url_or_htmlFilepath is a string
ret_task = mht.GetEMLAsync(url_or_htmlFilepath);

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

How to Run an Asynchronous Task

# url_or_htmlFilepath is a string
# outStr is a CkString (output)
status = mht.GetMHT(url_or_htmlFilepath, outStr);
retStr = mht.getMHT(url_or_htmlFilepath);

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

Returns true for success, false for failure.

# returns a CkTask
# url_or_htmlFilepath is a string
ret_task = mht.GetMHTAsync(url_or_htmlFilepath);

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

How to Run an Asynchronous Task

# htmlText is a string
# outStr is a CkString (output)
status = mht.HtmlToEML(htmlText, outStr);
retStr = mht.htmlToEML(htmlText);

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

# returns a CkTask
# htmlText is a string
ret_task = mht.HtmlToEMLAsync(htmlText);

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

How to Run an Asynchronous Task

# html is a string
# emlFilename is a string
status = mht.HtmlToEMLFile(html, emlFilename);

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.

# returns a CkTask
# html is a string
# emlFilename is a string
ret_task = mht.HtmlToEMLFileAsync(html, emlFilename);

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

How to Run an Asynchronous Task

# htmlText is a string
# outStr is a CkString (output)
status = mht.HtmlToMHT(htmlText, outStr);
retStr = mht.htmlToMHT(htmlText);

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

# returns a CkTask
# htmlText is a string
ret_task = mht.HtmlToMHTAsync(htmlText);

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

How to Run an Asynchronous Task

# html is a string
# mhtFilename is a string
status = mht.HtmlToMHTFile(html, mhtFilename);

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.

# returns a CkTask
# html is a string
# mhtFilename is a string
ret_task = mht.HtmlToMHTFileAsync(html, mhtFilename);

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

How to Run an Asynchronous Task

retBool = mht.IsUnlocked();

Returns true if the MHT component is unlocked.

# name is a string
mht.RemoveCustomHeader(name);

Removes a custom header by header field name.

mht.RestoreDefaults();

Restores the default property settings.

# path is a string
status = mht.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 = mht.UnlockComponent(unlockCode);

Unlocks the component allowing for the full functionality to be used. Returns true if the unlock code is valid.

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

# mhtFilename is a string
# unpackDir is a string
# htmlFilename is a string
# partsSubDir is a string
status = mht.UnpackMHT(mhtFilename, unpackDir, htmlFilename, partsSubDir);

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.

# mhtString is a string
# unpackDir is a string
# htmlFilename is a string
# partsSubDir is a string
status = mht.UnpackMHTString(mhtString, unpackDir, htmlFilename, partsSubDir);

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

Returns true for success, false for failure.