Class wwIPStuff
| West Wind Internet Protocols 4.68 |
| Class wwIPStuff
|
Internet Protocol Class that encapsulates simplefied SMTP, HTTP, FTP, DNS resolution and RAS dialing. Relies on wwIPStuff.dll for various support functionality to access TCP/IP and WinInet functions.
Note:
wwIPStuff originally contained all of the methods supported in the wwHTTP class. wwHTTP now implements all of the HTTP functionality in the West Wind Internet Protocols, but wwIPStuff continues to contain the same methods as wwHTTP for backwards compatibility. However, from here on forward any updates to the HTTP class methods are only made in wwHTTP and eventually HTTP support may be completely removed from wwIPStuff. We highly recommend you change your classes used for HTTP access to wwHTTP.
| Member | Description |
|---|---|
 AddHeader | This method adds Extra Headers for the SMTP mail client. o.AddHeader(lcHeader,lcValue) |
| Base64Decode | Decodes a Base64 string back into a readable string. o.Base64Decode(lcInput) |
| Base64Encode | Encodes a string into Base64 format. o.Base64Encode(lcInput) |
| decodedbf | Takes a string encoded with EncodeDbf() and converts it back into a physical file. If the string contains a DBF with a memo the memo is also restored. o.decodedbf(lcBuffer, lcDBF) |
| encodedbf | Takes a single file (DBF or otherwise) or a DBF/MEMO pair and encodes it into a string. String includes a header for verification and information about the file. Use DecodeDbf() to restore the string to a file. o.encodedbf(lcDBF, llHasMemo, lcEncodedName) |
| encodefile | Takes a single file (DBF or otherwise) or a DBF/MEMO pair and encodes it into a string. String includes a header for verification and information about the file. Use DecodeDbf() to restore the string to a file. o.encodefile(lcFileName) |
| getdomainfromip | Retrieves the Domain Name from an IP Address. o.getdomainfromip(lcIPAddress) |
| getipfromdomain | Retrieves the IP address from a Domain name by resolving DNS. o.getipfromdomain(lcDomain) |
| getlastinterneterror | Returns the last WinInet Error Message. Applies only to FTP functions. Call this method on HTTP and FTP errors that return 'generic' error codes. o.getlastinterneterror(lnError) |
| getsystemerrormsg | Returns a WinInet or Win32 API error message. o.getsystemerrormsg(lnErrorNo, llAPI) |
| InternetDial | Brings up the Windows Dialer dialog that prompts for connection info and dials the connection requested. o.InternetDial(llUnattended,lcConnection) |
| InternetHangup | Hangs up a connection previously established with InternetDial. o.InternetHangup(lnHandle) |
| rashangup | Hangs up a previously dialed RAS connection. Requires handle! o.rashangup() |
| sendmail | This method allows sending of SMTP email which is the most common Email interface for the Internet. This method requires that you have access to an SMTP mail server. o.sendmail() |
| sendmailasync | Same as SendMail() but operation runs on a separate thread asynchronously and immediately returns to the calling code. No error code is returned. Please see SendMail for details. o.sendmailasync() |
| SendMapiMail | This method allows sending mail using the Microsoft MAPI protocols using the current MAPI profile. It uses the same properties as the SendMail method minus the sender address info. o.SendMapiMail() |
| unzipfiles | Simple file UnZipping interface to the DynaZip Unzip DLL (not provided). This method call talks directly to the DLL bypassing the ActiveX Control. o.unzipfiles(lcZipFile, lcDestination, lcFileSpec) |
| wininetsettimeout | Allows setting the timeout period for each type of connection and transfer operation. Specify in seconds. (WinInet does not always respect this setting correctly) o.wininetsettimeout(dwTimeoutSecs) |
| zipfiles | Simple file Zipping interface to the DynaZip Zip DLL (not provided). This method call talks directly to the DLL bypassing the ActiveX Control. o.zipfiles(lcZipFile, lcFileList, lnCompression) |
 cAlternateContent | Allows you to specify alternate content for a message. Allows mixed content message for example that send text and Html so that that non-html email clients can read the text as text and html clients can see the Html |
| cattachment | SMTP File Attachment. This string can point to one or more files on disk. |
| cbcclist | SMTP Comma Delimited Blind Carbon Copy list |
| ccclist | SMTP Comma Delimited Carbon Copy list |
| ccontenttype | The content type of the main message body of an SMTP message. Use this to format text of the message in different formats such as HTML. |
| cContentTypeAlternate | Content type for an Alternate content string set in wwIPStuff::cMessageAlternate, which is used for sending mixed mode messages that display as text on non HTML capable browsers and Html on those that can. |
| cerrormsg | Last Error Message Text for the last operation. Implemented only for SMTP and HTTP operations. |
| cExtraHeaders | Allows you to specify extra HTTP or SMTP headers when sending requests to SMTP servers. |
| cLogFile | If set causes the mail session to be logged to the file you specify. All received and sent data is written as well as a start and complete/failure entry. |
| cmailserver | Domain name or IP address for your SMTP Server |
| cmessage | SMTP Message Body text. |
| cpassword | Password to log on to server (applies to SMTP, FTP and HTTP) |
| cpriority | Priority of the email message. |
| crecipient | SMTP Message Recipient list. Comma Delimited if multiples. |
| csenderemail | Email address of the SMTP message sender (return address). |
| csendername | Display name of SMTP message Sender. |
| cserver | HTTP Server Address. Format: www.west-wind.com, or 111.111.111.111 |
| csubject | SMTP Message Subject. |
| cusername | Username for log in operations (SMTP, FTP and HTTP). |
| cVersion | The version number of the wwIPStuff library. This version number should match the DLL version resource. Use this method to verify the correct match between the class and the wwIPStuff.dll file. |
| lReturnReceipt | If set a return receipt is sent to the sender(s) of the message. |
| lsecurelink | Determines whether an HTTP request runs securely over HTTPS/SSL when using the various HTTP functions except HTTPGet(). |
| lusezip | Flag to determine whether Encode and DecodeDBF use zipping (not implemented) |
| nconnecttimeout | Timeout on an HTTP Connection prior to receiving/sending data (5) . |
| nerror | The last error code. |
| nrashandle | Internal handle to the RAS Session created with RASDial(). Exposed to allow further access to the handle via API calls. |
| nServiceFlags | Use this property to override internet service connection flags used by WinINet. Used in the call to InternetConnect(). |
| nSMTPPort | Port for SMTP client to connect to. |