Constructor Detail

• POP3SClient

  public POP3SClient()

  Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. TLS Sets security mode to explicit.

• POP3SClient

  public POP3SClient(boolean implicit)

  Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. TLS

  Parameters:

  implicit - The security mode, true for implicit, false for explicit

• POP3SClient

  public POP3SClient(String proto)

  Constructor for POP3SClient. Sets security mode to explicit.

  Parameters:

  proto - the protocol.

• POP3SClient

  public POP3SClient(String proto,
             boolean implicit)

  Constructor for POP3SClient.

  Parameters:

  proto - the protocol.

  implicit - The security mode, true for implicit, false for explicit

• POP3SClient

  public POP3SClient(String proto,
             boolean implicit,
             SSLContext ctx)

  Constructor for POP3SClient. Sets the default port to DEFAULT_POP3S_PORT - 995 - if using implicit mode

  Parameters:

  proto - the protocol.

  implicit - The security mode, true for implicit, false for explicit

  ctx - the context to be used

• POP3SClient

  public POP3SClient(boolean implicit,
             SSLContext ctx)

  Constructor for POP3SClient, using DEFAULT_PROTOCOL i.e. TLS

  Parameters:

  implicit - The security mode, true for implicit, false for explicit

  ctx - A pre-configured SSL Context.

• POP3SClient

  public POP3SClient(SSLContext context)

  Constructor for POP3SClient, using DEFAULT_PROTOCOL - TLS - and isImplicit = false

  Parameters:

  context - A pre-configured SSL Context.

  See Also:

  POP3SClient(boolean, SSLContext)

Method Detail

• _connectAction_

  protected void _connectAction_()
                          throws IOException

  Because there are so many connect() methods, the _connectAction_() method is provided as a means of performing some action immediately after establishing a connection, rather than reimplementing all of the connect() methods.

  Overrides:

  _connectAction_ in class POP3

  Throws:

  IOException - If it is thrown by _connectAction_().

  See Also:

  SocketClient._connectAction_()

• setKeyManager

  public void setKeyManager(KeyManager newKeyManager)

  Set a KeyManager to use.

  Parameters:

  newKeyManager - The KeyManager implementation to set.

  See Also:

  KeyManagerUtils

• setEnabledCipherSuites

  public void setEnabledCipherSuites(String[] cipherSuites)

  Controls which particular cipher suites are enabled for use on this connection. Called before server negotiation.

  Parameters:

  cipherSuites - The cipher suites.

• getEnabledCipherSuites

  public String[] getEnabledCipherSuites()

  Returns the names of the cipher suites which could be enabled for use on this connection. When the underlying Socket is not an SSLSocket instance, returns null.

  Returns:

  An array of cipher suite names, or null.

• setEnabledProtocols

  public void setEnabledProtocols(String[] protocolVersions)

  Controls which particular protocol versions are enabled for use on this connection. I perform setting before a server negotiation.

  Parameters:

  protocolVersions - The protocol versions.

• getEnabledProtocols

  public String[] getEnabledProtocols()

  Returns the names of the protocol versions which are currently enabled for use on this connection. When the underlying Socket is not an SSLSocket instance, returns null.

  Returns:

  An array of protocols, or null.

• execTLS

  public boolean execTLS()
                  throws SSLException,
                         IOException

  The TLS command execution.

  Returns:

  TRUE if the command and negotiation succeeded.

  Throws:

  SSLException - If the server reply code is not positive.

  IOException - If an I/O error occurs while sending the command or performing the negotiation.

• getTrustManager

  public TrustManager getTrustManager()

  Get the currently configured TrustManager.

  Returns:

  A TrustManager instance.

• setTrustManager

  public void setTrustManager(TrustManager newTrustManager)

  Override the default TrustManager to use.

  Parameters:

  newTrustManager - The TrustManager implementation to set.

  See Also:

  TrustManagerUtils

• getHostnameVerifier

  public HostnameVerifier getHostnameVerifier()

  Get the currently configured HostnameVerifier.

  Returns:

  A HostnameVerifier instance.

  Since:

  3.4

• setHostnameVerifier

  public void setHostnameVerifier(HostnameVerifier newHostnameVerifier)

  Override the default HostnameVerifier to use.

  Parameters:

  newHostnameVerifier - The HostnameVerifier implementation to set or null to disable.

  Since:

  3.4

• isEndpointCheckingEnabled

  public boolean isEndpointCheckingEnabled()

  Return whether or not endpoint identification using the HTTPS algorithm on Java 1.7+ is enabled. The default behaviour is for this to be disabled.

  Returns:

  True if enabled, false if not.

  Since:

  3.4

• setEndpointCheckingEnabled

  public void setEndpointCheckingEnabled(boolean enable)

  Automatic endpoint identification checking using the HTTPS algorithm is supported on Java 1.7+. The default behaviour is for this to be disabled.

  Parameters:

  enable - Enable automatic endpoint identification checking using the HTTPS algorithm on Java 1.7+.

  Since:

  3.4