Class ExtendedPOP3Client


  • public class ExtendedPOP3Client
    extends POP3SClient
    A POP3 Cilent class with protocol and authentication extensions support (RFC2449 and RFC2195).
    Since:
    3.0
    See Also:
    POP3Client
    • Field Detail

      • MAC_ALGORITHM

        private static final java.lang.String MAC_ALGORITHM
        Mac algorithm.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ExtendedPOP3Client

        public ExtendedPOP3Client()
                           throws java.security.NoSuchAlgorithmException
        The default ExtendedPOP3Client constructor. Creates a new Extended POP3 Client.
        Throws:
        java.security.NoSuchAlgorithmException - on error
    • Method Detail

      • auth

        public boolean auth​(ExtendedPOP3Client.AUTH_METHOD method,
                            java.lang.String user,
                            java.lang.String password)
                     throws java.io.IOException,
                            java.security.NoSuchAlgorithmException,
                            java.security.InvalidKeyException,
                            java.security.spec.InvalidKeySpecException
        Authenticate to the POP3 server by sending the AUTH command with the selected mechanism, using the given user and the given password.
        Parameters:
        method - the ExtendedPOP3Client.AUTH_METHOD to use
        user - the user name
        password - the password
        Returns:
        True if successfully completed, false if not.
        Throws:
        java.io.IOException - If an I/O error occurs while either sending a command to the server or receiving a reply from the server.
        java.security.NoSuchAlgorithmException - If the CRAM hash algorithm cannot be instantiated by the Java runtime system.
        java.security.InvalidKeyException - If the CRAM hash algorithm failed to use the given password.
        java.security.spec.InvalidKeySpecException - If the CRAM hash algorithm failed to use the given password.
      • convertToHexString

        private java.lang.String convertToHexString​(byte[] a)
        Converts the given byte array to a String containing the hexadecimal values of the bytes. For example, the byte 'A' will be converted to '41', because this is the ASCII code (and the byte value) of the capital letter 'A'.
        Parameters:
        a - The byte array to convert.
        Returns:
        The resulting String of hexadecimal codes.