| java.lang.Object
 org.apache.geronimo.mail.ProtocolGBean
org.apache.geronimo.mail.SMTPSTransportGBean
| SMTPSTransportGBean | | public class SMTPSTransportGBean extends ProtocolGBean (Code) | | A GBean that provides for the configuration of a JavaMail SMTP transport
protocol.
SMTP transport properties that are common to all SMTP transports 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 | SMTPSTransportGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, String from, String localhost, String localaddress, Integer localport, Boolean ehlo, Boolean auth, Boolean startTLSEnable, String submitter, String dsnNotify, String dsnRet, Boolean allow8bitmime, Boolean sendPartial, String saslRealm, Boolean quitWait, Boolean reportSuccess, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort, String mailExtension)
Construct an instance of SMTPSTransportGBean
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 | getAllow8bitmime()
Returns whether encodings are converted to use "8bit" under certain
conditions. | | public Boolean | getAuth()
Returns whether an attempt will be made to authenticate the user using
the AUTH command. | | public Integer | getConnectionTimeout()
Returns the socket connection timeout value in milliseconds. | | public String | getDsnNotify()
Returns the NOTIFY option to the RCPT command. | | public String | getDsnRet()
Returns the RET option to the MAIL command. | | public Boolean | getEhlo()
Returns whether an attempt will be made to sign on with the EHLO command.
If false, do not attempt to sign on with the EHLO command. | | public String | getFrom()
Returns the email address to use for SMTP MAIL command. | | public static GBeanInfo | getGBeanInfo()
| | public String | getLocaladdress()
Returns the local address (host name) to bind to when creating the SMTP socket. | | public String | getLocalhost()
Returns the local host name used in the SMTP HELO or EHLO command. | | public Integer | getLocalport()
Returns the local port number to bind to when creating the SMTP socket. | | public String | getMailExtension()
Returns the extension string to append to the MAIL command.
Extension string to append to the MAIL command. | | public Integer | getPort()
Returns the SMTP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public Boolean | getQuitWait()
Returns whether the transport will wait for the response to the QUIT command.
If set to true, causes the transport to wait for the response to the QUIT
command. | | public Boolean | getReportSuccess()
Returns whether the transport will include an SMTPAddressSucceededException
for each address that is successful. | | public String | getSaslRealm()
Returns the realm to use with DIGEST-MD5 authentication. | | public Boolean | getSendPartial()
Returns whether to send email to valid addresses when others are invalid.
If set to true, and a message has some valid and some invalid addresses,
send the message anyway, reporting the partial failure with a
SendFailedException. | | public String | getSocketFactoryClass()
Returns 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 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 String | getSubmitter()
Returns the submitter to use in the AUTH tag in the MAIL FROM command.
Typically used by a mail relay to pass along information about the
original submitter of the message. | | public Integer | getTimeout()
Returns the socket I/O timeout value in milliseconds. | | public void | setAllow8bitmime(Boolean allow8bitmime)
Sets whether encodings are converted to use "8bit" under certain
conditions. | | public void | setAuth(Boolean auth)
Sets whether an attempt will be made to authenticate the user using
the AUTH command. | | public void | setConnectionTimeout(Integer connectionTimeout)
Sets the socket connection timeout value in milliseconds. | | public void | setDsnNotify(String dsnNotify)
Sets the NOTIFY option to the RCPT command
Either NEVER, or some combination of SUCCESS, FAILURE, and DELAY
(separated by commas). | | public void | setDsnRet(String dsnRet)
Sets the RET option to the MAIL command
Either FULL or HDRS. | | public void | setEhlo(Boolean ehlo)
Set whether an attempt will be made to sign on with the EHLO command.
If false, do not attempt to sign on with the EHLO command. | | public void | setFrom(String from)
Sets the email address to use for SMTP MAIL command
Email address to use for SMTP MAIL command. | | public void | setLocaladdress(String localaddress)
Sets the local address (host name) to bind to when creating the SMTP socket.
Local address (host name) to bind to when creating the SMTP socket.
Defaults to the address picked by the Socket class. | | public void | setLocalhost(String localhost)
Sets the local host name used in the SMTP HELO or EHLO command.
Local host name used in the SMTP HELO or EHLO command. | | public void | setLocalport(Integer localport)
Sets the local port number to bind to when creating the SMTP socket.
Local port number to bind to when creating the SMTP socket. | | public void | setMailExtension(String mailExtension)
Sets the extension string to append to the MAIL command.
Extension string to append to the MAIL command. | | public void | setPort(Integer port)
Sets the SMTP server port to connect to, if the connect() method
doesn't explicitly specify one. | | public void | setQuitWait(Boolean quitWait)
Sets whether the transport will wait for the response to the QUIT command
If set to true, causes the transport to wait for the response to the QUIT
command. | | public void | setReportSuccess(Boolean reportSuccess)
Sets whether the transport will include an SMTPAddressSucceededException
for each address that is successful. | | public void | setSaslRealm(String saslRealm)
Sets the realm to use with DIGEST-MD5 authentication. | | public void | setSendPartial(Boolean sendPartial)
Sets whether to send email to valid addresses when others are invalid.
If set to true, and a message has some valid and some invalid addresses,
send the message anyway, reporting the partial failure with a
SendFailedException. | | 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 | setSubmitter(String submitter)
Sets the submitter to use in the AUTH tag in the MAIL FROM command.
Typically used by a mail relay to pass along information about the
original submitter of the message. | | public void | setTimeout(Integer timeout)
Sets the socket I/O timeout value in milliseconds. |
| GBEAN_8BITMIME | | final public static String GBEAN_8BITMIME(Code) | | |
| GBEAN_DSN_NOTIFY | | final public static String GBEAN_DSN_NOTIFY(Code) | | |
| GBEAN_INFO | | final public static GBeanInfo GBEAN_INFO(Code) | | |
| GBEAN_MAIL_EXTENSION | | final public static String GBEAN_MAIL_EXTENSION(Code) | | |
| GBEAN_REPORT_SUCCESS | | final public static String GBEAN_REPORT_SUCCESS(Code) | | |
| GBEAN_SEND_PARTIAL | | final public static String GBEAN_SEND_PARTIAL(Code) | | |
| GBEAN_STARTTLS_ENABLE | | final public static String GBEAN_STARTTLS_ENABLE(Code) | | |
| GBEAN_SUBMITTER | | final public static String GBEAN_SUBMITTER(Code) | | |
| SMTPS_8BITMIME | | final public static String SMTPS_8BITMIME(Code) | | |
| SMTPS_CONNECTION_TIMEOUT | | final public static String SMTPS_CONNECTION_TIMEOUT(Code) | | |
| SMTPS_DSN_NOTIFY | | final public static String SMTPS_DSN_NOTIFY(Code) | | |
| SMTPS_FACTORY_CLASS | | final public static String SMTPS_FACTORY_CLASS(Code) | | |
| SMTPS_FACTORY_FALLBACK | | final public static String SMTPS_FACTORY_FALLBACK(Code) | | |
| SMTPS_FACTORY_PORT | | final public static String SMTPS_FACTORY_PORT(Code) | | |
| SMTPS_LOCALADDRESS | | final public static String SMTPS_LOCALADDRESS(Code) | | |
| SMTPS_LOCALHOST | | final public static String SMTPS_LOCALHOST(Code) | | |
| SMTPS_LOCALPORT | | final public static String SMTPS_LOCALPORT(Code) | | |
| SMTPS_MAIL_EXTENSION | | final public static String SMTPS_MAIL_EXTENSION(Code) | | |
| SMTPS_QUITWAIT | | final public static String SMTPS_QUITWAIT(Code) | | |
| SMTPS_REPORT_SUCCESS | | final public static String SMTPS_REPORT_SUCCESS(Code) | | |
| SMTPS_SEND_PARTIAL | | final public static String SMTPS_SEND_PARTIAL(Code) | | |
| SMTPS_STARTTLS_ENABLE | | final public static String SMTPS_STARTTLS_ENABLE(Code) | | |
| SMTPS_SUBMITTER | | final public static String SMTPS_SUBMITTER(Code) | | |
| SMTPSTransportGBean | | public SMTPSTransportGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, String from, String localhost, String localaddress, Integer localport, Boolean ehlo, Boolean auth, Boolean startTLSEnable, String submitter, String dsnNotify, String dsnRet, Boolean allow8bitmime, Boolean sendPartial, String saslRealm, Boolean quitWait, Boolean reportSuccess, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort, String mailExtension)(Code) | | Construct an instance of SMTPSTransportGBean
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 SMTPS server port
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds
Parameters:
timeout - the socket I/O timeout value in milliseconds
Parameters:
from - the email address to use for SMTPS MAIL command
Parameters:
localhost - the local host name used in the SMTPS HELO or EHLO command
Parameters:
localaddress - the local address (host name) to bind to when creating the SMTPS socket
Parameters:
localport - the local port number to bind to when creating the SMTPS socket
Parameters:
ehlo - whether an attempt will be made to sign on with the EHLO command
Parameters:
auth - whether an attempt will be made to authenticate the user usingthe AUTH 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:
submitter - the submitter to use in the AUTH tag in the MAIL FROM command
Parameters:
dsnNotify - the NOTIFY option to the RCPT command
Parameters:
dsnRet - the RET option to the MAIL command
Parameters:
allow8bitmime - whether encodings are converted to use "8bit" under certainconditions
Parameters:
sendPartial - whether to send email to valid addresses when others are invalid
Parameters:
saslRealm - the realm to use with DIGEST-MD5 authentication
Parameters:
quitWait - whether the transport will wait for the response to the QUIT command
Parameters:
reportSuccess - whether the transport will include an SMTPAddressSucceededExceptionfor each address that is successful
Parameters:
socketFactoryClass - the class that will be used to create SMTPS 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
Parameters:
mailExtension - the extension string to append to the MAIL command |
| addOverrides | | public void addOverrides(Properties props)(Code) | | Add the overrides from the member variables to the properties file.
|
| doFail | | public void doFail()(Code) | | |
| getAllow8bitmime | | public Boolean getAllow8bitmime()(Code) | | Returns whether encodings are converted to use "8bit" under certain
conditions.
If set to true, and the server supports the 8BITMIME extension, text
parts of messages that use the "quoted-printable" or "base64" encodings
are converted to use "8bit" encoding if they follow the RFC2045 rules
for 8bit text.
|
| getAuth | | public Boolean getAuth()(Code) | | Returns whether an attempt will be made to authenticate the user using
the AUTH command.
Defaults to false.
|
| getConnectionTimeout | | public Integer getConnectionTimeout()(Code) | | Returns the socket connection timeout value in milliseconds.
|
| getDsnNotify | | public String getDsnNotify()(Code) | | Returns the NOTIFY option to the RCPT command.
Either NEVER, or some combination of SUCCESS, FAILURE, and DELAY
(separated by commas).
|
| getDsnRet | | public String getDsnRet()(Code) | | Returns the RET option to the MAIL command.
Either FULL or HDRS.
|
| getEhlo | | public Boolean getEhlo()(Code) | | Returns whether an attempt will be made to sign on with the EHLO command.
If false, do not attempt to sign on with the EHLO command. Normally
failure of the EHLO command will fallback to the HELO command; this
property exists only for servers that don't fail EHLO properly or don't
implement EHLO properly.
|
| getFrom | | public String getFrom()(Code) | | Returns the email address to use for SMTP MAIL command.
|
| getGBeanInfo | | public static GBeanInfo getGBeanInfo()(Code) | | |
| getLocaladdress | | public String getLocaladdress()(Code) | | Returns the local address (host name) to bind to when creating the SMTP socket.
|
| getLocalhost | | public String getLocalhost()(Code) | | Returns the local host name used in the SMTP HELO or EHLO command.
|
| getLocalport | | public Integer getLocalport()(Code) | | Returns the local port number to bind to when creating the SMTP socket.
|
| getMailExtension | | public String getMailExtension()(Code) | | Returns the extension string to append to the MAIL command.
Extension string to append to the MAIL command. The extension string
can be used to specify standard SMTP service extensions as well as
vendor-specific extensions. Typically the application should use the
SMTPTransport method supportsExtension to verify that the server
supports the desired service extension. See RFC 1869 and other RFCs
that define specific extensions.
|
| getPort | | public Integer getPort()(Code) | | Returns the SMTP server port to connect to, if the connect() method
doesn't explicitly specify one.
|
| getQuitWait | | public Boolean getQuitWait()(Code) | | Returns whether the transport will wait for the response to the QUIT command.
If set to true, causes the transport to wait for the response to the QUIT
command. If set to false (the default), the QUIT command is sent and the
connection is immediately closed.
|
| getReportSuccess | | public Boolean getReportSuccess()(Code) | | Returns whether the transport will include an SMTPAddressSucceededException
for each address that is successful.
Note also that this will cause a SendFailedException to be thrown from
the sendMessage method of SMTPTransport even if all addresses were
correct and the message was sent successfully.
|
| getSaslRealm | | public String getSaslRealm()(Code) | | Returns the realm to use with DIGEST-MD5 authentication.
|
| getSendPartial | | public Boolean getSendPartial()(Code) | | Returns whether to send email to valid addresses when others are invalid.
If set to true, and a message has some valid and some invalid addresses,
send the message anyway, reporting the partial failure with a
SendFailedException. If set to false (the default), the message is not
sent to any of the recipients if there is an invalid recipient address.
|
| getSocketFactoryClass | | public String getSocketFactoryClass()(Code) | | Returns 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.
|
| 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.
|
| getSubmitter | | public String getSubmitter()(Code) | | Returns the submitter to use in the AUTH tag in the MAIL FROM command.
Typically used by a mail relay to pass along information about the
original submitter of the message. See also the setSubmitter method of
SMTPMessage. Mail clients typically do not use this.
|
| getTimeout | | public Integer getTimeout()(Code) | | Returns the socket I/O timeout value in milliseconds.
|
| setAllow8bitmime | | public void setAllow8bitmime(Boolean allow8bitmime)(Code) | | Sets whether encodings are converted to use "8bit" under certain
conditions.
If set to true, and the server supports the 8BITMIME extension, text
parts of messages that use the "quoted-printable" or "base64" encodings
are converted to use "8bit" encoding if they follow the RFC2045 rules
for 8bit text.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
allow8bitmime - whether encodings are converted to use "8bit" under certainconditions |
| setAuth | | public void setAuth(Boolean auth)(Code) | | Sets whether an attempt will be made to authenticate the user using
the AUTH command.
Defaults to false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
auth - whether an attempt will be made to authenticate the user usingthe AUTH command. |
| 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. |
| setDsnNotify | | public void setDsnNotify(String dsnNotify)(Code) | | Sets the NOTIFY option to the RCPT command
Either NEVER, or some combination of SUCCESS, FAILURE, and DELAY
(separated by commas).
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
dsnNotify - the NOTIFY option to the RCPT command |
| setDsnRet | | public void setDsnRet(String dsnRet)(Code) | | Sets the RET option to the MAIL command
Either FULL or HDRS.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
dsnRet - the RET option to the MAIL command |
| setEhlo | | public void setEhlo(Boolean ehlo)(Code) | | Set whether an attempt will be made to sign on with the EHLO command.
If false, do not attempt to sign on with the EHLO command. Normally
failure of the EHLO command will fallback to the HELO command; this
property exists only for servers that don't fail EHLO properly or don't
implement EHLO properly.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
ehlo - whether an attempt will be made to sign on with the EHLO command |
| setFrom | | public void setFrom(String from)(Code) | | Sets the email address to use for SMTP MAIL command
Email address to use for SMTP MAIL command. This sets the envelope
return address. Defaults to msg.getFrom() or InternetAddress.getLocalAddress().
NOTE: mail.smtps.user was previously used for this.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
from - the email address to use for SMTP MAIL command |
| setLocaladdress | | public void setLocaladdress(String localaddress)(Code) | | Sets the local address (host name) to bind to when creating the SMTP socket.
Local address (host name) to bind to when creating the SMTP 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 SMTP socket |
| setLocalhost | | public void setLocalhost(String localhost)(Code) | | Sets the local host name used in the SMTP HELO or EHLO command.
Local host name used in the SMTP HELO or EHLO command. Defaults to
InetAddress.getLocalHost().getHostName(). Should not normally need to
be set if your JDK and your name service are configured properly.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
localhost - the local host name used in the SMTP HELO or EHLO command |
| setLocalport | | public void setLocalport(Integer localport)(Code) | | Sets the local port number to bind to when creating the SMTP socket.
Local port number to bind to when creating the SMTP 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 SMTP socket |
| setMailExtension | | public void setMailExtension(String mailExtension)(Code) | | Sets the extension string to append to the MAIL command.
Extension string to append to the MAIL command. The extension string
can be used to specify standard SMTP service extensions as well as
vendor-specific extensions. Typically the application should use the
SMTPTransport method supportsExtension to verify that the server
supports the desired service extension. See RFC 1869 and other RFCs
that define specific extensions.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
mailExtension - the extension string to append to the MAIL command |
| setPort | | public void setPort(Integer port)(Code) | | Sets the SMTP server port to connect to, if the connect() method
doesn't explicitly specify one.
Defaults to 25.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
port - the SMTP server port to connect to |
| setQuitWait | | public void setQuitWait(Boolean quitWait)(Code) | | Sets whether the transport will wait for the response to the QUIT command
If set to true, causes the transport to wait for the response to the QUIT
command. If set to false (the default), the QUIT command is sent and the
connection is immediately closed.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
quitWait - whether the transport will wait for the response to the QUIT command |
| setReportSuccess | | public void setReportSuccess(Boolean reportSuccess)(Code) | | Sets whether the transport will include an SMTPAddressSucceededException
for each address that is successful.
Note also that this will cause a SendFailedException to be thrown from
the sendMessage method of SMTPTransport even if all addresses were
correct and the message was sent successfully.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
reportSuccess - whether the transport will include an SMTPAddressSucceededExceptionfor each address that is successful |
| setSaslRealm | | public void setSaslRealm(String saslRealm)(Code) | | Sets the realm to use with DIGEST-MD5 authentication.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
saslRealm - the realm to use with DIGEST-MD5 authentication |
| setSendPartial | | public void setSendPartial(Boolean sendPartial)(Code) | | Sets whether to send email to valid addresses when others are invalid.
If set to true, and a message has some valid and some invalid addresses,
send the message anyway, reporting the partial failure with a
SendFailedException. If set to false (the default), the message is not
sent to any of the recipients if there is an invalid recipient address.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
sendPartial - whether to send email to valid addresses when others are invalid |
| 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 |
| setSubmitter | | public void setSubmitter(String submitter)(Code) | | Sets the submitter to use in the AUTH tag in the MAIL FROM command.
Typically used by a mail relay to pass along information about the
original submitter of the message. See also the setSubmitter method of
SMTPMessage. Mail clients typically do not use this.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
submitter - the submitter to use in the AUTH tag in the MAIL FROM command |
| 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 |
|
|