Home » geronimo-2.2-source-release » org.apache.geronimo.mail » [javadoc | source]
org.apache.geronimo.mail
public class: POP3StoreGBean [javadoc | source]
java.lang.Object
   org.apache.geronimo.mail.ProtocolGBean
      org.apache.geronimo.mail.POP3StoreGBean

All Implemented Interfaces:
    GBeanLifecycle

A GBean that provides for the configuration of a JavaMail POP3 message store protocol.

POP3 store properties that are common to all POP3 stores are provided via member variables of this class. Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

Field Summary
public static final  String POP3_PORT     
public static final  String POP3_CONNECTION_TIMEOUT     
public static final  String POP3_TIMEOUT     
public static final  String POP3_FACTORY_CLASS     
public static final  String POP3_FACTORY_FALLBACK     
public static final  String POP3_FACTORY_PORT     
public static final  String POP3_LOCALHOST     
public static final  String POP3_LOCALADDRESS     
public static final  String POP3_LOCALPORT     
public static final  String POP3_RESET     
public static final  String POP3_MESSAGE_CLASS     
public static final  String POP3_APOP     
public static final  String GBEAN_RESET     
public static final  String GBEAN_APOP     
public static final  String GBEAN_MESSAGE_CLASS     
public static final  GBeanInfo GBEAN_INFO     
Fields inherited from org.apache.geronimo.mail.ProtocolGBean:
GBEAN_OBJECTNAME,  GBEAN_PROTOCOL,  GBEAN_PROPERTIES,  GBEAN_HOST,  GBEAN_USER,  GBEAN_ADD_OVERRIDES,  GBEAN_PORT,  GBEAN_CONNECTION_TIMEOUT,  GBEAN_TIMEOUT,  GBEAN_FROM,  GBEAN_AUTH,  GBEAN_REALM,  GBEAN_QUITWAIT,  GBEAN_FACTORY_CLASS,  GBEAN_FACTORY_FALLBACK,  GBEAN_FACTORY_PORT,  GBEAN_LOCALHOST,  GBEAN_LOCALADDRESS,  GBEAN_LOCALPORT,  GBEAN_INFO
Constructor:
 public POP3StoreGBean(String objectName,
    Properties properties,
    String host,
    String user,
    Integer port,
    Integer connectionTimeout,
    Integer timeout,
    Boolean rsetBeforeQuit,
    String messageClass,
    String localaddress,
    Integer localport,
    Boolean apopEnable,
    String socketFactoryClass,
    Boolean socketFactoryFallback,
    Integer socketFactoryPort) 
    Construct an instance of POP3StoreGBean

    Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

    Parameters:
    objectName - the object name of the protocol
    properties - the set of default properties for the protocol
    host - the host the protocol connects to
    user - the default name for the protocol
    port - the POP3 server port
    connectionTimeout - the socket connection timeout value in milliseconds
    timeout - the socket I/O timeout value in milliseconds
    rsetBeforeQuit - whether an attempt will be made send a POP3 RSET command when closing the folder, before sending the QUIT command
    messageClass - the class name of a subclass of com.sun.mail.pop3.POP3Message
    localaddress - the local address (host name) to bind to when creating the POP3 socket
    localport - the local port number to bind to when creating the POP3 socket
    apopEnable - whether to use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP
    socketFactoryClass - the class that will be used to create POP3 sockets
    socketFactoryFallback - whether java.net.Socket class will be created if the specified socket factory class cannot be created
    socketFactoryPort - whether java.net.Socket class will be created if the specified socket factory class cannot be created
Method from org.apache.geronimo.mail.POP3StoreGBean Summary:
addOverrides,   doFail,   doStart,   doStop,   getConnectionTimeout,   getGBeanInfo,   getLocaladdress,   getLocalport,   getMessageClass,   getPort,   getRsetBeforeQuit,   getSocketFactoryClass,   getSocketFactoryPort,   getTimeout,   isApopEnable,   isSocketFactoryFallback,   setApopEnable,   setConnectionTimeout,   setLocaladdress,   setLocalport,   setMessageClass,   setPort,   setRsetBeforeQuit,   setSocketFactoryClass,   setSocketFactoryFallback,   setSocketFactoryPort,   setTimeout
Methods from org.apache.geronimo.mail.ProtocolGBean:
addOverrides,   doFail,   doStart,   doStop,   getGBeanInfo,   getHost,   getObjectName,   getProperties,   getProtocol,   getUser,   setHost,   setProperties,   setUser
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.geronimo.mail.POP3StoreGBean Detail:
 public  void addOverrides(Properties props) 
    Add the overrides from the member variables to the properties file.
 public  void doFail() 
 public  void doStart() throws Exception 
 public  void doStop() throws Exception 
 public Integer getConnectionTimeout() 
    Returns the socket connection timeout value in milliseconds.
 public static GBeanInfo getGBeanInfo() 
 public String getLocaladdress() 
    Returns the local address (host name) to bind to when creating the POP3 socket.
 public Integer getLocalport() 
    Returns the local port number to bind to when creating the POP3 socket.
 public String getMessageClass() 
    Returns the class name of a subclass of com.sun.mail.pop3.POP3Message.

    Class name of a subclass of com.sun.mail.pop3.POP3Message. The subclass can be used to handle (for example) non-standard Content-Type headers. The subclass must have a public constructor of the form MyPOP3Message(Folder f, int msgno) throws MessagingException.

 public Integer getPort() 
    Returns the POP3 server port to connect to, if the connect() method doesn't explicitly specify one.

    Defaults to 110.

 public Boolean getRsetBeforeQuit() 
    Returns whether an attempt will be made send a POP3 RSET command when closing the folder, before sending the QUIT command.

    Send a POP3 RSET command when closing the folder, before sending the QUIT command. Useful with POP3 servers that implicitly mark all messages that are read as "deleted"; this will prevent such messages from being deleted and expunged unless the client requests so. Default is false.

 public String getSocketFactoryClass() 
    Returns the class that will be used to create POP3 sockets.

    If set, specifies the name of a class that implements the javax.net.SocketFactory interface. This class will be used to create POP3 sockets.

 public Integer getSocketFactoryPort() 
    Returns the port to connect to when using the specified socket factory.

    Specifies the port to connect to when using the specified socket factory. If not set, the default port will be used.

 public Integer getTimeout() 
    Returns the socket I/O timeout value in milliseconds.
 public Boolean isApopEnable() 
    Returns whether to use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP.

    If set to true, use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP. APOP sends a digest of the password rather than the clear text password. Defaults to false.

 public Boolean isSocketFactoryFallback() 
    Returns whether java.net.Socket class will be created if the specified socket factory class cannot be created.

    If set to true, failure to create a socket using the specified socket factory class will cause the socket to be created using the java.net.Socket class. Defaults to true.

 public  void setApopEnable(Boolean apopEnable) 
    Sets whether to use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP.

    If set to true, use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP. APOP sends a digest of the password rather than the clear text password. Defaults to false.

 public  void setConnectionTimeout(Integer connectionTimeout) 
    Sets the socket connection timeout value in milliseconds.

    Default is infinite timeout.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setLocaladdress(String localaddress) 
    Sets the local address (host name) to bind to when creating the POP3 socket.

    Local address (host name) to bind to when creating the POP3 socket. Defaults to the address picked by the Socket class. Should not normally need to be set, but useful with multi-homed hosts where it's important to pick a particular local address to bind to.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setLocalport(Integer localport) 
    Sets the local port number to bind to when creating the POP3 socket.

    Local port number to bind to when creating the POP3 socket. Defaults to the port number picked by the Socket class.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setMessageClass(String messageClass) 
    Sets the class name of a subclass of com.sun.mail.pop3.POP3Message.

    Class name of a subclass of com.sun.mail.pop3.POP3Message. The subclass can be used to handle (for example) non-standard Content-Type headers. The subclass must have a public constructor of the form MyPOP3Message(Folder f, int msgno) throws MessagingException.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setPort(Integer port) 
    Sets the POP3 server port to connect to, if the connect() method doesn't explicitly specify one.

    Defaults to 110.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setRsetBeforeQuit(Boolean rsetBeforeQuit) 
    Sets whether an attempt will be made send a POP3 RSET command when closing the folder, before sending the QUIT command.

    Send a POP3 RSET command when closing the folder, before sending the QUIT command. Useful with POP3 servers that implicitly mark all messages that are read as "deleted"; this will prevent such messages from being deleted and expunged unless the client requests so. Default is false.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setSocketFactoryClass(String socketFactoryClass) 
    Sets the class that will be used to create POP3 sockets.

    If set, specifies the name of a class that implements the javax.net.SocketFactory interface. This class will be used to create POP3 sockets.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setSocketFactoryFallback(Boolean socketFactoryFallback) 
    Sets whether java.net.Socket class will be created if the specified socket factory class cannot be created.

    If set to true, failure to create a socket using the specified socket factory class will cause the socket to be created using the java.net.Socket class. Defaults to true.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setSocketFactoryPort(Integer socketFactoryPort) 
    Sets the port to connect to when using the specified socket factory.

    Specifies the port to connect to when using the specified socket factory. If not set, the default port will be used.

    Values that are set here will override any of the corresponding value that has been set in the properties.

 public  void setTimeout(Integer timeout) 
    Sets the socket I/O timeout value in milliseconds.

    Default is infinite timeout.

    Values that are set here will override any of the corresponding value that has been set in the properties.