IP*Works!

ipworks
Class Htmlmailer

java.lang.Object
  |
  +--ipworks.Htmlmailer

public class Htmlmailer
extends java.lang.Object

The HTMLMailer control is used to send HTML email.

The control 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 control 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). Setting the Action property to htmlmailerSend is identical to calling the Send method.

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


Field Summary
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
static int htmlmailerIdle
           
static int htmlmailerSend
           
 
Constructor Summary
Htmlmailer()
           
 
Method Summary
 void addHtmlmailerEventListener(HtmlmailerEventListener l)
           
 void fireEndTransfer()
          Fired when the message text completes transferring.
 void fireError(int errorCode, java.lang.String description)
          Information about errors during data delivery.
 void firePITrail(int direction, java.lang.String message)
          Traces the commands sent to the mail server, and the respective replies.
 void fireStartTransfer()
          Fired when the message text starts transferring.
 void fireTransfer(int bytesTransferred)
          Fired while the message text gets transferred to MailServer .
 int getAction()
          An action code for the control.
 java.lang.String getBCc()
          A comma separated list of addresses for blind carbon copies (optional).
 java.lang.String getCc()
          A comma separated list of addresses for carbon copies (optional).
 java.lang.String getDate()
          The Date of the mail message (optional).
 byte[] getFirewallData()
          Used to send other data to firewall.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used connecting through the firewall.
 int getFirewallPort()
          Port of the firewall to connect to.
 int getFirewallType()
          Determines the type of firewall to connect through.
 java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.
 java.lang.String getFrom()
          The email address of the sender (required).
 int getImageCount()
          The number of embedded images in the HTML message.
 java.lang.String getImageIds(int imageIndex)
          Content IDs for embedded images.
 java.lang.String getImages(int imageIndex)
          The embedded images in the HTML message.
 java.lang.String getLastReply()
          The last reply from the server.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 int getMailPort()
          The server port for SMTP (default 25).
 java.lang.String getMailServer()
          The name or address of a mail server (mail relay).
 int getMaxHeaderLength()
          Maximum length for headers to avoid line folding (default 80).
 java.lang.String getMessageDate()
          The Date of the mail message (optional).
 java.lang.String getMessageHTML()
          The HTML version of the message.
 java.lang.String getMessageText()
          The plain text version of the message.
 java.lang.String getOtherHeaders()
          An RFC 822 compliant string consisting of extra headers.
 java.lang.String getReplyTo()
          A mail address to reply to (optional).
 java.lang.String getSendTo()
          A comma separated list of addresses for destinations (required).
 java.lang.String getSubject()
          The subject of the mail message (optional).
 int getTimeout()
          A timeout for the component.
 void interrupt()
          Interrupt the Action in progress (if any).
 boolean isParseHTML()
          Controls the behavior of the MessageHTML property.
 void removeHtmlmailerEventListener(HtmlmailerEventListener l)
           
 void send()
          Send the current message and MIME encoded attachment.
 void setAction(int action)
          An action code for the control.
 void setBCc(java.lang.String BCc)
          A comma separated list of addresses for blind carbon copies (optional).
 void setCc(java.lang.String cc)
          A comma separated list of addresses for carbon copies (optional).
 void setDate(java.lang.String date)
          The Date of the mail message (optional).
 void setFirewallData(byte[] firewallData)
          Used to send other data to firewall.
 void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).
 void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used connecting through the firewall.
 void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.
 void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.
 void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.
 void setFrom(java.lang.String from)
          The email address of the sender (required).
 void setImageCount(int imageCount)
          The number of embedded images in the HTML message.
 void setImageIds(int imageIndex, java.lang.String imageIds)
          Content IDs for embedded images.
 void setImages(int imageIndex, java.lang.String images)
          The embedded images in the HTML message.
 void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 void setMailPort(int mailPort)
          The server port for SMTP (default 25).
 void setMailServer(java.lang.String mailServer)
          The name or address of a mail server (mail relay).
 void setMaxHeaderLength(int maxHeaderLength)
          Maximum length for headers to avoid line folding (default 80).
 void setMessageDate(java.lang.String messageDate)
          The Date of the mail message (optional).
 void setMessageHTML(java.lang.String messageHTML)
          The HTML version of the message.
 void setMessageText(java.lang.String messageText)
          The plain text version of the message.
 void setOtherHeaders(java.lang.String otherHeaders)
          An RFC 822 compliant string consisting of extra headers.
 void setParseHTML(boolean parseHTML)
          Controls the behavior of the MessageHTML property.
 void setReplyTo(java.lang.String replyTo)
          A mail address to reply to (optional).
 void setSendTo(java.lang.String sendTo)
          A comma separated list of addresses for destinations (required).
 void setSubject(java.lang.String subject)
          The subject of the mail message (optional).
 void setTimeout(int timeout)
          A timeout for the component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

htmlmailerIdle

public static final int htmlmailerIdle

htmlmailerSend

public static final int htmlmailerSend

fwNone

public static final int fwNone

fwTunnel

public static final int fwTunnel

fwSOCKS4

public static final int fwSOCKS4

fwSOCKS5

public static final int fwSOCKS5
Constructor Detail

Htmlmailer

public Htmlmailer()
Method Detail

getAction

public int getAction()
An action code for the control. The following are the possible values for the Action property and the corresponding descriptions:
htmlmailerIdle (0)
Default action. It can also be used to interrupt the current operation.
htmlmailerSend (1)
Connects to the specified MailServer , sends the message in MIME format, then disconnects from the server.

After a message has been sent successfully, the control then returns to "Idle".


setAction

public void setAction(int action)
               throws IPWorksException
An action code for the control. The following are the possible values for the Action property and the corresponding descriptions:
htmlmailerIdle (0)
Default action. It can also be used to interrupt the current operation.
htmlmailerSend (1)
Connects to the specified MailServer , sends the message in MIME format, then disconnects from the server.

After a message has been sent successfully, the control then returns to "Idle".


getBCc

public java.lang.String getBCc()
A comma separated list of addresses for blind carbon copies (optional). The BCc property specifies a comma separated list of destinations where to send blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.

The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will only fire an Error event if the same happens with an email address specified in BCc .

If the resulting BCc header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setBCc

public void setBCc(java.lang.String BCc)
            throws IPWorksException
A comma separated list of addresses for blind carbon copies (optional). The BCc property specifies a comma separated list of destinations where to send blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.

The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will only fire an Error event if the same happens with an email address specified in BCc .

If the resulting BCc header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getCc

public java.lang.String getCc()
A comma separated list of addresses for carbon copies (optional). The Cc property specifies a comma separated list of destinations where to send carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc ).

The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will only fire an Error event if the same happens with an email address specified in BCc .

If the resulting Cc header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setCc

public void setCc(java.lang.String cc)
           throws IPWorksException
A comma separated list of addresses for carbon copies (optional). The Cc property specifies a comma separated list of destinations where to send carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc ).

The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will only fire an Error event if the same happens with an email address specified in BCc .

If the resulting Cc header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getDate

public java.lang.String getDate()
The Date of the mail message (optional). If the Date property contains a non-empty string, then a Date SMTP header is created and attached to the message. If not, then the date information is added by the mail relay(s) the message goes through.

If the resulting Date header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".


setDate

public void setDate(java.lang.String date)
             throws IPWorksException
The Date of the mail message (optional). If the Date property contains a non-empty string, then a Date SMTP header is created and attached to the message. If not, then the date information is added by the mail relay(s) the message goes through.

If the resulting Date header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".


getFirewallData

public byte[] getFirewallData()
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


setFirewallData

public void setFirewallData(byte[] firewallData)
                     throws IPWorksException
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


getFirewallHost

public java.lang.String getFirewallHost()
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


getFirewallPassword

public java.lang.String getFirewallPassword()
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getFirewallPort

public int getFirewallPort()
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


getFirewallType

public int getFirewallType()
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


getFirewallUser

public java.lang.String getFirewallUser()
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getFrom

public java.lang.String getFrom()
The email address of the sender (required). The From property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Your Name" or address@company.com

If the resulting From header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setFrom

public void setFrom(java.lang.String from)
             throws IPWorksException
The email address of the sender (required). The From property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Your Name" or address@company.com

If the resulting From header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getImageCount

public int getImageCount()
The number of embedded images in the HTML message. ImageCount is updated every time MessageHTML is set.


setImageCount

public void setImageCount(int imageCount)
                   throws IPWorksException
The number of embedded images in the HTML message. ImageCount is updated every time MessageHTML is set.


getImageIds

public java.lang.String getImageIds(int imageIndex)
                             throws IPWorksException
Content IDs for embedded images. These values are computed automatically, unless ParseHTML is False, in which case you are responsible for providing them.


setImageIds

public void setImageIds(int imageIndex,
                        java.lang.String imageIds)
                 throws IPWorksException
Content IDs for embedded images. These values are computed automatically, unless ParseHTML is False, in which case you are responsible for providing them.


getImages

public java.lang.String getImages(int imageIndex)
                           throws IPWorksException
The embedded images in the HTML message. The Images array contains the names of the image files embedded into the HTML message.

The array is updated every time MessageHTML is set. You may change the file names prior to sending (e.g. if they don't point to valid files).


setImages

public void setImages(int imageIndex,
                      java.lang.String images)
               throws IPWorksException
The embedded images in the HTML message. The Images array contains the names of the image files embedded into the HTML message.

The array is updated every time MessageHTML is set. You may change the file names prior to sending (e.g. if they don't point to valid files).


getLastReply

public java.lang.String getLastReply()
The last reply from the server. This is the last reply received from the server. It can be used for information purposes. The same information and more can also be retrieved through the PITrail event.


getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.


getMailPort

public int getMailPort()
The server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed while a connection is in progress. Any attempt to change the MailPort while connected will fail with an error.


setMailPort

public void setMailPort(int mailPort)
                 throws IPWorksException
The server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed while a connection is in progress. Any attempt to change the MailPort while connected will fail with an error.


getMailServer

public java.lang.String getMailServer()
The name or address of a mail server (mail relay). The MailServer property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the control does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (a UNIX host for example), but it is preferable to select a MailServer that is close to the machine sending mail.

If the MailServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.


setMailServer

public void setMailServer(java.lang.String mailServer)
                   throws IPWorksException
The name or address of a mail server (mail relay). The MailServer property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the control does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (a UNIX host for example), but it is preferable to select a MailServer that is close to the machine sending mail.

If the MailServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.


getMaxHeaderLength

public int getMaxHeaderLength()
Maximum length for headers to avoid line folding (default 80). The MaxHeaderLength specifies the maximum line length supported by the mail delivery system. Any headers longer than MaxHeaderLength are folded as specified in RFC 822.

It is generally a good idea to use a MaxHeaderLength of less than 100 bytes, although different mail relays and mail servers have different requirements for header lengths.


setMaxHeaderLength

public void setMaxHeaderLength(int maxHeaderLength)
                        throws IPWorksException
Maximum length for headers to avoid line folding (default 80). The MaxHeaderLength specifies the maximum line length supported by the mail delivery system. Any headers longer than MaxHeaderLength are folded as specified in RFC 822.

It is generally a good idea to use a MaxHeaderLength of less than 100 bytes, although different mail relays and mail servers have different requirements for header lengths.


getMessageDate

public java.lang.String getMessageDate()
The Date of the mail message (optional). If the MessageDate property contains a non-empty string, then a Date SMTP header is created and attached to the message. If not, then the date information is added by the mail relay(s) the message goes through.

If the resulting Date header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".


setMessageDate

public void setMessageDate(java.lang.String messageDate)
                    throws IPWorksException
The Date of the mail message (optional). If the MessageDate property contains a non-empty string, then a Date SMTP header is created and attached to the message. If not, then the date information is added by the mail relay(s) the message goes through.

If the resulting Date header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".


getMessageHTML

public java.lang.String getMessageHTML()
The HTML version of 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 control 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.


setMessageHTML

public void setMessageHTML(java.lang.String messageHTML)
                    throws IPWorksException
The HTML version of 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 control 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.


getMessageText

public java.lang.String getMessageText()
The plain text version of the message. MessageText is a plain text version of the HTML message. This is neccessary for recipients with legacy mail readers that do not support HTML.

The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the control 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.


setMessageText

public void setMessageText(java.lang.String messageText)
                    throws IPWorksException
The plain text version of the message. MessageText is a plain text version of the HTML message. This is neccessary for recipients with legacy mail readers that do not support HTML.

The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the control 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.


getOtherHeaders

public java.lang.String getOtherHeaders()
An RFC 822 compliant string consisting of extra headers. The OtherHeaders property contains a string of headers to be appended to the message headers created from other properties like SendTo , Subject , etc.

The headers must of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\\r\\n").

Use this property with caution. If OtherHeaders contains invalid headers, message delivery might not be successful.

The OtherHeaders property is useful for extending the functionality of the control. A good example is delivery of MIME encoded messages.

SPECIAL CASE: if OtherHeaders starts with an empty line (CRLF), then the value of OtherHeaders is used instead of the normally computed message headers.


setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksException
An RFC 822 compliant string consisting of extra headers. The OtherHeaders property contains a string of headers to be appended to the message headers created from other properties like SendTo , Subject , etc.

The headers must of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\\r\\n").

Use this property with caution. If OtherHeaders contains invalid headers, message delivery might not be successful.

The OtherHeaders property is useful for extending the functionality of the control. A good example is delivery of MIME encoded messages.

SPECIAL CASE: if OtherHeaders starts with an empty line (CRLF), then the value of OtherHeaders is used instead of the normally computed message headers.


isParseHTML

public boolean isParseHTML()
Controls the behavior of the MessageHTML property. If ParseHTML is set to False, you must provide valid values in MessageHTML , MessageText , Images , and ImageIds .


setParseHTML

public void setParseHTML(boolean parseHTML)
                  throws IPWorksException
Controls the behavior of the MessageHTML property. If ParseHTML is set to False, you must provide valid values in MessageHTML , MessageText , Images , and ImageIds .


getReplyTo

public java.lang.String getReplyTo()
A mail address to reply to (optional). If the ReplyTo property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (useful if this address is different from the one in From ).

If the resulting Reply-To header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setReplyTo

public void setReplyTo(java.lang.String replyTo)
                throws IPWorksException
A mail address to reply to (optional). If the ReplyTo property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (useful if this address is different from the one in From ).

If the resulting Reply-To header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getSendTo

public java.lang.String getSendTo()
A comma separated list of addresses for destinations (required). The SendTo property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

The control will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same happens with an email address specified in BCc .

If the resulting To header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setSendTo

public void setSendTo(java.lang.String sendTo)
               throws IPWorksException
A comma separated list of addresses for destinations (required). The SendTo property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

The control will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same happens with an email address specified in BCc .

If the resulting To header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getSubject

public java.lang.String getSubject()
The subject of the mail message (optional). The string in Subject is sent with a Subject SMTP header to the mail recipient.

If the resulting Subject header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


setSubject

public void setSubject(java.lang.String subject)
                throws IPWorksException
The subject of the mail message (optional). The string in Subject is sent with a Subject SMTP header to the mail recipient.

If the resulting Subject header is longer than MaxHeaderLength , then it is folded according to RFC 822 specifications.


getTimeout

public int getTimeout()
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and always remains responsive.


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and always remains responsive.


fireEndTransfer

public void fireEndTransfer()
Fired when the message text completes transferring. (Called internally to dispatch the event.)
See Also:
HtmlmailerEndTransferEvent

fireError

public void fireError(int errorCode,
                      java.lang.String description)
Information about errors during data delivery. (Called internally to dispatch the event.)
See Also:
HtmlmailerErrorEvent

firePITrail

public void firePITrail(int direction,
                        java.lang.String message)
Traces the commands sent to the mail server, and the respective replies. (Called internally to dispatch the event.)
See Also:
HtmlmailerPITrailEvent

fireStartTransfer

public void fireStartTransfer()
Fired when the message text starts transferring. (Called internally to dispatch the event.)
See Also:
HtmlmailerStartTransferEvent

fireTransfer

public void fireTransfer(int bytesTransferred)
Fired while the message text gets transferred to MailServer . (Called internally to dispatch the event.)
See Also:
HtmlmailerTransferEvent

interrupt

public void interrupt()
               throws IPWorksException
Interrupt the Action in progress (if any). Calling this method is equivalent to setting the Action property to Idle (0) .


send

public void send()
          throws IPWorksException
Send the current message and MIME encoded attachment. Connects to the specified MailServer , sends the message in MIME format, then disconnects from the server.

Calling this method is equivalent to setting the Action property to htmlmailerSend .


addHtmlmailerEventListener

public void addHtmlmailerEventListener(HtmlmailerEventListener l)
                                throws java.util.TooManyListenersException

removeHtmlmailerEventListener

public void removeHtmlmailerEventListener(HtmlmailerEventListener l)

IP*Works!

Copyright (c) 2001 /n software inc. - All rights reserved.