TransportStrategy (Simple Java Mail - Maven master project 7.3.0 API)

java.lang.Object
- java.lang.Enum<TransportStrategy>
- - org.simplejavamail.api.mailer.config.TransportStrategy

All Implemented Interfaces:

Serializable, Comparable<TransportStrategy>
```
public enum TransportStrategy
extends Enum<TransportStrategy>
```
Defines the various types of transport protocols and implements respective properties so that a Session may be configured using a TransportStrategy implementation.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`SMTP` Vanilla SMTP with an insecure STARTTLS upgrade (if supported).
`SMTP_TLS` Plaintext SMTP with a mandatory, authenticated STARTTLS upgrade.
`SMTPS` SMTP entirely encapsulated by TLS.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static @Nullable TransportStrategy`	`findStrategyForSession(jakarta.mail.Session session)` For internal use only.
`Properties`	`generateProperties()` For internal use only.
`abstract int`	`getDefaultServerPort()` For internal use only.
`abstract String`	`propertyNameAuthenticate()` For internal use only.
`abstract String`	`propertyNameCheckServerIdentity()` For internal use only.
`abstract String`	`propertyNameConnectionTimeout()` For internal use only.
`abstract String`	`propertyNameEnvelopeFrom()` For internal use only.
`abstract String`	`propertyNameHost()` For internal use only.
`abstract String`	`propertyNamePort()` For internal use only.
`abstract String`	`propertyNameSocksHost()` For internal use only.
`abstract String`	`propertyNameSocksPort()` For internal use only.
`abstract String`	`propertyNameSSLTrust()` For internal use only.
`abstract String`	`propertyNameTimeout()` For internal use only.
`abstract String`	`propertyNameUsername()` For internal use only.
`abstract String`	`propertyNameWriteTimeout()` For internal use only.
`void`	`setOpportunisticTLS(@Nullable Boolean opportunisticTLS)` Determines whether TLS should be attempted for SMTP plain protocol (optional if offered by the SMTP server).
`String`	`toString(Properties properties)`
`static TransportStrategy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TransportStrategy[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - SMTP
```
public static final TransportStrategy SMTP
```
    Vanilla SMTP with an insecure STARTTLS upgrade (if supported).
    This TransportStrategy falls back to plaintext when a mail server does not indicate support for STARTTLS. Additionally, even if a TLS session is negotiated, server certificates are not validated in any way.
    This TransportStrategy only offers protection against passive network eavesdroppers when the mail server indicates support for STARTTLS. Active network attackers can trivially bypass the encryption 1) by tampering with the STARTTLS indicator, 2) by presenting a self-signed certificate, 3) by presenting a certificate issued by an untrusted certificate authority; or 4) by presenting a certificate that was issued by a valid certificate authority to a domain other than the mail server's.
    For proper mail transport encryption, see SMTPS or SMTP_TLS.
    Implementation notes:
    - The transport protocol is explicitly set to smtp.
    - Only mail.smtp properties are set.
    - STARTTLS is enabled by setting mail.smtp.starttls.enable to true.
    - STARTTLS plaintext fallback is enabled by setting mail.smtp.starttls.required to false.
  - SMTPS
```
public static final TransportStrategy SMTPS
```
    SMTP entirely encapsulated by TLS. Commonly known as SMTPS.
    Strict validation of server certificates is enabled. Server certificates must be issued 1) by a certificate authority in the system trust store; and 2) to a subject matching the identity of the remote SMTP server.
    Implementation notes:
    - The transport protocol is explicitly set to smtps.
    - Only mail.smtps properties are set.
    - mail.smtps.quitwait is set to false to get rid of a strange SSLException:
      jakarta.mail.MessagingException: Exception reading response; nested exception is: javax.net.ssl.SSLException: Unsupported record version Unknown-50.49 (..)
      
      The mail is sent but the exception is unwanted. The property quitwait means If set to false, the QUIT command is sent and the connection is immediately closed. If set to true (the default), causes the transport to wait for the response to the QUIT command
      
      - source
  - SMTP_TLS
```
public static final TransportStrategy SMTP_TLS
```
    Plaintext SMTP with a mandatory, authenticated STARTTLS upgrade.
    Strict validation of server certificates is enabled. Server certificates must be issued 1) by a certificate authority in the system trust store; and 2) to a subject matching the identity of the remote SMTP server.
    Implementation notes:
    - The transport protocol is explicitly set to smtp.
    - Only mail.smtp properties are set.
    - STARTTLS is enabled by setting mail.smtp.starttls.enable to true.
    - STARTTLS plaintext fallback is disabled by setting mail.smtp.starttls.required to true.
- Method Detail
  - values
```
public static TransportStrategy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TransportStrategy c : TransportStrategy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TransportStrategy valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - generateProperties
```
public Properties generateProperties()
```
    For internal use only.
  - propertyNameHost
```
public abstract String propertyNameHost()
```
    For internal use only.
  - propertyNamePort
```
public abstract String propertyNamePort()
```
    For internal use only.
  - propertyNameUsername
```
public abstract String propertyNameUsername()
```
    For internal use only.
  - propertyNameAuthenticate
```
public abstract String propertyNameAuthenticate()
```
    For internal use only.
  - propertyNameSocksHost
```
public abstract String propertyNameSocksHost()
```
    For internal use only.
  - propertyNameSocksPort
```
public abstract String propertyNameSocksPort()
```
    For internal use only.
  - propertyNameConnectionTimeout
```
public abstract String propertyNameConnectionTimeout()
```
    For internal use only.
    
    See Also:
    
    "SMTP.propertyNameConnectionTimeout()", "SMTPS.propertyNameConnectionTimeout()", "SMTP_TLS.propertyNameConnectionTimeout()"
  - propertyNameWriteTimeout
```
public abstract String propertyNameWriteTimeout()
```
    For internal use only.
    
    See Also:
    
    "SMTP.propertyNameWriteTimeout()", "SMTPS.propertyNameWriteTimeout()", "SMTP_TLS.propertyNameWriteTimeout()"
  - propertyNameTimeout
```
public abstract String propertyNameTimeout()
```
    For internal use only.
    
    See Also:
    
    "SMTP.propertyNameTimeout()", "SMTPS.propertyNameTimeout()", "SMTP_TLS.propertyNameTimeout()"
  - propertyNameEnvelopeFrom
```
public abstract String propertyNameEnvelopeFrom()
```
    For internal use only.
  - propertyNameSSLTrust
```
public abstract String propertyNameSSLTrust()
```
    For internal use only.
  - propertyNameCheckServerIdentity
```
public abstract String propertyNameCheckServerIdentity()
```
    For internal use only.
  - getDefaultServerPort
```
public abstract int getDefaultServerPort()
```
    For internal use only.
  - setOpportunisticTLS
```
public void setOpportunisticTLS(@Nullable
                                @Nullable Boolean opportunisticTLS)
```
    Determines whether TLS should be attempted for SMTP plain protocol (optional if offered by the SMTP server). If not set and no property was provided, this value defaults to it default.
    Setting this flag to false causes SMTP to revert to the legacy behavior.
    Only has any effect when invoked via TransportStrategy.SMTP.setOpportunisticTLS(true/false)
  - findStrategyForSession
```
@Nullable
public static @Nullable TransportStrategy findStrategyForSession(jakarta.mail.Session session)
```
    For internal use only.
    
    Parameters:
    
    session - The session to determine the current transport strategy for
    
    Returns:
    
    Which strategy matches the current Session properties.
    
    See Also:
    
    TRANSPORT_STRATEGY_MARKER, generateProperties()
  - toString
```
public String toString(Properties properties)
```

Enum TransportStrategy

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SMTP

SMTPS

SMTP_TLS

Method Detail

values

valueOf

generateProperties

propertyNameHost

propertyNamePort

propertyNameUsername

propertyNameAuthenticate

propertyNameSocksHost

propertyNameSocksPort

propertyNameConnectionTimeout

propertyNameWriteTimeout

propertyNameTimeout

propertyNameEnvelopeFrom

propertyNameSSLTrust

propertyNameCheckServerIdentity

getDefaultServerPort

setOpportunisticTLS

findStrategyForSession

toString