ipworksssl
Class Smtps

java.lang.Object
  ipworksssl.Smtps

public class Smtps
extends java.lang.Object

The SMTPS Bean is used to send Internet mail using the SMTP protocol (the Internet mail standard).

The SMTPS Bean is the SSL-enabled equivalent (RFC 2487) of the IP*Works! SMTP bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The ipworksssl.Smtps#config and {@link ipworksssl.Smtps#config configuration settings determine which protocols are enabled and at what security level. The {@link ipworksssl.Smtps#getSSLCert SSLCert} property is used to select a client certificate if the server is requesting client authentication. The {@link ipworksssl.Smtps#config configuration setting, together with the {@link ipworksssl.SmtpsSSLServerAuthenticationEvent SSLServerAuthentication} event allow you to check the server identity and other security attributes. Finally, the {@link ipworksssl.SmtpsSSLStatusEvent SSLStatus} event provides information about the SSL handshake.

The SMTPS Bean implements a standard SMTP client as specified in RFC 821. It has a simple plug-and-play interface. It contains a number of properties like {@link ipworksssl.Smtps#getSendTo SendTo} , {@link ipworksssl.Smtps#getSubject Subject} , {@link ipworksssl.Smtps#getFrom From} , {@link ipworksssl.Smtps#getCc Cc} , {@link ipworksssl.Smtps#getBCc BCc} , etc. that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in {@link ipworksssl.Smtps#getMessageText MessageText} . Messages are sent by calling the {@link ipworksssl.Smtps#send Send} method.

The bean supports message delivery to multiple recipients through the {@link ipworksssl.Smtps#getSendTo SendTo} , {@link ipworksssl.Smtps#getCc Cc} , and {@link ipworksssl.Smtps#getBCc BCc} properties. Simply specify the destination email addresses separated by commas.

The interface of the bean is open-ended. New features, including MIME attachments can be supported by using the {@link ipworksssl.Smtps#getOtherHeaders OtherHeaders} property.

A number of events provide feedback during the operation of the bean. The {@link ipworksssl.SmtpsTransferEvent Transfer} event is fired during message delivery to show the number of bytes delivered. The {@link ipworksssl.SmtpsPITrailEvent PITrail} event traces the commands that are sent to the server and the respective replies.

Field Summary

static int	amCRAMMD5
static int	amKerberos
static int	amNTLM
static int	amSASLPlain
static int	amUserPassword
static int	amXOAUTH2
static int	epNonUrgent
static int	epNormal
static int	epUnspecified
static int	epUrgent
static int	esCompanyConfidential
static int	esPersonal
static int	esPrivate
static int	esUnspecified
static int	miHigh
static int	miLow
static int	miNormal
static int	miUnspecified
static int	sslAutomatic
static int	sslExplicit
static int	sslImplicit
static int	sslNone

Constructor Summary

Smtps()
Creates an instance of Smtps Bean.

Smtps(java.lang.String runtimeLicense)
Creates an instance of Smtps Bean with specified run-time license.

Method Summary

void	addSmtpsEventListener(SmtpsEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a {@link ipworksssl.Smtps#config configuration setting.
void	connect() Connects to the mail relay and sends the SMTP HELO command.
void	disconnect() Disconnects from the SMTP server.
void	doEvents() Processes events from the internal message queue.
void	expand(java.lang.String emailAddress) Asks the MailServer to expand a name or mailing list.
int	getAuthMechanism() Used when connecting to the mail server.
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	getDeliveryNotificationTo() Email address to send to which to send a delivery notification.
Firewall	getFirewall() A set of properties related to firewall access.
java.lang.String	getFrom() The email address of the sender (required).
int	getImportance() Importance of the mail message (optional).
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).
byte[]	getMessage() Provides a way to set the raw message content.
java.lang.String	getMessageDate() Date of the mail message (optional).
HeaderList	getMessageHeaders() Collection of RFC822-encoded headers of the message.
java.lang.String	getMessageHeadersString() String representation of RFC822-encoded headers of the message.
java.lang.String	getMessageId() The Message Identifier for the message.
MessageRecipientList	getMessageRecipients() The collection of recipients of the message.
java.lang.String	getMessageText() The full text of the message to send (without headers).
java.lang.String	getOtherHeaders() An RFC 822 compliant string consisting of extra headers.
java.lang.String	getPassword() A password for logon to the MailServer .
int	getPriority() Priority of the mail message (optional).
java.lang.String	getReadReceiptTo() Email address to send a read receipt to.
java.lang.String	getReplyTo() A mail address to which to reply (optional).
java.lang.String	getReturnPath() Sets the Return-Path to be used for sending email.
java.lang.String	getSendTo() A comma separated list of addresses for destinations (required).
int	getSensitivity() Sensitivity of the mail message (optional).
Certificate	getSSLAcceptServerCert() Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
Certificate	getSSLCert() The certificate to be used during SSL negotiation.
Certificate	getSSLServerCert() The server certificate for the last established connection.
int	getSSLStartMode() Determines how the bean starts the SSL negotiation.
java.lang.String	getSubject() The subject of the mail message (optional).
int	getTimeout() A timeout for the bean.
java.lang.String	getUser() A user identifier to login as in the MailServer .
void	interrupt() Interrupt the current method.
boolean	isAllowExtensions() A switch allowing the bean to use ESMTP features (SMTP extensions).
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
void	processQueue(java.lang.String queueDir) Sends the messages which have previously been queued into QueueDir .
java.lang.String	queue(java.lang.String queueDir) Queues the message into QueueDir .
void	removeSmtpsEventListener(SmtpsEventListener l)
void	resetHeaders() Resets all the message headers to empty.
void	send() Sends the current message.
void	sendToTerminalAndEmail() Sends to terminal and email.
void	sendToTerminalOnly() Sends to terminal only.
void	sendToTerminalOrEmail() Sends to terminal or email.
void	setAllowExtensions(boolean allowExtensions) A switch allowing the bean to use ESMTP features (SMTP extensions).
void	setAuthMechanism(int authMechanism) Used when connecting to the mail server.
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	setCommand(java.lang.String command) Used to send additional commands directly to the server.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setDeliveryNotificationTo(java.lang.String deliveryNotificationTo) Email address to send to which to send a delivery notification.
void	setFirewall(Firewall firewall) A set of properties related to firewall access.
void	setFrom(java.lang.String from) The email address of the sender (required).
void	setImportance(int importance) Importance of the mail message (optional).
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	setMessage(byte[] message) Provides a way to set the raw message content.
void	setMessageDate(java.lang.String messageDate) Date of the mail message (optional).
void	setMessageId(java.lang.String messageId) The Message Identifier for the message.
void	setMessageStream(java.io.InputStream messageStream) Sets the stream to be uploaded to the server as part of the message.
void	setMessageText(java.lang.String messageText) The full text of the message to send (without headers).
void	setOtherHeaders(java.lang.String otherHeaders) An RFC 822 compliant string consisting of extra headers.
void	setPassword(java.lang.String password) A password for logon to the MailServer .
void	setPriority(int priority) Priority of the mail message (optional).
void	setReadReceiptTo(java.lang.String readReceiptTo) Email address to send a read receipt to.
void	setReplyTo(java.lang.String replyTo) A mail address to which to reply (optional).
void	setReturnPath(java.lang.String returnPath) Sets the Return-Path to be used for sending email.
void	setSendTo(java.lang.String sendTo) A comma separated list of addresses for destinations (required).
void	setSensitivity(int sensitivity) Sensitivity of the mail message (optional).
void	setSSLAcceptServerCert(Certificate SSLAcceptServerCert) Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
void	setSSLCert(Certificate SSLCert) The certificate to be used during SSL negotiation.
void	setSSLStartMode(int SSLStartMode) Determines how the bean starts the SSL negotiation.
void	setSubject(java.lang.String subject) The subject of the mail message (optional).
void	setTimeout(int timeout) A timeout for the bean.
void	setUser(java.lang.String user) A user identifier to login as in the MailServer .
void	verify(java.lang.String emailAddress) Sends a Verification request to the SMTP server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

amUserPassword

public static final int amUserPassword

See Also:

Constant Field Values

amCRAMMD5

public static final int amCRAMMD5

See Also:

Constant Field Values

amNTLM

public static final int amNTLM

See Also:

Constant Field Values

amSASLPlain

public static final int amSASLPlain

See Also:

Constant Field Values

amKerberos

public static final int amKerberos

See Also:

Constant Field Values

amXOAUTH2

public static final int amXOAUTH2

See Also:

Constant Field Values

miUnspecified

public static final int miUnspecified

See Also:

Constant Field Values

miHigh

public static final int miHigh

See Also:

Constant Field Values

miNormal

public static final int miNormal

See Also:

Constant Field Values

miLow

public static final int miLow

See Also:

Constant Field Values

epUnspecified

public static final int epUnspecified

See Also:

Constant Field Values

epNormal

public static final int epNormal

See Also:

Constant Field Values

epUrgent

public static final int epUrgent

See Also:

Constant Field Values

epNonUrgent

public static final int epNonUrgent

See Also:

Constant Field Values

esUnspecified

public static final int esUnspecified

See Also:

Constant Field Values

esPersonal

public static final int esPersonal

See Also:

Constant Field Values

esPrivate

public static final int esPrivate

See Also:

Constant Field Values

esCompanyConfidential

public static final int esCompanyConfidential

See Also:

Constant Field Values

sslAutomatic

public static final int sslAutomatic

See Also:

Constant Field Values

sslImplicit

public static final int sslImplicit

See Also:

Constant Field Values

sslExplicit

public static final int sslExplicit

See Also:

Constant Field Values

sslNone

public static final int sslNone

See Also:

Constant Field Values

Constructor Detail

Smtps

public Smtps()

Creates an instance of Smtps Bean.

Smtps

public Smtps(java.lang.String runtimeLicense)

Creates an instance of Smtps Bean with specified run-time license.

Method Detail

isAllowExtensions

public boolean isAllowExtensions()

A switch allowing the bean to use ESMTP features (SMTP extensions).

This property is a switch allowing the bean to use ESMTP features (SMTP extensions). If this property is true, the bean will first send the EHLO greeting to the server and, if that fails, the standard HELO command will be sent.

This property is true by default but may be disabled if it's known in advance that the MailServer doesn't support SMTP extensions.

setAllowExtensions

public void setAllowExtensions(boolean allowExtensions)
                        throws IPWorksSSLException

A switch allowing the bean to use ESMTP features (SMTP extensions).

This property is a switch allowing the bean to use ESMTP features (SMTP extensions). If this property is true, the bean will first send the EHLO greeting to the server and, if that fails, the standard HELO command will be sent.

This property is true by default but may be disabled if it's known in advance that the MailServer doesn't support SMTP extensions.

Throws:

IPWorksSSLException

getAuthMechanism

public int getAuthMechanism()

Used when connecting to the mail server.

The authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2) NTLM authentication will be used.

If this property is set to amKerberos (6) Kerberos authentication will be used. NOTE: This functionality is only available in Windows.

setAuthMechanism

public void setAuthMechanism(int authMechanism)
                      throws IPWorksSSLException

Used when connecting to the mail server.

The authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2) NTLM authentication will be used.

If this property is set to amKerberos (6) Kerberos authentication will be used. NOTE: This functionality is only available in Windows.

Throws:

IPWorksSSLException

getBCc

public java.lang.String getBCc()

A comma separated list of addresses for blind carbon copies (optional).

This property specifies a comma separated list of destinations for 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 bean 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 this property.

If the resulting header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

setBCc

public void setBCc(java.lang.String BCc)
            throws IPWorksSSLException

A comma separated list of addresses for blind carbon copies (optional).

This property specifies a comma separated list of destinations for 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 bean 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 this property.

If the resulting header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

Throws:

IPWorksSSLException

getCc

public java.lang.String getCc()

A comma separated list of addresses for carbon copies (optional).

This property specifies a comma separated list of destinations for 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 bean 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 header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

setCc

public void setCc(java.lang.String cc)
           throws IPWorksSSLException

A comma separated list of addresses for carbon copies (optional).

This property specifies a comma separated list of destinations for 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 bean 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 header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

Throws:

IPWorksSSLException

setCommand

public void setCommand(java.lang.String command)
                throws IPWorksSSLException

Used to send additional commands directly to the server.

This property can be used to send additional commands directly to the server. Check the LastReply property and/or trap the PITrail events coming from the server to get the response.

Throws:

IPWorksSSLException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksSSLException

Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

Throws:

IPWorksSSLException

getDeliveryNotificationTo

public java.lang.String getDeliveryNotificationTo()

Email address to send to which to send a delivery notification.

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address which should receive the delivery notification.

setDeliveryNotificationTo

public void setDeliveryNotificationTo(java.lang.String deliveryNotificationTo)
                               throws IPWorksSSLException

Email address to send to which to send a delivery notification.

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address which should receive the delivery notification.

Throws:

IPWorksSSLException

getFirewall

public Firewall getFirewall()

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksSSLException

A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:

IPWorksSSLException

getFrom

public java.lang.String getFrom()

The email address of the sender (required).

This 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: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

setFrom

public void setFrom(java.lang.String from)
             throws IPWorksSSLException

The email address of the sender (required).

This 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: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

Throws:

IPWorksSSLException

isIdle

public boolean isIdle()

The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

getImportance

public int getImportance()

Importance of the mail message (optional).

This property indicates the importance of the mail message (optional). When set, an Importance header will added to the message.

Importance is an indication to the recipient(s) about how important the message is. The possible values are High (1), Normal (2), and Low (3).

setImportance

public void setImportance(int importance)
                   throws IPWorksSSLException

Importance of the mail message (optional).

This property indicates the importance of the mail message (optional). When set, an Importance header will added to the message.

Importance is an indication to the recipient(s) about how important the message is. The possible values are High (1), Normal (2), and Low (3).

Throws:

IPWorksSSLException

getLastReply

public java.lang.String getLastReply()

The last reply from the server.

This property indicates the last reply received from the server. It can be used for informational 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() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean 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 multi-homed 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 IPWorksSSLException

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() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean 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 multi-homed 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.

Throws:

IPWorksSSLException

getMailPort

public int getMailPort()

The server port for SMTP (default 25).

This property contains 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 once a connection is established. Any attempt to change this property while connected will fail with an error.

For implicit SSL, use port 465 (please refer to the SSLStartMode property for more information).

setMailPort

public void setMailPort(int mailPort)
                 throws IPWorksSSLException

The server port for SMTP (default 25).

This property contains 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 once a connection is established. Any attempt to change this property while connected will fail with an error.

For implicit SSL, use port 465 (please refer to the SSLStartMode property for more information).

Throws:

IPWorksSSLException

getMailServer

public java.lang.String getMailServer()

The name or address of a mail server (mail relay).

This 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 bean 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 this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

setMailServer

public void setMailServer(java.lang.String mailServer)
                   throws IPWorksSSLException

The name or address of a mail server (mail relay).

This 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 bean 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 this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Throws:

IPWorksSSLException

getMessage

public byte[] getMessage()

Provides a way to set the raw message content.

This property may be set instead of MessageText . The value set here will not be modified in any way by the bean and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

setMessage

public void setMessage(byte[] message)
                throws IPWorksSSLException

Provides a way to set the raw message content.

This property may be set instead of MessageText . The value set here will not be modified in any way by the bean and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

Throws:

IPWorksSSLException

getMessageDate

public java.lang.String getMessageDate()

Date of the mail message (optional).

If this property contains a non-empty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: if this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the bean

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 IPWorksSSLException

Date of the mail message (optional).

If this property contains a non-empty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: if this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the bean

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

Throws:

IPWorksSSLException

getMessageHeaders

public HeaderList getMessageHeaders()

Collection of RFC822-encoded headers of the message.

This property holds the full headers of the message in RFC822 format.

getMessageHeadersString

public java.lang.String getMessageHeadersString()

String representation of RFC822-encoded headers of the message.

This property holds the full headers of the message in RFC822 format.

getMessageId

public java.lang.String getMessageId()

The Message Identifier for the message.

This property contains the Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

setMessageId

public void setMessageId(java.lang.String messageId)
                  throws IPWorksSSLException

The Message Identifier for the message.

This property contains the Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

Throws:

IPWorksSSLException

getMessageRecipients

public MessageRecipientList getMessageRecipients()

The collection of recipients of the message.

This property contains a collection which describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.

This collection is indexed from 0 to size - 1.

getMessageText

public java.lang.String getMessageText()

The full text of the message to send (without headers).

This property contains the full text of the message.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.

The bean automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

setMessageText

public void setMessageText(java.lang.String messageText)
                    throws IPWorksSSLException

The full text of the message to send (without headers).

This property contains the full text of the message.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\ n") . The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.

The bean automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

Throws:

IPWorksSSLException

getOtherHeaders

public java.lang.String getOtherHeaders()

An RFC 822 compliant string consisting of extra headers.

This 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 this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the bean. A good example is delivery of MIME encoded messages.

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

Example (Send an Email With Additional Header)

 control.MailServer = "MyServer"
 control.From = "me@server.com"
 control.SendTo = "recipient@server.com"
 control.Subject = "My Subject"
 control.MessageText = "This is the message body"
 control.OtherHeaders = "HeaderName: Headervalue"
 control.Send() 

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksSSLException

An RFC 822 compliant string consisting of extra headers.

This 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 this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the bean. A good example is delivery of MIME encoded messages.

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

Example (Send an Email With Additional Header)

 control.MailServer = "MyServer"
 control.From = "me@server.com"
 control.SendTo = "recipient@server.com"
 control.Subject = "My Subject"
 control.MessageText = "This is the message body"
 control.OtherHeaders = "HeaderName: Headervalue"
 control.Send() 

Throws:

IPWorksSSLException

getPassword

public java.lang.String getPassword()

A password for logon to the MailServer .

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism ) command is sent in order to provide authentication information for the user.

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksSSLException

A password for logon to the MailServer .

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism ) command is sent in order to provide authentication information for the user.

Throws:

IPWorksSSLException

getPriority

public int getPriority()

Priority of the mail message (optional).

When this property is set, a Priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

setPriority

public void setPriority(int priority)
                 throws IPWorksSSLException

Priority of the mail message (optional).

When this property is set, a Priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

Throws:

IPWorksSSLException

getReadReceiptTo

public java.lang.String getReadReceiptTo()

Email address to send a read receipt to.

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.

setReadReceiptTo

public void setReadReceiptTo(java.lang.String readReceiptTo)
                      throws IPWorksSSLException

Email address to send a read receipt to.

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.

Throws:

IPWorksSSLException

getReplyTo

public java.lang.String getReplyTo()

A mail address to which to reply (optional).

If this 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 header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

setReplyTo

public void setReplyTo(java.lang.String replyTo)
                throws IPWorksSSLException

A mail address to which to reply (optional).

If this 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 header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

Throws:

IPWorksSSLException

getReturnPath

public java.lang.String getReturnPath()

Sets the Return-Path to be used for sending email.

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.

setReturnPath

public void setReturnPath(java.lang.String returnPath)
                   throws IPWorksSSLException

Sets the Return-Path to be used for sending email.

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.

Throws:

IPWorksSSLException

getSendTo

public java.lang.String getSendTo()

A comma separated list of addresses for destinations (required).

This 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.

Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

The bean 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 header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

setSendTo

public void setSendTo(java.lang.String sendTo)
               throws IPWorksSSLException

A comma separated list of addresses for destinations (required).

This 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.

Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

The bean 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 header is longer than ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

NOTE: You must clear the {@link ipworksssl.Smtps#getMessageRecipients MessageRecipients} collection before setting this property to remove previous recipients.

Throws:

IPWorksSSLException

getSensitivity

public int getSensitivity()

Sensitivity of the mail message (optional).

This property is an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

setSensitivity

public void setSensitivity(int sensitivity)
                    throws IPWorksSSLException

Sensitivity of the mail message (optional).

This property is an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

Throws:

IPWorksSSLException

getSSLAcceptServerCert

public Certificate getSSLAcceptServerCert()

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert)
                            throws IPWorksSSLException

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Throws:

IPWorksSSLException

getSSLCert

public Certificate getSSLCert()

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

setSSLCert

public void setSSLCert(Certificate SSLCert)
                throws IPWorksSSLException

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Throws:

IPWorksSSLException

getSSLServerCert

public Certificate getSSLServerCert()

The server certificate for the last established connection.

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

getSSLStartMode

public int getSSLStartMode()

Determines how the bean starts the SSL negotiation.

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)

If the remote port is set to the standard plaintext port of the protocol (where applicable), the bean will behave the same as if SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit ( sslImplicit ).

1 (sslImplicit)

The SSL negotiation will start immediately after the connection is established.

2 (sslExplicit)

The bean will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.

3 (sslNone)

No SSL negotiation, no SSL security. All communication will be in plaintext mode.

setSSLStartMode

public void setSSLStartMode(int SSLStartMode)
                     throws IPWorksSSLException

Determines how the bean starts the SSL negotiation.

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)

If the remote port is set to the standard plaintext port of the protocol (where applicable), the bean will behave the same as if SSLStartMode is set to sslExplicit . In all other cases, SSL negotiation will be implicit ( sslImplicit ).

1 (sslImplicit)

The SSL negotiation will start immediately after the connection is established.

2 (sslExplicit)

The bean will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.

3 (sslNone)

No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Throws:

IPWorksSSLException

getSubject

public java.lang.String getSubject()

The subject of the mail message (optional).

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

setSubject

public void setSubject(java.lang.String subject)
                throws IPWorksSSLException

The subject of the mail message (optional).

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than {@link ipworksssl.Smtps#config , then it is folded according to RFC 822 specifications.

Throws:

IPWorksSSLException

getTimeout

public int getTimeout()

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean 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 remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Smtps#config configuration setting.

The default value for the {@link ipworksssl.Smtps#getTimeout Timeout} property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksSSLException

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean 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 remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the ipworksssl.Smtps#config configuration setting.

The default value for the {@link ipworksssl.Smtps#getTimeout Timeout} property is 60 (seconds).

Throws:

IPWorksSSLException

getUser

public java.lang.String getUser()

A user identifier to login as in the MailServer .

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism ) command is sent in order to provide authentication information for the user.

setUser

public void setUser(java.lang.String user)
             throws IPWorksSSLException

A user identifier to login as in the MailServer .

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism ) command is sent in order to provide authentication information for the user.

Throws:

IPWorksSSLException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksSSLException

Sets or retrieves a ipworksssl.Smtps#config configuration setting.

{@link ipworksssl.Smtps#config Config} is a generic method available in every bean. It is used to set and retrieve {@link ipworksssl.Smtps#config configuration settingsfor the bean.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Smtps#config Config} method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a {@link ipworksssl.Smtps#config configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the {@link ipworksssl.Smtps#config Config} method.

SMTP Configuration Settings

AllowEmptyTo

If set to True, then the SendTo property is not required

Normally, the {@link ipworksssl.Smtps#getSendTo SendTo} property is required to send a message. If AllowEmptyTo is True, then this is not the case, and messages can be sent with just one or both of {@link ipworksssl.Smtps#getCc Cc} and {@link ipworksssl.Smtps#getBCc BCc} set.

AuthorizationIdentity

The value to use as the authorization identity when SASL authentication is used

When {@link ipworksssl.Smtps#getAuthMechanism AuthMechanism} is set to amXOAUTH2 you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2 this should be your OAUTH authorization string. For instance:

 Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q 

Note: When using amXOAUTH2 {@link ipworksssl.Smtps#getUser User} must be specified, but {@link ipworksssl.Smtps#getPassword Password} is not required.

Charset

When set, the message headers will be encoded using the specified Charset

This property is used to specify the "charset" to be used to encode the message headers. For example, to use UTF-8 you can set this property to "UTF-8". The default value is "" (empty string) in which case the headers will not be encoded.

FoldHeaders

Tells the bean whether to fold the headers

If True, the bean will fold the headers if the headers are over a certain length. If False, the headers will be on one line regardless of length.Note that this is True by default.

Hello

The argument for HELO (herald) command to the server (defaults to local host name)

The Hello property specifies a string to send to the {@link ipworksssl.Smtps#getMailServer MailServer} at connection time as an argument to the SMTP HELO command. This generally identifies the host sending mail, and that's why the Hello property defaults to the name of the local host. The property is provided in case the bean does not accept the default value and a custom value (such as, for example, a fully qualified domain name) must be sent.If {@link ipworksssl.Smtps#isAllowExtensions AllowExtensions} is True the EHLO command will be sent instead of the HELO command.

KeepQueue

If set to True, queued files are not deleted after a successful send

Normally, {@link ipworksssl.Smtps#processQueue ProcessQueue} deletes queued files after processing them. If KeepQueue is True, the file extension is instead changed to ".sent" and the files are not deleted.

MaxHeaderLength

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.

MessageIdAlgorithm

Determines the algorithm used to hash the random MessageId

The MessageIdAlgorithm specifies which algorithm to use in the hash for the {@link ipworksssl.Smtps#getMessageId MessageId} when the property is set to "*". The default value is "MD5".Possible values are:

• "MD5" (default)
• "SHA1"

OtherHeaders

An RFC 822 compliant string consisting of extra headers

This is the same as the {@link ipworksssl.Smtps#getOtherHeaders OtherHeaders} property. This setting is exposed here for use by beans that inherit from SMTP.

ReturnPath

Sets the Return-Path to be used for sending email

This is the same as the {@link ipworksssl.Smtps#getReturnPath ReturnPath} property. This setting is exposed here for use by beans that inherit from SMTP.

SendRSET

Whether to send RSET command

By default, the bean will periodically send the RSET command to the server. Changing this configuration setting to False will prevent the RSET command from being sent. This can be useful when interacting with some servers that do not respond properly to the RSET command.

StopOnToErrors

Instructs the bean to stop sending the message if the server does not acknowledge any of the TOs

If this setting is set to True, the bean will fail the moment the server does not acknowledge a To address. If set to False, an error will be fired for every To that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

StopOnCcErrors

Instructs the bean to stop sending the message if the server does not acknowledge any of the CCs

If this setting is set to True, the bean will fail the moment the server does not acknowledge a Cc address. If set to False, an error will be fired for every Cc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

StopOnBccErrors

Instructs the bean to stop sending the message if the server does not acknowledge any of the BCCs

If this setting is set to True, the bean will fail the moment the server does not acknowledge a Bcc address. If set to False, an error will be fired for every Bcc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is False.

IPPort Configuration Settings

ConnectionTimeout

Sets a separate timeout value for establishing a connection

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the bean will use {@link ipworksssl.Smtps#getTimeout Timeout} for establishing a connection and transmitting/receiving data.

FirewallAutoDetect

Tells the bean whether or not to automatically detect and use firewall system settings, if available

This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallHost

Name or IP address of firewall (optional)

If a {@link ipworksssl.Smtps#config is given, requested connections will be authenticated through the specified firewall when connecting.If the {@link ipworksssl.Smtps#config setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the {@link ipworksssl.Smtps#config setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener

If true, the component binds to a SOCKS firewall as a server (IPPort only)

This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. {@link ipworksssl.Smtps#getRemoteHost RemoteHost} and {@link ipworksssl.Smtps#getRemotePort RemotePort} are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore {@link ipworksssl.Smtps#getRemoteHost RemoteHost} , and it is recommended that {@link ipworksssl.Smtps#getRemoteHost RemoteHost} be set to empty string in this case.

{@link ipworksssl.Smtps#getRemotePort RemotePort} is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the {@link ipworksssl.SmtpsConnectionStatusEvent ConnectionStatus} event.

The connection to the firewall is made by calling the {@link ipworksssl.Smtps#connect Connect} method.

FirewallPassword

Password to be used if authentication is to be used when connecting through the firewall

If {@link ipworksssl.Smtps#config is specified, the {@link ipworksssl.Smtps#config and {@link ipworksssl.Smtps#config settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort

The TCP port for the FirewallHost;

Note that the {@link ipworksssl.Smtps#config is set automatically when {@link ipworksssl.Smtps#config is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType

Determines the type of firewall to connect through

The appropriate values are as follows:

0

No firewall (default setting).

1

Connect through a tunneling proxy. {@link ipworksssl.Smtps#config is set to 80.

2

Connect through a SOCKS4 Proxy. {@link ipworksssl.Smtps#config is set to 1080.

3

Connect through a SOCKS5 Proxy. {@link ipworksssl.Smtps#config is set to 1080.

NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser

A user name if authentication is to be used connecting through a firewall

If the {@link ipworksssl.Smtps#config is specified, the {@link ipworksssl.Smtps#config and {@link ipworksssl.Smtps#config settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime

The inactivity time in milliseconds before a TCP keep-alive packet is sent

When set, {@link ipworksssl.Smtps#config will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval

The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received

When set, {@link ipworksssl.Smtps#config will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by {@link ipworksssl.Smtps#config . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger

When set to True, connections are terminated gracefully

This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if {@link ipworksssl.Smtps#config is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, {@link ipworksssl.Smtps#config is a positive value, the system will attempt to send pending data until the specified {@link ipworksssl.Smtps#config is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime

Time in seconds to have the connection linger

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost

The name of the local host through which connections are initiated or accepted

The {@link ipworksssl.Smtps#getLocalHost LocalHost} setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the {@link ipworksssl.Smtps#getLocalHost LocalHost} setting 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 multi-homed hosts (machines with more than one IP interface).

LocalPort

The TCP port in the local host where the bean binds

This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by {@link ipworksssl.Smtps#getLocalPort LocalPort} after the connection is established.

{@link ipworksssl.Smtps#getLocalPort LocalPort} cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength

The maximum amount of data to accumulate when no EOL is found

{@link ipworksssl.Smtps#config is the size of an internal buffer, which holds received data while waiting for an {@link ipworksssl.Smtps#getEOL EOL} string.If an {@link ipworksssl.Smtps#getEOL EOL} string is found in the input stream before {@link ipworksssl.Smtps#config bytes are received, the {@link ipworksssl.SmtpsDataInEvent DataIn} event is fired with the EOL parameter set to True, and the buffer is reset.

If no {@link ipworksssl.Smtps#getEOL EOL} is found, and {@link ipworksssl.Smtps#config bytes are accumulated in the buffer, the {@link ipworksssl.SmtpsDataInEvent DataIn} event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for {@link ipworksssl.Smtps#config is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate

The transfer rate limit in bytes per second

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

TCPKeepAlive

Determines whether or not the keep alive socket option is enabled

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set {@link ipworksssl.Smtps#config and {@link ipworksssl.Smtps#config to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6

Whether or not to use IPv6

By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.

CloseStreamAfterTransfer

If true, the component will close the upload or download stream after the transfer

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

TcpNoDelay

Whether or not to delay when sending packets

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

SSL Configuration Settings

ReuseSSLSession

Determines if the SSL session is reused

If set to true, the component will reuse the context if and only if the following criteria are met:

• The target host name is the same.
• The system cache entry has not expired (default timeout is 10 hours).
• The application process that calls the function is the same.
• The logon session is the same.
• The instance of the component is the same.

SSLCipherStrength

The minimum cipher strength used for bulk encryption

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the {@link ipworksssl.SmtpsSSLStatusEvent SSLStatus} event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Smtps#config config setting.

SSLEnabledProtocols

Used to enable/disable the supported security protocols

Used to enable/disable the supported security protocols.Not all supported protocols are enabled by default (the value of this setting is 192). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.2

3072 (Hex C00)

TLS1.1

768 (Hex 300)

TLS1

192 (Hex C0) (Default)

SSL3

48 (Hex 30)

SSL2

12 (Hex 0C)

Please note that although a number of sites still support SSL2, it is usually a good idea to disable it because of potential security vulnerabilities.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the {@link ipworksssl.Smtps#config config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

SSLProvider

The name of the security provider to use

Change this setting to use security providers other than the system default.Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

SSLSecurityFlags

Flags that control certificate verification

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001

Ignore time validity status of certificate.

0x00000002

Ignore time validity status of CTL.

0x00000004

Ignore non-nested certificate times.

0x00000010

Allow unknown Certificate Authority.

0x00000020

Ignore wrong certificate usage.

0x00000100

Ignore unknown certificate revocation status.

0x00000200

Ignore unknown CTL signer revocation status.

0x00000400

Ignore unknown Certificate Authority revocation status.

0x00000800

Ignore unknown Root revocation status.

0x00008000

Allow test Root certificate.

0x00004000

Trust test Root certificate.

0x80000000

Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLContextProtocol

The protocol used when getting an SSLContext instance

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLTrustManagerFactoryAlgorithm

The algorithm to be used to create a TrustManager through TrustManagerFactory

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

SSLEnabledCipherSuites

The cipher suite to be used in an SSL negotiation

The enabled cipher suites to be used in SSL negotiation.By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values:

 obj.config("SSLEnabledCipherSuites=*");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
 obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); 

Possible values include:

• SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_RC4_128_SHA
• SSL_RSA_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_WITH_DES_CBC_SHA
• SSL_RSA_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
• SSL_DHE_DSS_WITH_DES_CBC_SHA
• SSL_RSA_WITH_NULL_MD5
• SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
• SSL_DHE_RSA_WITH_DES_CBC_SHA
• SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
• SSL_RSA_WITH_NULL_SHA
• SSL_DH_anon_WITH_RC4_128_MD5
• SSL_RSA_WITH_RC4_128_MD5
• SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_ECDSA_WITH_NULL_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA256
• TLS_ECDH_anon_WITH_RC4_128_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_EXPORT_WITH_RC4_40_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_RC4_128_SHA
• TLS_ECDH_ECDSA_WITH_RC4_128_SHA
• TLS_ECDH_anon_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• TLS_RSA_WITH_NULL_SHA256
• TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
• TLS_KRB5_WITH_RC4_128_MD5
• TLS_ECDHE_ECDSA_WITH_NULL_SHA
• TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_RC4_128_SHA
• TLS_EMPTY_RENEGOTIATION_INFO_SCSV
• TLS_KRB5_WITH_3DES_EDE_CBC_MD5
• TLS_KRB5_WITH_RC4_128_SHA
• TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDH_RSA_WITH_NULL_SHA
• TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_WITH_DES_CBC_MD5
• TLS_KRB5_EXPORT_WITH_RC4_40_MD5
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
• TLS_ECDH_anon_WITH_AES_128_CBC_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_KRB5_WITH_DES_CBC_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA
• TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_NULL_SHA
• TLS_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_DHE_DSS_WITH_AES_128_CBC_SHA

SSLEnabledCipherSuites is used together with SSLCipherStrength .

Note: This configuration setting is available only in .NET and Java.

SSLAlgorithmList

A string that controls the cipher algorithms to be used by SSL

This configuration option takes a semicolon (;) delimited list of cipher algorithms to specify what algorithms may be used by SSL. This option can be used in conjunction with SSLEnabledProtocols to control which ciphers are used.For example:

 obj.Config("SSLEnabledProtocols=3072"); // TLS1.2  (supports SHA_256)
   obj.Config("SSLAlgorithmList=CALG_SHA_256;CALG_MD5"); 

Possible values include:

• CALG_3DES
• CALG_3DES_112
• CALG_AES
• CALG_AES_128
• CALG_AES_192
• CALG_AES_256
• CALG_AGREEDKEY_ANY
• CALG_CYLINK_MEK
• CALG_DES
• CALG_DESX
• CALG_DH_EPHEM
• CALG_DH_SF
• CALG_DSS_SIGN
• CALG_ECDH
• CALG_ECDSA
• CALG_ECMQV
• CALG_HASH_REPLACE_OWF
• CALG_HUGHES_MD5
• CALG_HMAC
• CALG_KEA_KEYX
• CALG_MAC
• CALG_MD2
• CALG_MD4
• CALG_MD5
• CALG_NO_SIGN
• CALG_OID_INFO_CNG_ONLY
• CALG_OID_INFO_PARAMETERS
• CALG_PCT1_MASTER
• CALG_RC2
• CALG_RC4
• CALG_RC5
• CALG_RSA_KEYX
• CALG_RSA_SIGN
• CALG_SCHANNEL_ENC_KEY
• CALG_SCHANNEL_MAC_KEY
• CALG_SCHANNEL_MASTER_HASH
• CALG_SEAL
• CALG_SHA
• CALG_SHA1
• CALG_SHA_256
• CALG_SHA_384
• CALG_SHA_512
• CALG_SKIPJACK
• CALG_SSL2_MASTER
• CALG_SSL3_MASTER
• CALG_SSL3_SHAMD5
• CALG_TEK
• CALG_TLS1_MASTER
• CALG_TLS1PRF

This option is only valid in Windows.

Socket Configuration Settings

AbsoluteTimeout

Determines whether timeouts are inactivity timeouts or absolute timeouts

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.Note: This option is not valid for UDP ports.

FirewallData

Used to send extra data to the firewall

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize

The size in bytes of the incoming queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize

The size in bytes of the outgoing queue of the socket

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable

Tells the bean whether or not a message loop is available for processing events

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

UseDaemonThreads

Whether threads created by the bean are daemon threads

If set to True, when the bean creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the bean will not set the Daemon property on the created thread.

Throws:

IPWorksSSLException

connect

public void connect()
             throws IPWorksSSLException

Connects to the mail relay and sends the SMTP HELO command.

This method connects to the mail relay and sends the SMTP HELO command, thus preparing for sending messages. Any number of messages can later be sent using the Send method.

Example (Connect and Send an Email)

 control.MailServer = "MyServer"
 control.From = "me@server.com"
 control.SendTo = "recipient@server.com"
 control.Subject = "My Subject"
 control.MessageText = "This is the message body"
 control.Connect()
 control.Send()
 control.Disconnect() 

Throws:

IPWorksSSLException

disconnect

public void disconnect()
                throws IPWorksSSLException

Disconnects from the SMTP server.

This method disconnects from the mail relay.

Throws:

IPWorksSSLException

doEvents

public void doEvents()
              throws IPWorksSSLException

Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:

IPWorksSSLException

expand

public void expand(java.lang.String emailAddress)
            throws IPWorksSSLException

Asks the MailServer to expand a name or mailing list.

This method asks the MailServer to expand a name or mailing list. The resulting response is provided in one or more Expand events (one for each address). The bean will try to connect to the mail relay if it is not already connected.

Throws:

IPWorksSSLException

interrupt

public void interrupt()
               throws IPWorksSSLException

Interrupt the current method.

If there is no method in progress, Interrupt simply returns, doing nothing.

Throws:

IPWorksSSLException

processQueue

public void processQueue(java.lang.String queueDir)
                  throws IPWorksSSLException

Sends the messages which have previously been queued into QueueDir .

This method sends the messages which have previously been queued into QueueDir . The PITrail event shows the interaction with the server as messages as are processed.

This method looks in the directory for files with extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the {@link ipworksssl.Smtps#config configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Throws:

IPWorksSSLException

queue

public java.lang.String queue(java.lang.String queueDir)
                       throws IPWorksSSLException

Queues the message into QueueDir .

This method queues the message into QueueDir . The message is queued into a unique file into the directory QueueDir for future processing.

QueueDir must already exist, or an error will be generated.

The method returns the name of the unique queue file created in QueueDir . The file extension is ".queued".

Please refer to the ProcessQueue method for more information on email queue processing.

Throws:

IPWorksSSLException

resetHeaders

public void resetHeaders()
                  throws IPWorksSSLException

Resets all the message headers to empty.

This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.

Throws:

IPWorksSSLException

send

public void send()
          throws IPWorksSSLException

Sends the current message.

This method sends the current message. If the bean is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.

If the bean is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.

Example (Send an Email)

 SMTPControl.MailServer = "MyServer"
 SMTPControl.From = "me@server.com"
 SMTPControl.SendTo = "recipient@server.com"
 SMTPControl.Subject = "My Subject"
 SMTPControl.MessageText = "This is the message body"
 SMTPControl.Send() 

Throws:

IPWorksSSLException

sendToTerminalAndEmail

public void sendToTerminalAndEmail()
                            throws IPWorksSSLException

Sends to terminal and email.

This method is similar to Send but requests also that the message is sent to the terminal of the user as well, if he is logged on and accepts terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

Throws:

IPWorksSSLException

sendToTerminalOnly

public void sendToTerminalOnly()
                        throws IPWorksSSLException

Sends to terminal only.

This method is similar to Send but requests instead that the message is sent to the user's terminal. An exception with the server's response is raised if the user is not logged in or does not accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

Throws:

IPWorksSSLException

sendToTerminalOrEmail

public void sendToTerminalOrEmail()
                           throws IPWorksSSLException

Sends to terminal or email.

This method is similar to Send but requests instead that the message is first sent to the user's terminal. If the user is not logged in or does not accept terminal messages, the message is sent to his mailbox. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

Throws:

IPWorksSSLException

setMessageStream

public void setMessageStream(java.io.InputStream messageStream)
                      throws IPWorksSSLException

Sets the stream to be uploaded to the server as part of the message.

This method sets the stream to be uploaded to the server as part of the message. If an upload stream is set before the Send method is called, the content of the stream will be read by the bean and uploaded to the server; The stream should be open and normally set to position 0. The bean will automatically close this stream if ipworksssl.Smtps#config is set to true (default). If the stream is closed, you will need to call this method again before calling {@link ipworksssl.Smtps#send Send} again. The content of the stream will be read from the current position all the way to the end.

Note: This method and {@link ipworksssl.Smtps#getLocalFile LocalFile} will reset the other.

Throws:

IPWorksSSLException

verify

public void verify(java.lang.String emailAddress)
            throws IPWorksSSLException

Sends a Verification request to the SMTP server.

This method asks the MailServer to verify the email address provided in the 'EmailAddress' parameter.

Throws:

IPWorksSSLException

addSmtpsEventListener

public void addSmtpsEventListener(SmtpsEventListener l)
                           throws java.util.TooManyListenersException

Throws:

java.util.TooManyListenersException

removeSmtpsEventListener

public void removeSmtpsEventListener(SmtpsEventListener l)