IP*Works! htmlmailer Component : htmlmailer OCX, htmlmailer .NET Component, htmlmailer Class, htmlmailer Bean, htmlmailer Object

Available in: IP*WORKS!

Htmlmailer Class

HTMLMailer Component [IP*Works! V8]

Properties Methods Events Configuration Settings

The HTMLMailer component is used to send HTML email.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The component sends a message (provided in MessageHTML and MessageText). The HTML message may contain references to images which are automatically embedded into the message.

The MessageHTML property contains the HTML version of the message. The corresponding plain text version is provided into the MessageText property.

When MessageHTML is set, the component automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.

The recipients are specified by the SendTo, Cc, and BCc properties, and the message subject by the Subject property.

Once all the appropriate properties have been set call the Send method and your message will be sent to its intended recipient(s).

Other SMTP headers may be specified through the OtherHeaders property. Information about interaction with the server is provided via the PITrail event.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Attachments	The paths of files to attach to the message.
AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
BCc	A comma separated list of addresses for blind carbon copies (optional).
Cc	A comma separated list of addresses for carbon copies (optional).
Command	Can be used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
DeliveryNotificationTo	Email address to send a delivery notification to.
Firewall	A set of properties related to firewall access.
From	The email address of the sender (required).
HTMLFile	The path to a local HTML file.
Idle	The current status of the component.
Images	The embedded images in the HTML message.
Importance	Importance of the mail message (optional).
LastReply	The last reply from the server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPort	The server port for SMTP (default 25).
MailServer	The name or address of a mail server (mail relay).
MessageDate	The Date of the mail message (optional).
MessageHTML	The HTML version of the message.
MessageId	The MessageId for the message.
MessageRecipients	The collection of recipients of the message.
MessageText	The plain text version of the message.
OtherHeaders	An RFC 822 compliant string consisting of extra headers.
ParseHTML	Controls the behavior of the MessageHTML property.
Password	A login password to login with in the MailServer.
Priority	Priority of the mail message (optional).
ReadReceiptTo	Email address to send a read receipt to.
ReplyTo	A mail address to reply to (optional).
SendTo	A comma separated list of addresses for destinations (required).
Sensitivity	Sensitivity of the mail message (optional).
Subject	The subject of the mail message (optional).
Timeout	A timeout for the component.
User	A user id to login as in the MailServer.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AddAttachment	Adds FileName as an attachment.
Config	Sets or retrieves a component configuration setting.
Connect	Connects to the mail relay and sends the SMTP HELO command.
Disconnect	Disconnect from the SMTP server.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ProcessQueue	Sends the messages which have previously been queued into QueueDir.
Queue	Queues the message into QueueDir.
ResetHeaders	Resets all the message headers to empty.
Send	Send the current message and MIME encoded attachment.
SetMessageHTMLStream	Sets the stream from which the component will read the HTML version of the message.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


ConnectionStatus	Fired to indicate changes in connection state.
EndTransfer	Fired when the message text completes transferring.
Error	Information about errors during data delivery.
PITrail	Traces the commands sent to the mail server, and the respective replies.
StartTransfer	Fired when the message text starts transferring.
Transfer	Fired while the message text gets transferred to .

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
Hello	The argument for HELO (herald) command to the server (defaults to local host name)
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepQueue	If set to True, queued files are not deleted after a successful send.
MaxHeaderLength	Maximum length for headers to avoid line folding (default 80)
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
OtherHeaders	An RFC 822 compliant string consisting of extra headers.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ReturnPath	Sets the Return-Path to be used for sending email..
SocketHandle	The handle of the main socket used by the component.
StopOnBccErrors	Instructs the component to stop sending the message if the server does not acknowledge any of the BCCs
TcpNoDelay	Whether or not to delay when sending packets
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)