| java.lang.Object
 org.apache.geronimo.mail.ProtocolGBean
org.apache.geronimo.mail.IMAPStoreGBean
| IMAPStoreGBean | | public class IMAPStoreGBean extends ProtocolGBean (Code) | | A GBean that provides for the configuration of a JavaMail IMAP message store
protocol.
IMAP store properties that are common to all IMAP 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.
version:
$Rev: 594563 $ $Date: 2007-11-13 07:28:52 -0800 (Tue, 13 Nov 2007) $
See Also: MailGBean |
| Constructor Summary | |
| public | IMAPStoreGBean(String objectName, Properties properties, String host, String user, Integer port, Boolean partialFetch, Integer fetchSize, Integer connectionTimeout, Integer timeout, Integer statusCacheTimeout, Integer appendBufferSize, Integer connectionPoolSize, Integer connectionPoolTimeout, Boolean separateStoreConnection, Boolean allowReadOnlySelect, Boolean authLoginDisable, Boolean authPlainDisable, Boolean startTLSEnable, String localaddress, Integer localport, Boolean saslEnable, String saslMechanisms, String saslAuthorizationId, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)
Construct an instance of IMAPStoreGBean
Values that are set in the individual member variables will override any of
the corresponding values that have been set in the properties set. |
| Method Summary | |
| public void | addOverrides(Properties props)
Add the overrides from the member variables to the properties file. | | public void | doFail()
| | public void | doStart()
| | public void | doStop()
| | public Boolean | getAllowReadOnlySelect()
Returns the flag to indicate whether SELECT commands are read-only.
If false, attempts to open a folder read/write will fail if the SELECT
command succeeds but indicates that the folder is READ-ONLY. | | public Integer | getAppendBufferSize()
Returns the maximum size of a message to buffer in memory when appending
to an IMAP folder.
Maximum size of a message to buffer in memory when appending to an IMAP
folder. | | public Boolean | getAuthLoginDisable()
Returns the flag that prevents use of the non-standard AUTHENTICATE LOGIN
command, instead using the plain LOGIN command. | | public Boolean | getAuthPlainDisable()
Returns the flag that prevents use of the AUTHENTICATE PLAIN command. | | public Integer | getConnectionPoolSize()
Returns the maximum number of available connections in the connection pool. | | public Integer | getConnectionPoolTimeout()
Returns the timeout value in milliseconds for connection pool connections. | | public Integer | getConnectionTimeout()
Returns the socket connection timeout value in milliseconds. | | public Integer | getFetchSize()
Returns the partial fetch size in bytes. | | public static GBeanInfo | getGBeanInfo()
| | public String | getLocaladdress()
Returns the local address (host name) to bind to when creating the IMAP socket. | | public Integer | getLocalport()
Returns the local port number to bind to when creating the IMAP socket. | | public Boolean | getPartialFetch()
Returns whether the IMAP partial-fetch capability should be used. | | public Integer | getPort()
Returns the IMAP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public String | getSaslAuthorizationId()
Returns the authorization ID to use in the SASL authentication. | | public Boolean | getSaslEnable()
Returns the flag that enables an attempt to use the javax.security.sasl
package to choose an authentication mechanism for login. | | public String | getSaslMechanisms()
Returns a space or comma separated list of SASL mechanism names to try to use. | | public Boolean | getSeparateStoreConnection()
Returns the flag to indicate whether to use a dedicated store
connection for store commands.
Flag to indicate whether to use a dedicated store connection
for store commands. | | public String | getSocketFactoryClass()
Returns the class that will be used to create IMAP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | public Boolean | getSocketFactoryFallback()
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. | | 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. | | public Boolean | getStartTLSEnable()
Returns the flag that enables the use of the STARTTLS command (if
supported by the server) to switch the connection to a TLS-protected
connection before issuing any login commands.
If true, enables the use of the STARTTLS command (if supported by the
server) to switch the connection to a TLS-protected connection before
issuing any login commands. | | public Integer | getStatusCacheTimeout()
Returns the timeout value in milliseconds for cache of STATUS command response.
Timeout value in milliseconds for cache of STATUS command response.
Default is 1000 (1 second). | | public Integer | getTimeout()
Returns the socket I/O timeout value in milliseconds. | | public void | setAllowReadOnlySelect(Boolean allowReadOnlySelect)
Sets the flag to indicate whether SELECT commands are read-only.
If false, attempts to open a folder read/write will fail if the SELECT
command succeeds but indicates that the folder is READ-ONLY. | | public void | setAppendBufferSize(Integer appendBufferSize)
Sets the maximum size of a message to buffer in memory when appending
to an IMAP folder.
Maximum size of a message to buffer in memory when appending to an IMAP
folder. | | public void | setAuthLoginDisable(Boolean authLoginDisable)
Sets the flag that prevents use of the non-standard AUTHENTICATE LOGIN
command, instead using the plain LOGIN command. | | public void | setAuthPlainDisable(Boolean authPlainDisable)
Sets the flag that prevents use of the AUTHENTICATE PLAIN command. | | public void | setConnectionPoolSize(Integer connectionPoolSize)
Sets the maximum number of available connections in the connection pool. | | public void | setConnectionPoolTimeout(Integer connectionPoolTimeout)
Sets the timeout value in milliseconds for connection pool connections
Default is 45000 (45 seconds). | | public void | setConnectionTimeout(Integer connectionTimeout)
Sets the socket connection timeout value in milliseconds. | | public void | setFetchSize(Integer fetchSize)
Sets the partial fetch size in bytes
Defaults to 16K. | | public void | setLocaladdress(String localaddress)
Sets the local address (host name) to bind to when creating the IMAP socket.
Local address (host name) to bind to when creating the IMAP socket.
Defaults to the address picked by the Socket class. | | public void | setLocalport(Integer localport)
Sets the local port number to bind to when creating the IMAP socket.
Local port number to bind to when creating the IMAP socket. | | public void | setPartialFetch(Boolean partialFetch)
Sets whether the IMAP partial-fetch capability should be used. | | public void | setPort(Integer port)
Sets the IMAP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public void | setSaslAuthorizationId(String saslAuthorizationId)
Sets the authorization ID to use in the SASL authentication. | | public void | setSaslEnable(Boolean saslEnable)
Sets the flag that enables an attempt to use the javax.security.sasl
package to choose an authentication mechanism for login. | | public void | setSaslMechanisms(String saslMechanisms)
Sets a space or comma separated list of SASL mechanism names to try to use. | | public void | setSeparateStoreConnection(Boolean separateStoreConnection)
Sets the flag to indicate whether to use a dedicated store
connection for store commands
Flag to indicate whether to use a dedicated store connection
for store commands. | | public void | setSocketFactoryClass(String socketFactoryClass)
Sets the class that will be used to create SMTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | 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. | | 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. | | public void | setStartTLSEnable(Boolean startTLSEnable)
Sets the flag that enables the use of the STARTTLS command (if
supported by the server) to switch the connection to a TLS-protected
connection before issuing any login commands.
If true, enables the use of the STARTTLS command (if supported by the
server) to switch the connection to a TLS-protected connection before
issuing any login commands. | | public void | setStatusCacheTimeout(Integer statusCacheTimeout)
Sets the timeout value in milliseconds for cache of STATUS command response
Timeout value in milliseconds for cache of STATUS command response.
Default is 1000 (1 second). | | public void | setTimeout(Integer timeout)
Sets the socket I/O timeout value in milliseconds. |
| GBEAN_APPEND_SIZE | | final public static String GBEAN_APPEND_SIZE(Code) | | |
| GBEAN_FETCH_SIZE | | final public static String GBEAN_FETCH_SIZE(Code) | | |
| GBEAN_INFO | | final public static GBeanInfo GBEAN_INFO(Code) | | |
| GBEAN_LOGIN_DISABLE | | final public static String GBEAN_LOGIN_DISABLE(Code) | | |
| GBEAN_PARTIAL_FETCH | | final public static String GBEAN_PARTIAL_FETCH(Code) | | |
| GBEAN_PLAIN_DISABLE | | final public static String GBEAN_PLAIN_DISABLE(Code) | | |
| GBEAN_POOL_SIZE | | final public static String GBEAN_POOL_SIZE(Code) | | |
| GBEAN_POOL_TIMEOUT | | final public static String GBEAN_POOL_TIMEOUT(Code) | | |
| GBEAN_READONLY_SELECT | | final public static String GBEAN_READONLY_SELECT(Code) | | |
| GBEAN_SASL_AUTHORIZATIONID | | final public static String GBEAN_SASL_AUTHORIZATIONID(Code) | | |
| GBEAN_SASL_ENABLE | | final public static String GBEAN_SASL_ENABLE(Code) | | |
| GBEAN_SASL_MECHANISMS | | final public static String GBEAN_SASL_MECHANISMS(Code) | | |
| GBEAN_SEPARATE_STORE_CONNECTION | | final public static String GBEAN_SEPARATE_STORE_CONNECTION(Code) | | |
| GBEAN_STARTTLS_ENABLE | | final public static String GBEAN_STARTTLS_ENABLE(Code) | | |
| GBEAN_STATUS_TIMEOUT | | final public static String GBEAN_STATUS_TIMEOUT(Code) | | |
| IMAP_APPEND_SIZE | | final public static String IMAP_APPEND_SIZE(Code) | | |
| IMAP_CONNECTION_TIMEOUT | | final public static String IMAP_CONNECTION_TIMEOUT(Code) | | |
| IMAP_FACTORY_CLASS | | final public static String IMAP_FACTORY_CLASS(Code) | | |
| IMAP_FACTORY_FALLBACK | | final public static String IMAP_FACTORY_FALLBACK(Code) | | |
| IMAP_FACTORY_PORT | | final public static String IMAP_FACTORY_PORT(Code) | | |
| IMAP_FETCH_SIZE | | final public static String IMAP_FETCH_SIZE(Code) | | |
| IMAP_LOCALADDRESS | | final public static String IMAP_LOCALADDRESS(Code) | | |
| IMAP_LOCALHOST | | final public static String IMAP_LOCALHOST(Code) | | |
| IMAP_LOCALPORT | | final public static String IMAP_LOCALPORT(Code) | | |
| IMAP_LOGIN_DISABLE | | final public static String IMAP_LOGIN_DISABLE(Code) | | |
| IMAP_PARTIAL_FETCH | | final public static String IMAP_PARTIAL_FETCH(Code) | | |
| IMAP_PLAIN_DISABLE | | final public static String IMAP_PLAIN_DISABLE(Code) | | |
| IMAP_POOL_SIZE | | final public static String IMAP_POOL_SIZE(Code) | | |
| IMAP_POOL_TIMEOUT | | final public static String IMAP_POOL_TIMEOUT(Code) | | |
| IMAP_READONLY_SELECT | | final public static String IMAP_READONLY_SELECT(Code) | | |
| IMAP_SASL_AUTHORIZATIONID | | final public static String IMAP_SASL_AUTHORIZATIONID(Code) | | |
| IMAP_SASL_ENABLE | | final public static String IMAP_SASL_ENABLE(Code) | | |
| IMAP_SASL_MECHANISMS | | final public static String IMAP_SASL_MECHANISMS(Code) | | |
| IMAP_SEPARATE_STORE_CONNECTION | | final public static String IMAP_SEPARATE_STORE_CONNECTION(Code) | | |
| IMAP_STARTTLS_ENABLE | | final public static String IMAP_STARTTLS_ENABLE(Code) | | |
| IMAP_STATUS_TIMEOUT | | final public static String IMAP_STATUS_TIMEOUT(Code) | | |
| IMAPStoreGBean | | public IMAPStoreGBean(String objectName, Properties properties, String host, String user, Integer port, Boolean partialFetch, Integer fetchSize, Integer connectionTimeout, Integer timeout, Integer statusCacheTimeout, Integer appendBufferSize, Integer connectionPoolSize, Integer connectionPoolTimeout, Boolean separateStoreConnection, Boolean allowReadOnlySelect, Boolean authLoginDisable, Boolean authPlainDisable, Boolean startTLSEnable, String localaddress, Integer localport, Boolean saslEnable, String saslMechanisms, String saslAuthorizationId, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)(Code) | | Construct an instance of IMAPStoreGBean
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
Parameters:
properties - the set of default properties for the protocol
Parameters:
host - the host the protocol connects to
Parameters:
user - the default name for the protocol
Parameters:
port - the IMAP server port
Parameters:
partialFetch - whether the IMAP partial-fetch capability should be used
Parameters:
fetchSize - the partial fetch size in bytes
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds
Parameters:
timeout - the socket I/O timeout value in milliseconds
Parameters:
statusCacheTimeout - the timeout value in milliseconds for cache of STATUS command response
Parameters:
appendBufferSize - the maximum size of a message to buffer in memory when appending to an IMAP folder
Parameters:
connectionPoolSize - the maximum number of available connections in the connection pool
Parameters:
connectionPoolTimeout - the timeout value in milliseconds for connection pool connections
Parameters:
separateStoreConnection - the flag to indicate whether to use a dedicated store connection for store commands
Parameters:
allowReadOnlySelect - the flag to indicate whether SELECT commands are read-only
Parameters:
authLoginDisable - the flag that prevents use of the non-standard AUTHENTICATE LOGIN command, instead using the plain LOGIN command
Parameters:
authPlainDisable - the flag that prevents use of the AUTHENTICATE PLAIN command
Parameters:
startTLSEnable - the flag that enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands
Parameters:
localaddress - the local address (host name) to bind to when creating the IMAP socket
Parameters:
localport - the local port number to bind to when creating the IMAP socket
Parameters:
saslEnable - the flag that enables an attempt to use the javax.security.sasl package to choose an authentication mechanism for login
Parameters:
saslMechanisms - a space or comma separated list of SASL mechanism names to try to use
Parameters:
saslAuthorizationId - the authorization ID to use in the SASL authentication
Parameters:
socketFactoryClass - the class that will be used to create IMAP sockets
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created
Parameters:
socketFactoryPort - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| addOverrides | | public void addOverrides(Properties props)(Code) | | Add the overrides from the member variables to the properties file.
|
| doFail | | public void doFail()(Code) | | |
| getAllowReadOnlySelect | | public Boolean getAllowReadOnlySelect()(Code) | | Returns the flag to indicate whether SELECT commands are read-only.
If false, attempts to open a folder read/write will fail if the SELECT
command succeeds but indicates that the folder is READ-ONLY. This
sometimes indicates that the folder contents can'tbe changed, but the
flags are per-user and can be changed, such as might be the case for
public shared folders. If true, such open attempts will succeed, allowing
the flags to be changed. The getMode method on the Folder object will
return Folder.READ_ONLY in this case even though the open method specified
Folder.READ_WRITE. Default is false.
|
| getAppendBufferSize | | public Integer getAppendBufferSize()(Code) | | Returns the maximum size of a message to buffer in memory when appending
to an IMAP folder.
Maximum size of a message to buffer in memory when appending to an IMAP
folder. If not set, or set to -1, there is no maximum and all messages
are buffered. If set to 0, no messages are buffered. If set to (e.g.)
8192, messages of 8K bytes or less are buffered, larger messages are not
buffered. Buffering saves cpu time at the expense of short term memory
usage. If you commonly append very large messages to IMAP mailboxes you
might want to set this to a moderate value (1M or less).
|
| getAuthLoginDisable | | public Boolean getAuthLoginDisable()(Code) | | Returns the flag that prevents use of the non-standard AUTHENTICATE LOGIN
command, instead using the plain LOGIN command.
Default is false.
|
| getAuthPlainDisable | | public Boolean getAuthPlainDisable()(Code) | | Returns the flag that prevents use of the AUTHENTICATE PLAIN command.
Default is false.
|
| getConnectionPoolSize | | public Integer getConnectionPoolSize()(Code) | | Returns the maximum number of available connections in the connection pool.
Default is 1.
|
| getConnectionPoolTimeout | | public Integer getConnectionPoolTimeout()(Code) | | Returns the timeout value in milliseconds for connection pool connections.
Default is 45000 (45 seconds).
|
| getConnectionTimeout | | public Integer getConnectionTimeout()(Code) | | Returns the socket connection timeout value in milliseconds.
|
| getFetchSize | | public Integer getFetchSize()(Code) | | Returns the partial fetch size in bytes.
Defaults to 16K.
|
| getGBeanInfo | | public static GBeanInfo getGBeanInfo()(Code) | | |
| getLocaladdress | | public String getLocaladdress()(Code) | | Returns the local address (host name) to bind to when creating the IMAP socket.
|
| getLocalport | | public Integer getLocalport()(Code) | | Returns the local port number to bind to when creating the IMAP socket.
|
| getPartialFetch | | public Boolean getPartialFetch()(Code) | | Returns whether the IMAP partial-fetch capability should be used.
Controls whether the IMAP partial-fetch capability should be used.
Defaults to true.
|
| getPort | | public Integer getPort()(Code) | | Returns the IMAP server port to connect to, if the connect() method
doesn't explicitly specify one.
|
| getSaslAuthorizationId | | public String getSaslAuthorizationId()(Code) | | Returns the authorization ID to use in the SASL authentication.
If not set, the authetication ID (user name) is used.
|
| getSaslEnable | | public Boolean getSaslEnable()(Code) | | Returns the flag that enables an attempt to use the javax.security.sasl
package to choose an authentication mechanism for login.
Defaults to false.
|
| getSaslMechanisms | | public String getSaslMechanisms()(Code) | | Returns a space or comma separated list of SASL mechanism names to try to use.
|
| getSeparateStoreConnection | | public Boolean getSeparateStoreConnection()(Code) | | Returns the flag to indicate whether to use a dedicated store
connection for store commands.
Flag to indicate whether to use a dedicated store connection
for store commands. Default is false.
|
| getSocketFactoryClass | | public String getSocketFactoryClass()(Code) | | Returns the class that will be used to create IMAP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create IMAP
sockets.
|
| getSocketFactoryFallback | | public Boolean getSocketFactoryFallback()(Code) | | 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.
|
| getSocketFactoryPort | | public Integer getSocketFactoryPort()(Code) | | 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.
|
| getStartTLSEnable | | public Boolean getStartTLSEnable()(Code) | | Returns the flag that enables the use of the STARTTLS command (if
supported by the server) to switch the connection to a TLS-protected
connection before issuing any login commands.
If true, enables the use of the STARTTLS command (if supported by the
server) to switch the connection to a TLS-protected connection before
issuing any login commands. Note that an appropriate trust store must
configured so that the client will trust the server's certificate.
This feature only works on J2SE 1.4 and newer systems. Default is false.
|
| getStatusCacheTimeout | | public Integer getStatusCacheTimeout()(Code) | | Returns the timeout value in milliseconds for cache of STATUS command response.
Timeout value in milliseconds for cache of STATUS command response.
Default is 1000 (1 second). Zero disables cache.
|
| getTimeout | | public Integer getTimeout()(Code) | | Returns the socket I/O timeout value in milliseconds.
|
| setAllowReadOnlySelect | | public void setAllowReadOnlySelect(Boolean allowReadOnlySelect)(Code) | | Sets the flag to indicate whether SELECT commands are read-only.
If false, attempts to open a folder read/write will fail if the SELECT
command succeeds but indicates that the folder is READ-ONLY. This
sometimes indicates that the folder contents can'tbe changed, but the
flags are per-user and can be changed, such as might be the case for
public shared folders. If true, such open attempts will succeed, allowing
the flags to be changed. The getMode method on the Folder object will
return Folder.READ_ONLY in this case even though the open method specified
Folder.READ_WRITE. Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
allowReadOnlySelect - the flag to indicate whether SELECT commands are read-only |
| setAppendBufferSize | | public void setAppendBufferSize(Integer appendBufferSize)(Code) | | Sets the maximum size of a message to buffer in memory when appending
to an IMAP folder.
Maximum size of a message to buffer in memory when appending to an IMAP
folder. If not set, or set to -1, there is no maximum and all messages
are buffered. If set to 0, no messages are buffered. If set to (e.g.)
8192, messages of 8K bytes or less are buffered, larger messages are not
buffered. Buffering saves cpu time at the expense of short term memory
usage. If you commonly append very large messages to IMAP mailboxes you
might want to set this to a moderate value (1M or less).
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
appendBufferSize - the maximum size of a message to buffer in memory when appendingto an IMAP folder |
| setAuthLoginDisable | | public void setAuthLoginDisable(Boolean authLoginDisable)(Code) | | Sets the flag that prevents use of the non-standard AUTHENTICATE LOGIN
command, instead using the plain LOGIN command.
Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
authLoginDisable - the flag that prevents use of the non-standard AUTHENTICATE LOGINcommand, instead using the plain LOGIN command |
| setAuthPlainDisable | | public void setAuthPlainDisable(Boolean authPlainDisable)(Code) | | Sets the flag that prevents use of the AUTHENTICATE PLAIN command.
Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
authPlainDisable - the flag that prevents use of the AUTHENTICATE PLAIN command |
| setConnectionPoolSize | | public void setConnectionPoolSize(Integer connectionPoolSize)(Code) | | Sets the maximum number of available connections in the connection pool.
Default is 1.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
connectionPoolSize - the maximum number of available connections in the connection pool |
| setConnectionPoolTimeout | | public void setConnectionPoolTimeout(Integer connectionPoolTimeout)(Code) | | Sets the timeout value in milliseconds for connection pool connections
Default is 45000 (45 seconds).
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
connectionPoolTimeout - the timeout value in milliseconds for connection pool connections |
| setConnectionTimeout | | public void setConnectionTimeout(Integer connectionTimeout)(Code) | | 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.
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds. |
| setFetchSize | | public void setFetchSize(Integer fetchSize)(Code) | | Sets the partial fetch size in bytes
Defaults to 16K.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
fetchSize - the partial fetch size in bytes |
| setLocaladdress | | public void setLocaladdress(String localaddress)(Code) | | Sets the local address (host name) to bind to when creating the IMAP socket.
Local address (host name) to bind to when creating the IMAP 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.
Parameters:
localaddress - the local address (host name) to bind to when creating the IMAP socket |
| setLocalport | | public void setLocalport(Integer localport)(Code) | | Sets the local port number to bind to when creating the IMAP socket.
Local port number to bind to when creating the IMAP 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.
Parameters:
localport - the local port number to bind to when creating the IMAP socket |
| setPartialFetch | | public void setPartialFetch(Boolean partialFetch)(Code) | | Sets whether the IMAP partial-fetch capability should be used.
Controls whether the IMAP partial-fetch capability should be used.
Defaults to true.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
partialFetch - whether the IMAP partial-fetch capability should be used |
| setPort | | public void setPort(Integer port)(Code) | | Sets the IMAP server port to connect to, if the connect() method
doesn't explicitly specify one.
Defaults to 143.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
port - the IMAP server port to connect to, if the connect() methoddoesn't explicitly specify one |
| setSaslAuthorizationId | | public void setSaslAuthorizationId(String saslAuthorizationId)(Code) | | Sets the authorization ID to use in the SASL authentication.
If not set, the authetication ID (user name) is used.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
saslAuthorizationId - the authorization ID to use in the SASL authentication |
| setSaslEnable | | public void setSaslEnable(Boolean saslEnable)(Code) | | Sets the flag that enables an attempt to use the javax.security.sasl
package to choose an authentication mechanism for login.
Defaults to false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
saslEnable - the flag that enables an attempt to use the javax.security.saslpackage to choose an authentication mechanism for login |
| setSaslMechanisms | | public void setSaslMechanisms(String saslMechanisms)(Code) | | Sets a space or comma separated list of SASL mechanism names to try to use.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
saslMechanisms - a space or comma separated list of SASL mechanism names to try to use |
| setSeparateStoreConnection | | public void setSeparateStoreConnection(Boolean separateStoreConnection)(Code) | | Sets the flag to indicate whether to use a dedicated store
connection for store commands
Flag to indicate whether to use a dedicated store connection
for store commands. Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
separateStoreConnection - the flag to indicate whether to use a dedicated storeconnection for store commands |
| setSocketFactoryClass | | public void setSocketFactoryClass(String socketFactoryClass)(Code) | | Sets the class that will be used to create SMTP sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create SMTP
sockets.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryClass - the class that will be used to create SMTP sockets |
| setSocketFactoryFallback | | public void setSocketFactoryFallback(Boolean socketFactoryFallback)(Code) | | 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.
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| setSocketFactoryPort | | public void setSocketFactoryPort(Integer socketFactoryPort)(Code) | | 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.
Parameters:
socketFactoryPort - the port to connect to when using the specified socket factory |
| setStartTLSEnable | | public void setStartTLSEnable(Boolean startTLSEnable)(Code) | | Sets the flag that enables the use of the STARTTLS command (if
supported by the server) to switch the connection to a TLS-protected
connection before issuing any login commands.
If true, enables the use of the STARTTLS command (if supported by the
server) to switch the connection to a TLS-protected connection before
issuing any login commands. Note that an appropriate trust store must
configured so that the client will trust the server's certificate.
This feature only works on J2SE 1.4 and newer systems. Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
startTLSEnable - the flag that enables the use of the STARTTLS command (ifsupported by the server) to switch the connection to a TLS-protectedconnection before issuing any login commands |
| setStatusCacheTimeout | | public void setStatusCacheTimeout(Integer statusCacheTimeout)(Code) | | Sets the timeout value in milliseconds for cache of STATUS command response
Timeout value in milliseconds for cache of STATUS command response.
Default is 1000 (1 second). Zero disables cache.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
statusCacheTimeout - the timeout value in milliseconds for cache of STATUS command response |
| setTimeout | | public void setTimeout(Integer timeout)(Code) | | 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.
Parameters:
timeout - the socket I/O timeout value in milliseconds |
|
|