|
IP*Works! S/MIME V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworkssmime.Spop
public class Spop
The SPOP Bean is used retrieve electronic mail from Internet Post Office servers (POP).
The SPOP Bean is the S/MIME enabled equivalent of the
IP*Works! POP Bean. In addition to standard POP functions the SPOP
bean can decrypt and/or verify message signatures. The methods and
properties for decrypting, and verifying signatures are identical to those
provided with the S/MIME Bean. When attempting to verify a signed message
or when decrypting a message call the Decrypt
, VerifySignature
, or DecryptAndVerifySignature
methods and the resulting text will be replaced
in Message
.
The SPOP Bean implements a standard internet post office (POP3) client as specified in RFC 1725.
To connect to a MailServer
first set the
appropriate User
and Password
and then connect by calling the Connect
method. Upon successful
connection to the MailServer
, the number of waiting messages is shown
by the MessageCount
property. A message is selected by setting the MessageNumber
property to a number between 1 and MessageCount
(inclusive). Then, message text and/or headers are received by calling the Retrieve
method.
The message text is received through the Transfer
event,
whereas the message headers are received through the Header
event.
Additionally, up to MaxLines
from the message body are provided
in the MessageText
property. The
body of the message is also saved in the file specified by the LocalFile
property. StartTransfer
and EndTransfer
events are fired at the
beginning and end of message transmission. The PITrail
event provides a
trace of the interaction between the client and server (excluding message
transfers).
Field Summary | |
---|---|
static int |
amAPOP
|
static int |
amCRAMMD5
|
static int |
amKerberos
|
static int |
amNTLM
|
static int |
amSASLDigestMD5
|
static int |
amSASLPlain
|
static int |
amUserPassword
|
static int |
sslAutomatic
|
static int |
sslExplicit
|
static int |
sslImplicit
|
static int |
sslNone
|
Constructor Summary | |
---|---|
Spop()
Creates an instance of Spop Bean. |
|
Spop(java.lang.String runtimeLicense)
Creates an instance of Spop Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addSpopEventListener(SpopEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
connect()
Connects to the mail server and attempts to login. |
void |
decrypt()
Decrypts the current Message . |
void |
decryptAndVerifySignature()
Decrypts and verifies the signature of the current Message . |
void |
delete()
Deletes a message specified by MessageNumber on the server. |
void |
disconnect()
Disconnects from the mail server. |
void |
doEvents()
Processes events from the internal message queue. |
int |
getAuthMechanism()
The authentication mechanism to be used when connecting to the mail server. |
Certificate |
getCertificate()
The current selected certificate. |
Firewall |
getFirewall()
A set of properties related to firewall access. |
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 POP (default 110). |
java.lang.String |
getMailServer()
The name or address of a mail server (internet post office server). |
int |
getMaxLines()
The maximum number of message lines besides headers to retrieve. |
byte[] |
getMessage()
Provides the raw message content. |
java.lang.String |
getMessageCc()
The value of the CC header of the last retrieved message. |
int |
getMessageCount()
The number of messages waiting in the mailbox. |
java.lang.String |
getMessageDate()
The value of the date header of the last retrieved message. |
java.lang.String |
getMessageFrom()
The value of the from header of the last retrieved message. |
HeaderList |
getMessageHeaders()
Collection of the message headers as retrieved from the server. |
java.lang.String |
getMessageHeadersString()
A string representation of the full headers of the message as retrieved from the server. |
int |
getMessageNumber()
Current (selected) message. |
MessageRecipientList |
getMessageRecipients()
A collection of recipients for the current message. |
java.lang.String |
getMessageReplyTo()
The value of the Reply-To header of the last retrieved message. |
int |
getMessageSize()
The size in bytes of the current message. |
java.lang.String |
getMessageSubject()
The value of the Subject header of the last retrieved message. |
java.lang.String |
getMessageText()
The full text of the message as retrieved from the server. |
java.lang.String |
getMessageTo()
The value of the To header of the last retrieved message. |
java.lang.String |
getMessageUID()
The unique identifier of the message as specified by the server. |
java.lang.String |
getPassword()
The password for the mailbox user. |
Certificate |
getSignerCert()
Contains the certificate of the message signer. |
CertificateList |
getSignerCertChain()
The certificate chain of the signing certificate. |
java.lang.String |
getSigningAlgorithm()
Textual description of the signature hash algorithm. |
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. |
int |
getTimeout()
A timeout for the bean. |
long |
getTotalSize()
Cumulative size in bytes of messages in the mailbox (including headers). |
java.lang.String |
getUser()
The user identifier for the mailbox. |
void |
interrupt()
Interrupt the current method. |
boolean |
isConnected()
Shows whether the bean is connected. |
boolean |
isIdle()
The current status of the component. |
boolean |
isIncludeHeaders()
Instructs the component to include the headers in the MessageText and LocalFile. |
boolean |
isMessageEncrypted()
Whether or not the current message is encrypted. |
boolean |
isMessageSigned()
Whether or not the current message is signed. |
void |
listMessageSizes()
Retrieves a list of all message sizes from the server. |
void |
listMessageUIDs()
Retrieves a list of all message UIDs from the server. |
java.lang.String |
localizeDate(java.lang.String dateTime)
Converts a valid RFC 822 message date to local date and time. |
void |
removeSpopEventListener(SpopEventListener l)
|
void |
reset()
Resets all changes and revert back to the state when the user first connected. |
void |
retrieve()
Retrieves a message specified by MessageNumber from the server. |
void |
retrieveHeaders()
Retrieves headers for a message specified by MessageNumber . |
void |
setAuthMechanism(int authMechanism)
The authentication mechanism to be used when connecting to the mail server. |
void |
setCertificate(Certificate certificate)
The current selected certificate. |
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 |
setFirewall(Firewall firewall)
A set of properties related to firewall access. |
void |
setIncludeHeaders(boolean includeHeaders)
Instructs the component to include the headers in the MessageText and LocalFile. |
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 POP (default 110). |
void |
setMailServer(java.lang.String mailServer)
The name or address of a mail server (internet post office server). |
void |
setMaxLines(int maxLines)
The maximum number of message lines besides headers to retrieve. |
void |
setMessageNumber(int messageNumber)
Current (selected) message. |
void |
setMessageStream(java.io.OutputStream messageStream)
Sets the stream to which the message downloaded from the server will be written. |
void |
setPassword(java.lang.String password)
The password for the mailbox user. |
void |
setSignerCert(Certificate signerCert)
Contains the certificate of the message signer. |
void |
setSigningAlgorithm(java.lang.String signingAlgorithm)
Textual description of the signature hash algorithm. |
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 |
setTimeout(int timeout)
A timeout for the bean. |
void |
setUser(java.lang.String user)
The user identifier for the mailbox. |
void |
verifySignature()
Verifies the signature of the current Message . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int amUserPassword
public static final int amCRAMMD5
public static final int amNTLM
public static final int amAPOP
public static final int amSASLPlain
public static final int amSASLDigestMD5
public static final int amKerberos
public static final int sslAutomatic
public static final int sslImplicit
public static final int sslExplicit
public static final int sslNone
Constructor Detail |
---|
public Spop()
public Spop(java.lang.String runtimeLicense)
Method Detail |
---|
public int getAuthMechanism()
This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to login to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.
amSASLPlain (4) is also available, but most servers require a secure SSL connection when utilizing this authentication mechanism.
amKerberos (6) is for Kerberos authentication. NOTE: This functionality is only available in Windows.
public void setAuthMechanism(int authMechanism) throws IPWorksSMIMEException
This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to login to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.
amSASLPlain (4) is also available, but most servers require a secure SSL connection when utilizing this authentication mechanism.
amKerberos (6) is for Kerberos authentication. NOTE: This functionality is only available in Windows.
IPWorksSMIMEException
public Certificate getCertificate()
This property is populated when a specified certificate
is found or loaded by the bean. This property is
used for specifying private keys. Set this property to a
valid Certificate
object to perform different operations
such as Sign
, Decrypt
, SignAndEncrypt
, or DecryptAndVerifySignature
. To set a certificate, you may
set the Encoded
field to the encoded certificate.
To select a certificate, use the Store
and Subject
fields.
public void setCertificate(Certificate certificate) throws IPWorksSMIMEException
This property is populated when a specified certificate
is found or loaded by the bean. This property is
used for specifying private keys. Set this property to a
valid Certificate
object to perform different operations
such as Sign
, Decrypt
, SignAndEncrypt
, or DecryptAndVerifySignature
. To set a certificate, you may
set the Encoded
field to the encoded certificate.
To select a certificate, use the Store
and Subject
fields.
IPWorksSMIMEException
public void setCommand(java.lang.String command) throws IPWorksSMIMEException
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.
IPWorksSMIMEException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksSMIMEException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksSMIMEException
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksSMIMEException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksSMIMEException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public boolean isIncludeHeaders()
This property instructs the component to include the headers in the MessageText and LocalFile. If set to true, the headers for the message you are retrieving will be placed before the message body in the MessageText
property;. If LocalFile
is set, then the headers will be written to that file before the message body. In this manner,
the whole content of a MIME-encoded message can be passed to the MIME bean for further message processing.
public void setIncludeHeaders(boolean includeHeaders) throws IPWorksSMIMEException
This property instructs the component to include the headers in the MessageText and LocalFile. If set to true, the headers for the message you are retrieving will be placed before the message body in the MessageText
property;. If LocalFile
is set, then the headers will be written to that file before the message body. In this manner,
the whole content of a MIME-encoded message can be passed to the MIME bean for further message processing.
IPWorksSMIMEException
public java.lang.String getLastReply()
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.
public java.lang.String getLocalHost()
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.
public void setLocalHost(java.lang.String localHost) throws IPWorksSMIMEException
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.
IPWorksSMIMEException
public int getMailPort()
This property contains the server port for POP (default 110). 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.
public void setMailPort(int mailPort) throws IPWorksSMIMEException
This property contains the server port for POP (default 110). 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.
IPWorksSMIMEException
public java.lang.String getMailServer()
This property specifies the IP address (IP number in dotted internet format) or the Domain Name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.
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 the bean throws an exception.
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.
public void setMailServer(java.lang.String mailServer) throws IPWorksSMIMEException
This property specifies the IP address (IP number in dotted internet format) or the Domain Name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.
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 the bean throws an exception.
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.
IPWorksSMIMEException
public int getMaxLines()
This property is used to limit the number of text lines besides headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.
The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.
public void setMaxLines(int maxLines) throws IPWorksSMIMEException
This property is used to limit the number of text lines besides headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.
The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.
IPWorksSMIMEException
public byte[] getMessage()
This property is populated after calling Retrieve
and holds the raw message content.
This can be used to access the data before any processing is done by the bean.
public java.lang.String getMessageCc()
This property contains the value of the CC header of the last retrieved message. The same information may also be retrieved through the Header
event.
public int getMessageCount()
This property contains the number of messages waiting in the mailbox. When the bean is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mail box as reported by the POP server.
public java.lang.String getMessageDate()
This property contains the value of the date header of the last retrieved message. The same information may also be retrieved through the Header
event.
public boolean isMessageEncrypted()
This property indicates whether or not the current message is encrypted. This property will return true if the current message appears to be encrypted,
according to the value of MessageHeaders
.
public java.lang.String getMessageFrom()
This property contains the value of the from header of the last retrieved message. The same information may also be retrieved through the Header
event.
public HeaderList getMessageHeaders()
This property contains a collection of the message headers as retrieved from the server. If the bean is not connected, or MessageNumber
does not
contain a valid message number, the value of this property is an
empty collection. Otherwise, it contains a parsed collection of the full
headers of the mail message as reported by the server.
The MailServer
is asked about the headers of the message only
if the MessageNumber
property has changed. If MessageNumber
has not changed, the bean returns a cached value.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
MessageText = POPControl.MessageText
MessageHeaders = POPControl.MessageHeaders
public java.lang.String getMessageHeadersString()
This property contains a string representation of the full headers of the message as retrieved from the server. If the bean is not connected, or MessageNumber
does not
contain a valid message number, the value of this property is an
empty string. Otherwise, it contains the full headers of the mail message
as reported by the server.
The MailServer
is asked about the headers of the message only
if the MessageNumber
property has changed. If MessageNumber
has not changed, the bean returns a cached value.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
MessageText = POPControl.MessageText
MessageHeadersString = POPControl.MessageHeadersString
public int getMessageNumber()
This property indicates the current/selected message. This property specifies a message number in between
1 and MessageCount
. The various bean methods related to
single messages use this property as a message pointer (see method
descriptions and the MessageSize
property).
public void setMessageNumber(int messageNumber) throws IPWorksSMIMEException
This property indicates the current/selected message. This property specifies a message number in between
1 and MessageCount
. The various bean methods related to
single messages use this property as a message pointer (see method
descriptions and the MessageSize
property).
IPWorksSMIMEException
public MessageRecipientList getMessageRecipients()
This property contains a collection of recipients for the current message. This collection describes all of the people
to whom the last retrieved message was sent.
Each messagerecipient
contains information
describing that recipient, and what type of
recipient it is.
This collection is indexed from 0 to size - 1.
public java.lang.String getMessageReplyTo()
This property contains the value of the Reply-To header of the last retrieved message. The same information may also be retrieved through the Header
event.
public boolean isMessageSigned()
This property indicates whether or not the current message is signed. This property will return true if the current message appears to be signed,
according to the value of MessageHeaders
.
Note that a message that is both signed and encrypted will not appear to be signed until after it is decrypted.
public int getMessageSize()
This property contains the size in bytes of the current message. If the bean is not connected, or MessageNumber
does not
contain a valid message number, the value of this property is 0.
Otherwise, it contains the size of the mail message (including
headers) as reported by the server.
The MailServer
is asked about the size of the message only
if the MessageNumber
property has changed. If MessageNumber
has not changed, the bean returns a cached value.
public java.lang.String getMessageSubject()
This property contains the value of the Subject header of the last retrieved message. The same information may also be retrieved through the Header
event.
public java.lang.String getMessageText()
This property contains the full text of the message as retrieved from the server. If the bean is not connected, or MessageNumber
does not
contain a valid message number, the value of this property is an
empty string. Otherwise, it contains the text of the mail message
as reported by the server (a maximum of MaxLines
).
The MailServer
is asked about the text of the message only
if the MessageNumber
property has changed. If MessageNumber
has not changed, the bean returns a cached value.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
MessageText = POPControl.MessageText
MessageHeaders = POPControl.MessageHeaders
public java.lang.String getMessageTo()
This property contains the value of the To header of the last retrieved message. The same information may also be retrieved through the Header
event.
public java.lang.String getMessageUID()
This property contains the unique identifier of the message as specified by the server. If the bean is not connected, or MessageNumber
does not
contain a valid message number, the value of this property is an
empty string. Otherwise, it contains the UID of the mail message
as reported by the server.
The MailServer
is asked about the UID of the message only
if the MessageNumber
property has changed. If MessageNumber
has not changed, the bean returns a cached value.
public java.lang.String getPassword()
This property contains the password for the mailbox user. This property must be set before the bean connects to the MailServer
.
public void setPassword(java.lang.String password) throws IPWorksSMIMEException
This property contains the password for the mailbox user. This property must be set before the bean connects to the MailServer
.
IPWorksSMIMEException
public Certificate getSignerCert()
This property contains the certificate of the message signer. When calling VerifySignature
or DecryptAndVerifySignature
this
property will contain the certificate of the sender if attached.
To verify messages without an attached certificate, set this
property before calling VerifySignature
or DecryptAndVerifySignature
.
public void setSignerCert(Certificate signerCert) throws IPWorksSMIMEException
This property contains the certificate of the message signer. When calling VerifySignature
or DecryptAndVerifySignature
this
property will contain the certificate of the sender if attached.
To verify messages without an attached certificate, set this
property before calling VerifySignature
or DecryptAndVerifySignature
.
IPWorksSMIMEException
public CertificateList getSignerCertChain()
This property contains the certificate chain of the signing certificate. When calling VerifySignature
or DecryptAndVerifySignature
, this
property will be populated with the certificate chain of the sender if
attached.
NOTE: The SignerCert
property will contain the signing certificate.
The certificates in the signing certificate's chain will be placed
in this property's collection.
public java.lang.String getSigningAlgorithm()
This property specifies the hash algorithm used to prepare the message digest for signature.
This property must contain either the name of the algorithm (such as "MD5" or "SHA1"), or an object id (OID) string representing the hash algorithm.
When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.
public void setSigningAlgorithm(java.lang.String signingAlgorithm) throws IPWorksSMIMEException
This property specifies the hash algorithm used to prepare the message digest for signature.
This property must contain either the name of the algorithm (such as "MD5" or "SHA1"), or an object id (OID) string representing the hash algorithm.
When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.
IPWorksSMIMEException
public Certificate getSSLAcceptServerCert()
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.
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert) throws IPWorksSMIMEException
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.
IPWorksSMIMEException
public Certificate getSSLCert()
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.
public void setSSLCert(Certificate SSLCert) throws IPWorksSMIMEException
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.
IPWorksSMIMEException
public Certificate getSSLServerCert()
SSLServerCert
contains the server certificate for the
last established connection.
SSLServerCert
is reset every time a new connection is attempted.
public int getSSLStartMode()
The SSLStartMode
property may have one of the following values:
SSLStartMode
is set to sslExplicit . In all other cases, SSL negotiation will be implicit
( sslImplicit ).
public void setSSLStartMode(int SSLStartMode) throws IPWorksSMIMEException
The SSLStartMode
property may have one of the following values:
SSLStartMode
is set to sslExplicit . In all other cases, SSL negotiation will be implicit
( sslImplicit ).
IPWorksSMIMEException
public int getTimeout()
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 AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksSMIMEException
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 AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksSMIMEException
public long getTotalSize()
This property contains the cumulative size in bytes of messages in the mailbox (including headers). When the bean is not connected to the server, the value of this property is 0. When connected, it contains the cumulative size of all the messages in the mail box as reported by the POP server.
public java.lang.String getUser()
This property contains the user identifier for the mailbox. This property must be set before the bean connects to the MailServer
.
public void setUser(java.lang.String user) throws IPWorksSMIMEException
This property contains the user identifier for the mailbox. This property must be set before the bean connects to the MailServer
.
IPWorksSMIMEException
public java.lang.String config(java.lang.String configurationString) throws IPWorksSMIMEException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for the
bean.
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 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 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 Config
method.
AuthMechanism
is set to amSASLPlain or amSASLDigestMD5 you may use this setting to specify an authorization
identity to be used when authenticating.Transfer
event will be populated.
When this value is False (default), the PercentDone parameter of the Transfer
event will not be updated and will evaluate to -1.LocalFile
will include the message headers in addition to the message body.MessageHeaders
collection
will be populated
when a Header
event has been fired. This value
represents the number of headers that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
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.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
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 ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
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
is set automatically when FirewallType
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.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
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.
TCPKeepAlive
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.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. 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.
LingerTime
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, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
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.
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 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
after the connection is established.
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
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
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 OpenSSLCipherList
config setting.
When the provider is OpenSSL, SSLCipherStrength is currently not supported.
This functionality is instead made available through the OpenSSLCipherList
config setting.
TLS 1.1 and TLS1.2 support are only available starting with Windows 7.
NOTE: setting the property to 0 has the same effect as setting it to 4095 (enables all protocols).
The special value "*" (default) picks the default SSL provider defined in the system. On Windows, this is "Microsoft Unified Security Protocol Provider".
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.
Some sample settings:
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:
SSLEnabledCipherSuites is used together with SSLCipherStrength .
NOTE: This configuration setting is available only for Java products. 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.
IPWorksSMIMEException
public void connect() throws IPWorksSMIMEException
This method connects to the mail server and attempts to login using the current User
and Password
. Then it retrieves initial statistics about
the mailbox contents ( MessageCount
and TotalSize
).
Example (Connect to POP Mailbox)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.Retrieve()
MessageText = POPControl.MessageText
MessageHeaders = POPControl.MessageHeaders
IPWorksSMIMEException
public void decrypt() throws IPWorksSMIMEException
Message
.
This method takes the Message
property and attempts to decrypt the encrypted
PKCS envelope using the certificate in Certificate
. If the bean
is able to decrypt it will replace Message
and MessageHeaders
with the decrypted text.
IPWorksSMIMEException
public void decryptAndVerifySignature() throws IPWorksSMIMEException
Message
.
This method attempts to both decrypt and verify the signature of the message data included
in Message
. All of the properties affected by calling the Decrypt
and VerifySignature
methods are affected in the same manner.
NOTE: This function does not attempt to check the validity of the signing certificate itself.
IPWorksSMIMEException
public void delete() throws IPWorksSMIMEException
MessageNumber
on the server.
This method asks the MailServer
to delete the message specified by MessageNumber
. The message will not
actually be deleted from the server until the connection is closed. In order to cancel a previous
Delete, use the Reset
method.
IPWorksSMIMEException
public void disconnect() throws IPWorksSMIMEException
This method makes the bean disconnect from the MailServer
by sending the QUIT
command. If successful, all changes to the mailbox are committed by the server.
Otherwise, changes are rolled back to the initial state that the server was in before
the connection.
IPWorksSMIMEException
public void doEvents() throws IPWorksSMIMEException
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.
IPWorksSMIMEException
public void interrupt() throws IPWorksSMIMEException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksSMIMEException
public void listMessageSizes() throws IPWorksSMIMEException
This message retrieves a list of all message sizes from the server. For each message listed, a MessageList
event will fire containing the number and size of the message.
IPWorksSMIMEException
public void listMessageUIDs() throws IPWorksSMIMEException
This method retrieves a list of all message UIDs from the server. For each message listed, a MessageList
event will fire containing the number and UID of the message.
IPWorksSMIMEException
public java.lang.String localizeDate(java.lang.String dateTime) throws IPWorksSMIMEException
This method can be used to convert an RFC 822 date/time string to the corresponding local date and time.
Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".
IPWorksSMIMEException
public void reset() throws IPWorksSMIMEException
This method is used to reset all changes and revert back to the state when the user first connected. Asks the MailServer
to reset all changes and revert back to the state
it was when connected.
IPWorksSMIMEException
public void retrieve() throws IPWorksSMIMEException
MessageNumber
from the server.
This method is used to retrieve a message specified by MessageNumber
from the server. It asks the MailServer
to retrieve the message specified by MessageNumber
.
The message headers will arrive in the Header
event, and the message text will
arrive in the Transfer
event.
The MaxLines
property defines the number of lines retrieved.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.Retrieve()
IPWorksSMIMEException
public void retrieveHeaders() throws IPWorksSMIMEException
MessageNumber
.
Calling this method will retrieve the headers for the message specified
by the MessageNumber
property. The message headers
will be provided by the Header
event and also stored in the MessageHeaders
property.
Example (Connect and Retrieve Message Headers)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.RetrieveHeaders()
IPWorksSMIMEException
public void setMessageStream(java.io.OutputStream messageStream) throws IPWorksSMIMEException
This method sets the stream to which the message downloaded from the server will be written. If a download stream is set before the Retrieve
method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
The bean will automatically close this stream if CloseStreamAfterTransfer
is set to true (default). If the stream is closed, you will need to call SetMessageStream
again before calling Retrieve
again.
The downloaded content will be written starting at the current position in the stream.
Note: SetMessageStream
and LocalFile
will reset the other.
IPWorksSMIMEException
public void verifySignature() throws IPWorksSMIMEException
Message
.
This method attempts to verify the signature contained in Message
. If the
message does not have a certificate attached, the bean will attempt
to verify the signature using the certificate supplied in SignerCert
(if any). If no certificate is found, the bean
throws an exception.
If this method is successful, the SignerCert
property will
contain the certificate information of the message signer.
NOTE: This function does not attempt to check the validity of the signing certificate itself.
IPWorksSMIMEException
public void addSpopEventListener(SpopEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeSpopEventListener(SpopEventListener l)
|
IP*Works! S/MIME V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |