Chilkat.Mht PHP Reference
Chilkat.Mht
Chilkat MHT can generate email objects from HTML files and URLs, and convert HTML to MHT or EML files.
Object Creation
$obj = new COM("Chilkat.Mht");
Properties
string BaseUrl
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.
int ConnectTimeout
The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default value is 10 seconds.
string DebugHtmlAfter
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.
string DebugHtmlBefore
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.
bool DebugTagCleaning
When true causes the Mht class to be much more verbose in its logging. The default is false.
bool EmbedImages
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.
bool EmbedLocalOnly
If true, only images found on the local filesystem (i.e. links to files) will be embedded within the MHT.
bool FetchFromCache
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.
int HeartbeatMs
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.
bool IgnoreMustRevalidate
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.
bool IgnoreNoCache
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.
string LastErrorHtml (read-only)
To be documented soon.Error information in HTML format for the last method called.
string LastErrorText (read-only)
Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
Error information in XML format for the last method called.
bool NoScripts
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.
bool NtlmAuth
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.
int NumCacheLevels
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.
int NumCacheRoots (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.
bool PreferMHTScripts
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.
string Proxy
(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".
string ProxyLogin
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
string ProxyPassword
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
int ReadTimeout
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.
bool UpdateCache
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.
bool UseCids
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.
bool UseFilename
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.
bool UseIEProxy
If true, the proxy host/port used by Internet Explorer will also be used by Chilkat MHT.
bool UseInline
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.
string Version (read-only)
The version of the component, such as "1.0.0"
string WebSiteLogin
(Optional) Specifies the login if a a Web page is accessed that requires a login
string WebSitePassword
Optional) Specifies the password if a a Web page is accessed that requires a login and password
Methods
void AddCacheRoot(string dirPath)
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".
void AddCustomHeader(string name, string 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.
void AddExternalStyleSheet(string 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
void ClearCustomHeaders()
Removes all custom headers that may have accumulated from previous calls to AddCustomHeader.
void ExcludeImagesMatching(string 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.
bool GetAndSaveEML(string url_or_htmlFilepath, string outputEmlFilename)
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.
bool GetAndSaveMHT(string url_or_htmlFilepath, string outputMhtFilename)
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.
bool GetAndZipEML(string url_or_htmlFilepath, string zipEntryFilename, string 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 1 for success, 0 for failure.
bool GetAndZipMHT(string url_or_htmlFilepath, string zipEntryFilename, string 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 1 for success, 0 for failure.
string GetCacheRoot(int index)
Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times. Returns a null on failure
string GetEML(string url_or_htmlFilepath)
Creates EML from a web page or HTML file, and returns the EML (MIME) message data as a string. Returns a null on failure
Chilkat.Email GetEmail(string url_or_htmlFilePath)
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. Returns a null reference on failure
string GetMHT(string url_or_htmlFilepath)
Creates MHT from a web page or local HTML file, and returns the MHT (MIME) message data as a string Returns a null on failure
Chilkat.Mime GetMime(string url_or_htmlFilePath)
Converts a web Page (URL) or HTML file to a Chilkat Mime object. Returns a null reference on failure.
string HtmlToEML(string html)
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 a null on failure
bool HtmlToEMLFile(string html, string 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 1 for success, 0 for failure.
Chilkat.Email HtmlToEmail(string html)
Creates an email object from an in-memory HTML string. Returns a null reference on failure. Returns a null reference on failure
string HtmlToMHT(string html)
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 a null on failure
bool HtmlToMHTFile(string html, string 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 1 for success, 0 for failure.
bool IsUnlocked()
Returns true if the MHT component is unlocked.
void RemoveCustomHeader(string name)
Removes a custom header by header field name.
void RestoreDefaults()
Restores the default property settings.
bool SaveLastError(string logFilename)
Saves the last error information to an XML formatted file.
bool UnlockComponent(string unlockCode)
Unlocks the component allowing for the full functionality to be used. Returns true if the unlock code is valid.
bool UnpackMHT(string mhtFilename, string unpackDir, string outputHtmlFilename, string 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 outputHtmlFilename, 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.
bool UnpackMHTString(string mhtString, string unpackDir, string outputHtmlFilename, string partsSubDir)
Same as UnpackMHT, except the MHT is passed in as an in-memory string. Returns 1 for success, 0 for failure.
|