Chilkat VB.NET Mht Class Reference
Mht
Chilkat MHT can generate email objects from HTML files and URLs, and convert HTML to MHT or EML files.
Properties
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 As Integer
The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default value is 10 seconds.
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 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.
DebugTagCleaning As Boolean
When true causes the Mht class to be much more verbose in its logging. The default is false.
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.
EnableEvents As Boolean
This property must be set to true to enable events. The default value is false.
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 As Integer
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 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 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 As String (ReadOnly)
To be documented soon.Error information in HTML format for the last method called.
LastErrorText As String (ReadOnly)
Error information in plain-text format for the last method called.
LastErrorXml As String (ReadOnly)
Error information in XML format for the last method called.
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 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 As Integer
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 As Integer (ReadOnly)
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.
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 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 As String
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
ProxyPassword As String
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
ReadTimeout As Integer
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.
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 As Boolean
Controls whether CID URLs are used for embedded references when generating MHT or EML documents. If UseCids is false (the default), 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.
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 As Boolean
To be documented soon...
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.
Version As String (ReadOnly)
The version of the component, such as "1.0.0"
WebSiteLogin As String
(Optional) Specifies the login if a a Web page is accessed that requires a login
WebSitePassword As String
Optional) Specifies the password if a a Web page is accessed that requires a login and password
Methods
Sub AddCacheRoot(ByVal 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".
Sub AddCustomHeader(ByVal name As String, ByVal 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.
Sub AddExternalStyleSheet(ByVal 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
Sub ClearCustomHeaders()
Removes all custom headers that may have accumulated from previous calls to AddCustomHeader.
Sub ExcludeImagesMatching(ByVal 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.
Function GetAndSaveEML(ByVal url_or_htmlFilepath As String, ByVal outputEmlFilename 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.
Function GetAndSaveMHT(ByVal url_or_htmlFilepath As String, ByVal outputMhtFilename 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.
Function GetAndZipEML(ByVal url_or_htmlFilepath As String, ByVal zipEntryFilename As String, ByVal 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.
Function GetAndZipMHT(ByVal url_or_htmlFilepath As String, ByVal zipEntryFilename As String, ByVal 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.
Function GetCacheRoot(ByVal index As Integer) As String
Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times. Returns Nothing on failure
Function GetEML(ByVal 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 Nothing on failure
Function GetEmail(ByVal url_or_htmlFilePath As String) As Email
Downloads a web page and creates an HTML Email object that can be sent using Chilkat Email component. Embedded within the email are all the images and style sheets referenced from the web page.
Returns a null reference on failure.
Function GetMHT(ByVal 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 Nothing on failure
Function GetMime(ByVal url_or_htmlFilePath As String) As Mime
Converts a web Page (URL) or HTML file to a Chilkat Mime object. Returns a null reference on failure.
Function HtmlToEML(ByVal 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 Nothing on failure
Function HtmlToEMLFile(ByVal html As String, ByVal 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.
Function HtmlToEmail(ByVal html As String) As Email
Creates an email object from an in-memory HTML string. Returns a null reference on failure.
Function HtmlToMHT(ByVal 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 Nothing on failure
Function HtmlToMHTFile(ByVal html As String, ByVal 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.
Function IsUnlocked() As Boolean
Returns true if the MHT component is unlocked.
Sub RemoveCustomHeader(ByVal name As String)
Removes a custom header by header field name.
Sub RestoreDefaults()
Restores the default property settings.
Function SaveLastError(ByVal filename As String) As Boolean
Saves the last error information to an XML formatted file.
Function UnlockComponent(ByVal unlockCode As String) As Boolean
Unlocks the component allowing for the full functionality to be used. Returns true if the unlock code is valid.
Function UnpackMHT(ByVal mhtFilename As String, ByVal unpackDir As String, ByVal outputHtmlFilename As String, ByVal 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 outputHtmlFilename, 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.
Function UnpackMHTString(ByVal mhtString As String, ByVal unpackDir As String, ByVal outputHtmlFilename As String, ByVal 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.
|