SMTPTransport ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- Transport
- - com.sun.mail.smtp.SMTPTransport

Direct Known Subclasses:

SMTPSSLTransport
```
public class SMTPTransport
extends Transport
```
This class implements the Transport abstract class using SMTP for message submission and transport.
See the com.sun.mail.smtp package documentation for further information on the SMTP protocol provider.
This class includes many protected methods that allow a subclass to extend this class and add support for non-standard SMTP commands. The issueCommand(java.lang.String, int) and sendCommand(java.lang.String) methods can be used to send simple SMTP commands. Other methods such as the mailFrom() and data() methods can be overridden to insert new commands before or after the corresponding SMTP commands. For example, a subclass could do this to send the XACT command before sending the DATA command:
```
        protected OutputStream data() throws MessagingException {
            if (supportsExtension("XACCOUNTING"))
                issueCommand("XACT", 25);
            return super.data();
        }
 
```
See Also:

javax.mail.event.ConnectionEvent, javax.mail.event.TransportEvent

Constructor Summary

Constructors
Constructor and Description
`SMTPTransport(Session session, URLName urlname)` Constructor that takes a Session object and a URLName that represents a specific SMTP server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the Transport and terminate the connection to the server.
`void`	`connect(java.net.Socket socket)` Start the SMTP protocol on the given socket, which was already connected by the caller.
`java.lang.String`	`getAuthorizationId()` Gets the authorization ID to be used for authentication.
`java.lang.String`	`getExtensionParameter(java.lang.String ext)` Return the parameter the server provided for the specified service extension, or null if the extension isn't supported.
`int`	`getLastReturnCode()` Return the return code from the last response we got from the server.
`java.lang.String`	`getLastServerResponse()` Return the last response we got from the server.
`java.lang.String`	`getLocalHost()` Get the name of the local host, for use in the EHLO and HELO commands.
`boolean`	`getNoopStrict()` Is the NOOP command required to return a response code of 250 to indicate success?
`java.lang.String`	`getNTLMDomain()` Gets the NTLM domain to be used for NTLM authentication.
`boolean`	`getReportSuccess()` Should we report even successful sends by throwing an exception? If so, a `SendFailedException` will always be thrown and an `SMTPAddressSucceededException` will be included in the exception chain for each successful address, along with the usual `SMTPAddressFailedException` for each unsuccessful address.
`boolean`	`getRequireStartTLS()` Should we require the STARTTLS command to secure the connection?
`boolean`	`getSASLEnabled()` Is SASL authentication enabled?
`java.lang.String[]`	`getSASLMechanisms()` Get the list of SASL mechanisms to consider if SASL authentication is enabled.
`java.lang.String`	`getSASLRealm()` Gets the SASL realm to be used for DIGEST-MD5 authentication.
`boolean`	`getStartTLS()` Should we use the STARTTLS command to secure the connection if the server supports it?
`boolean`	`getUseRset()` Should we use the RSET command instead of the NOOP command in the @{link #isConnected isConnected} method?
`boolean`	`isConnected()` Check whether the transport is connected.
`boolean`	`isSSL()` Is this Transport using SSL to connect to the server?
`void`	`issueCommand(java.lang.String cmd, int expect)` Send the command to the server.
`boolean`	`sasllogin(java.lang.String[] allowed, java.lang.String realm, java.lang.String authzid, java.lang.String u, java.lang.String p)` SASL-based login.
`void`	`sendMessage(Message message, Address[] addresses)` Send the Message to the specified list of addresses.
`void`	`setAuthorizationID(java.lang.String authzid)` Sets the authorization ID to be used for authentication.
`void`	`setLocalHost(java.lang.String localhost)` Set the name of the local host, for use in the EHLO and HELO commands.
`void`	`setNoopStrict(boolean noopStrict)` Set whether the NOOP command is required to return a response code of 250 to indicate success.
`void`	`setNTLMDomain(java.lang.String ntlmDomain)` Sets the NTLM domain to be used for NTLM authentication.
`void`	`setReportSuccess(boolean reportSuccess)` Set whether successful sends should be reported by throwing an exception.
`void`	`setRequireStartTLS(boolean requireStartTLS)` Set whether the STARTTLS command should be required.
`void`	`setSASLEnabled(boolean enableSASL)` Set whether SASL authentication is enabled.
`void`	`setSASLMechanisms(java.lang.String[] mechanisms)` Set the list of SASL mechanisms to consider if SASL authentication is enabled.
`void`	`setSASLRealm(java.lang.String saslRealm)` Sets the SASL realm to be used for DIGEST-MD5 authentication.
`void`	`setStartTLS(boolean useStartTLS)` Set whether the STARTTLS command should be used.
`void`	`setUseRset(boolean useRset)` Set whether the RSET command should be used instead of the NOOP command in the @{link #isConnected isConnected} method.
`int`	`simpleCommand(java.lang.String cmd)` Send the command to the server and return the response code from the server.
`boolean`	`supportsExtension(java.lang.String ext)` Return true if the SMTP server supports the specified service extension.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SMTPTransport
```
public SMTPTransport(Session session,
                     URLName urlname)
```
    Constructor that takes a Session object and a URLName that represents a specific SMTP server.
- Method Detail
  - getLocalHost
```
public java.lang.String getLocalHost()
```
    Get the name of the local host, for use in the EHLO and HELO commands. The property mail.smtp.localhost overrides mail.smtp.localaddress, which overrides what InetAddress would tell us.
  - setLocalHost
```
public void setLocalHost(java.lang.String localhost)
```
    Set the name of the local host, for use in the EHLO and HELO commands.
    
    Since:
    
    JavaMail 1.3.1
  - connect
```
public void connect(java.net.Socket socket)
             throws MessagingException
```
    Start the SMTP protocol on the given socket, which was already connected by the caller. Useful for implementing the SMTP ATRN command (RFC 2645) where an existing connection is used when the server reverses roles and becomes the client.
    
    Throws:
    
    MessagingException
    
    Since:
    
    JavaMail 1.3.3
  - getAuthorizationId
```
public java.lang.String getAuthorizationId()
```
    Gets the authorization ID to be used for authentication.
    
    Returns:
    
    the authorization ID to use for authentication.
    
    Since:
    
    JavaMail 1.4.4
  - setAuthorizationID
```
public void setAuthorizationID(java.lang.String authzid)
```
    Sets the authorization ID to be used for authentication.
    
    Parameters:
    
    authzid - the authorization ID to use for authentication.
    
    Since:
    
    JavaMail 1.4.4
  - getSASLEnabled
```
public boolean getSASLEnabled()
```
    Is SASL authentication enabled?
    
    Returns:
    
    true if SASL authentication is enabled
    
    Since:
    
    JavaMail 1.4.4
  - setSASLEnabled
```
public void setSASLEnabled(boolean enableSASL)
```
    Set whether SASL authentication is enabled.
    
    Parameters:
    
    enableSASL - should we enable SASL authentication?
    
    Since:
    
    JavaMail 1.4.4
  - getSASLRealm
```
public java.lang.String getSASLRealm()
```
    Gets the SASL realm to be used for DIGEST-MD5 authentication.
    
    Returns:
    
    the name of the realm to use for SASL authentication.
    
    Since:
    
    JavaMail 1.3.1
  - setSASLRealm
```
public void setSASLRealm(java.lang.String saslRealm)
```
    Sets the SASL realm to be used for DIGEST-MD5 authentication.
    
    Parameters:
    
    saslRealm - the name of the realm to use for SASL authentication.
    
    Since:
    
    JavaMail 1.3.1
  - getSASLMechanisms
```
public java.lang.String[] getSASLMechanisms()
```
    Get the list of SASL mechanisms to consider if SASL authentication is enabled. If the list is empty or null, all available SASL mechanisms are considered.
    
    Returns:
    
    the array of SASL mechanisms to consider
    
    Since:
    
    JavaMail 1.4.4
  - setSASLMechanisms
```
public void setSASLMechanisms(java.lang.String[] mechanisms)
```
    Set the list of SASL mechanisms to consider if SASL authentication is enabled. If the list is empty or null, all available SASL mechanisms are considered.
    
    Parameters:
    
    mechanisms - the array of SASL mechanisms to consider
    
    Since:
    
    JavaMail 1.4.4
  - getNTLMDomain
```
public java.lang.String getNTLMDomain()
```
    Gets the NTLM domain to be used for NTLM authentication.
    
    Returns:
    
    the name of the domain to use for NTLM authentication.
    
    Since:
    
    JavaMail 1.4.3
  - setNTLMDomain
```
public void setNTLMDomain(java.lang.String ntlmDomain)
```
    Sets the NTLM domain to be used for NTLM authentication.
    
    Parameters:
    
    ntlmDomain - the name of the domain to use for NTLM authentication.
    
    Since:
    
    JavaMail 1.4.3
  - getReportSuccess
```
public boolean getReportSuccess()
```
    Should we report even successful sends by throwing an exception? If so, a SendFailedException will always be thrown and an SMTPAddressSucceededException will be included in the exception chain for each successful address, along with the usual SMTPAddressFailedException for each unsuccessful address.
    
    Returns:
    
    true if an exception will be thrown on successful sends.
    
    Since:
    
    JavaMail 1.3.2
  - setReportSuccess
```
public void setReportSuccess(boolean reportSuccess)
```
    Set whether successful sends should be reported by throwing an exception.
    
    Parameters:
    
    reportSuccess - should we throw an exception on success?
    
    Since:
    
    JavaMail 1.3.2
  - getStartTLS
```
public boolean getStartTLS()
```
    Should we use the STARTTLS command to secure the connection if the server supports it?
    
    Returns:
    
    true if the STARTTLS command will be used
    
    Since:
    
    JavaMail 1.3.2
  - setStartTLS
```
public void setStartTLS(boolean useStartTLS)
```
    Set whether the STARTTLS command should be used.
    
    Parameters:
    
    useStartTLS - should we use the STARTTLS command?
    
    Since:
    
    JavaMail 1.3.2
  - getRequireStartTLS
```
public boolean getRequireStartTLS()
```
    Should we require the STARTTLS command to secure the connection?
    
    Returns:
    
    true if the STARTTLS command will be required
    
    Since:
    
    JavaMail 1.4.2
  - setRequireStartTLS
```
public void setRequireStartTLS(boolean requireStartTLS)
```
    Set whether the STARTTLS command should be required.
    
    Parameters:
    
    requireStartTLS - should we require the STARTTLS command?
    
    Since:
    
    JavaMail 1.4.2
  - isSSL
```
public boolean isSSL()
```
    Is this Transport using SSL to connect to the server?
    
    Returns:
    
    true if using SSL
    
    Since:
    
    JavaMail 1.4.6
  - getUseRset
```
public boolean getUseRset()
```
    Should we use the RSET command instead of the NOOP command in the @{link #isConnected isConnected} method?
    
    Returns:
    
    true if RSET will be used
    
    Since:
    
    JavaMail 1.4
  - setUseRset
```
public void setUseRset(boolean useRset)
```
    Set whether the RSET command should be used instead of the NOOP command in the @{link #isConnected isConnected} method.
    
    Parameters:
    
    useRset - should we use the RSET command?
    
    Since:
    
    JavaMail 1.4
  - getNoopStrict
```
public boolean getNoopStrict()
```
    Is the NOOP command required to return a response code of 250 to indicate success?
    
    Returns:
    
    true if NOOP must return 250
    
    Since:
    
    JavaMail 1.4.3
  - setNoopStrict
```
public void setNoopStrict(boolean noopStrict)
```
    Set whether the NOOP command is required to return a response code of 250 to indicate success.
    
    Parameters:
    
    noopStrict - is NOOP required to return 250?
    
    Since:
    
    JavaMail 1.4.3
  - getLastServerResponse
```
public java.lang.String getLastServerResponse()
```
    Return the last response we got from the server. A failed send is often followed by an RSET command, but the response from the RSET command is not saved. Instead, this returns the response from the command before the RSET command.
    
    Returns:
    
    last response from server
    
    Since:
    
    JavaMail 1.3.2
  - getLastReturnCode
```
public int getLastReturnCode()
```
    Return the return code from the last response we got from the server.
    
    Returns:
    
    return code from last response from server
    
    Since:
    
    JavaMail 1.4.1
  - sasllogin
```
public boolean sasllogin(java.lang.String[] allowed,
                         java.lang.String realm,
                         java.lang.String authzid,
                         java.lang.String u,
                         java.lang.String p)
                  throws MessagingException
```
    SASL-based login.
    
    Throws:
    
    MessagingException
  - sendMessage
```
public void sendMessage(Message message,
                        Address[] addresses)
                 throws MessagingException,
                        SendFailedException
```
    Send the Message to the specified list of addresses.
    If all the addresses succeed the SMTP check using the RCPT TO: command, we attempt to send the message. A TransportEvent of type MESSAGE_DELIVERED is fired indicating the successful submission of a message to the SMTP host.
    If some of the addresses fail the SMTP check, and the mail.stmp.sendpartial property is not set, sending is aborted. The TransportEvent of type MESSAGE_NOT_DELIVERED is fired containing the valid and invalid addresses. The SendFailedException is also thrown.
    If some of the addresses fail the SMTP check, and the mail.stmp.sendpartial property is set to true, the message is sent. The TransportEvent of type MESSAGE_PARTIALLY_DELIVERED is fired containing the valid and invalid addresses. The SMTPSendFailedException is also thrown.
    MessagingException is thrown if the message can't write out an RFC822-compliant stream using its writeTo method.
    
    Parameters:
    
    message - The MimeMessage to be sent
    
    addresses - List of addresses to send this message to
    
    Throws:
    
    SMTPSendFailedException - if the send failed because of an SMTP command error
    
    SendFailedException - if the send failed because of invalid addresses.
    
    MessagingException - if the connection is dead or not in the connected state or if the message is not a MimeMessage.
    
    See Also:
    
    javax.mail.event.TransportEvent
  - close
```
public void close()
           throws MessagingException
```
    Close the Transport and terminate the connection to the server.
    
    Throws:
    
    MessagingException
  - isConnected
```
public boolean isConnected()
```
    Check whether the transport is connected. Override superclass method, to actually ping our server connection.
  - issueCommand
```
public void issueCommand(java.lang.String cmd,
                         int expect)
                  throws MessagingException
```
    Send the command to the server. If the expected response code is not received, throw a MessagingException.
    
    Parameters:
    
    cmd - the command to send
    
    expect - the expected response code (-1 means don't care)
    
    Throws:
    
    MessagingException
    
    Since:
    
    JavaMail 1.4.1
  - simpleCommand
```
public int simpleCommand(java.lang.String cmd)
                  throws MessagingException
```
    Send the command to the server and return the response code from the server.
    
    Throws:
    
    MessagingException
    
    Since:
    
    JavaMail 1.4.1
  - supportsExtension
```
public boolean supportsExtension(java.lang.String ext)
```
    Return true if the SMTP server supports the specified service extension. Extensions are reported as results of the EHLO command when connecting to the server. See RFC 1869 and other RFCs that define specific extensions.
    
    Parameters:
    
    ext - the service extension name
    
    Returns:
    
    true if the extension is supported
    
    Since:
    
    JavaMail 1.3.2
  - getExtensionParameter
```
public java.lang.String getExtensionParameter(java.lang.String ext)
```
    Return the parameter the server provided for the specified service extension, or null if the extension isn't supported.
    
    Parameters:
    
    ext - the service extension name
    
    Returns:
    
    the extension parameter
    
    Since:
    
    JavaMail 1.3.2

Class SMTPTransport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMTPTransport

Method Detail

getLocalHost

setLocalHost

connect

getAuthorizationId

setAuthorizationID

getSASLEnabled

setSASLEnabled

getSASLRealm

setSASLRealm

getSASLMechanisms

setSASLMechanisms

getNTLMDomain

setNTLMDomain

getReportSuccess

setReportSuccess

getStartTLS

setStartTLS

getRequireStartTLS

setRequireStartTLS

isSSL

getUseRset

setUseRset

getNoopStrict

setNoopStrict

getLastServerResponse

getLastReturnCode

sasllogin

sendMessage

close

isConnected

issueCommand

simpleCommand

supportsExtension

getExtensionParameter