SmtpSessionConfig (NioSmtpClient 1.0.0 API)

java.lang.Object
- com.hubspot.smtp.client.SmtpSessionConfig

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","AbstractSmtpSessionConfig"})
 @Immutable
public final class SmtpSessionConfig
extends Object

Immutable implementation of AbstractSmtpSessionConfig.

Use the builder to create immutable instances: SmtpSessionConfig.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SmtpSessionConfig.Builder
Builds instances of type SmtpSessionConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SmtpSessionConfig.Builder` Builds instances of type `SmtpSessionConfig`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static SmtpSessionConfig.Builder`	`builder()` Creates a builder for `SmtpSessionConfig`.
`protected void`	`check()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `SmtpSessionConfig` that have equal attribute values.
`static SmtpSessionConfig`	`forRemoteAddress(InetSocketAddress remoteAddress)` Creates a configuration for a connection to a server on the specified host and port.
`static SmtpSessionConfig`	`forRemoteAddress(String host, int port)` Creates a configuration for a connection to a server on the specified host and port.
`String`	`getConnectionId()` An opaque string that will be logged with any errors on this connection.
`Duration`	`getConnectionTimeout()` Deprecated. use initialResponseTimeout instead, which applies to the combined time of connecting and receiving the initial response
`EnumSet<Extension>`	`getDisabledExtensions()` Extensions which should not be used when communicating with the remote server.
`Optional<Consumer<Throwable>>`	`getExceptionHandler()` A handler for exceptions that happen outside sending individual messages.
`Optional<Duration>`	`getInitialResponseReadTimeout()` Deprecated. use getInitialResponseTimeout instead, which applies to the combined time of connecting and receiving the initial response
`Duration`	`getInitialResponseTimeout()` The time to wait for the initial response from the server.
`Optional<Duration>`	`getKeepAliveTimeout()` The time to wait before sending a NOOP command to keep an otherwise idle connection alive.
`Optional<InetSocketAddress>`	`getLocalAddress()` The local address and port to use when connecting to the remote server.
`Optional<Duration>`	`getReadTimeout()` The time to wait for a response from the server.
`InetSocketAddress`	`getRemoteAddress()` The host and port of the remote server.
`Optional<SendInterceptor>`	`getSendInterceptor()` A `SendInterceptor` that can intercept commands and data before they are sent to the server.
`int`	`hashCode()` Computes a hash code from attributes: `remoteAddress`, `localAddress`, `keepAliveTimeout`, `readTimeout`, `initialResponseReadTimeout`, `initialResponseTimeout`, `sendInterceptor`, `exceptionHandler`, `connectionTimeout`, `disabledExtensions`, `connectionId`.
`String`	`toString()` Prints the immutable value `SmtpSessionConfig` with attribute values.
`SmtpSessionConfig`	`withConnectionId(String connectionId)` Copy the current immutable object by setting a value for the `connectionId` attribute.
`SmtpSessionConfig`	`withConnectionTimeout(Duration connectionTimeout)` Deprecated.
`SmtpSessionConfig`	`withDisabledExtensions(EnumSet<Extension> disabledExtensions)` Copy the current immutable object by setting a value for the `disabledExtensions` attribute.
`SmtpSessionConfig`	`withExceptionHandler(Consumer<Throwable> value)` Copy the current immutable object by setting a present value for the optional `exceptionHandler` attribute.
`SmtpSessionConfig`	`withExceptionHandler(Optional<Consumer<Throwable>> optional)` Copy the current immutable object by setting an optional value for the `exceptionHandler` attribute.
`SmtpSessionConfig`	`withInitialResponseReadTimeout(Duration value)` Deprecated.
`SmtpSessionConfig`	`withInitialResponseReadTimeout(Optional<Duration> optional)` Deprecated.
`SmtpSessionConfig`	`withInitialResponseTimeout(Duration initialResponseTimeout)` Copy the current immutable object by setting a value for the `initialResponseTimeout` attribute.
`SmtpSessionConfig`	`withKeepAliveTimeout(Duration value)` Copy the current immutable object by setting a present value for the optional `keepAliveTimeout` attribute.
`SmtpSessionConfig`	`withKeepAliveTimeout(Optional<Duration> optional)` Copy the current immutable object by setting an optional value for the `keepAliveTimeout` attribute.
`SmtpSessionConfig`	`withLocalAddress(InetSocketAddress value)` Copy the current immutable object by setting a present value for the optional `localAddress` attribute.
`SmtpSessionConfig`	`withLocalAddress(Optional<InetSocketAddress> optional)` Copy the current immutable object by setting an optional value for the `localAddress` attribute.
`SmtpSessionConfig`	`withReadTimeout(Duration value)` Copy the current immutable object by setting a present value for the optional `readTimeout` attribute.
`SmtpSessionConfig`	`withReadTimeout(Optional<Duration> optional)` Copy the current immutable object by setting an optional value for the `readTimeout` attribute.
`SmtpSessionConfig`	`withRemoteAddress(InetSocketAddress remoteAddress)` Copy the current immutable object by setting a value for the `remoteAddress` attribute.
`SmtpSessionConfig`	`withSendInterceptor(Optional<SendInterceptor> optional)` Copy the current immutable object by setting an optional value for the `sendInterceptor` attribute.
`SmtpSessionConfig`	`withSendInterceptor(SendInterceptor value)` Copy the current immutable object by setting a present value for the optional `sendInterceptor` attribute.

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

- Method Detail
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    The host and port of the remote server.
  - getLocalAddress
```
public Optional<InetSocketAddress> getLocalAddress()
```
    The local address and port to use when connecting to the remote server.
  - getKeepAliveTimeout
```
public Optional<Duration> getKeepAliveTimeout()
```
    The time to wait before sending a NOOP command to keep an otherwise idle connection alive.
  - getReadTimeout
```
public Optional<Duration> getReadTimeout()
```
    The time to wait for a response from the server.
  - getInitialResponseReadTimeout
```
@Deprecated
public Optional<Duration> getInitialResponseReadTimeout()
```
    Deprecated. use getInitialResponseTimeout instead, which applies to the combined time of connecting and receiving the initial response
    
    The time to wait for the initial response from the server.
  - getInitialResponseTimeout
```
public Duration getInitialResponseTimeout()
```
    The time to wait for the initial response from the server. This includes the connect time.
  - getSendInterceptor
```
public Optional<SendInterceptor> getSendInterceptor()
```
    A SendInterceptor that can intercept commands and data before they are sent to the server.
    SendInterceptors are especially useful when using the SmtpSession#send overloads that send multiple commands for you. If you provide a SendInterceptor to the send method, it will take precedence over this one.
  - getExceptionHandler
```
public Optional<Consumer<Throwable>> getExceptionHandler()
```
    A handler for exceptions that happen outside sending individual messages.
  - getConnectionTimeout
```
@Deprecated
public Duration getConnectionTimeout()
```
    Deprecated. use initialResponseTimeout instead, which applies to the combined time of connecting and receiving the initial response
    
    The time to wait while connecting to a remote server.
  - getDisabledExtensions
```
public EnumSet<Extension> getDisabledExtensions()
```
    Extensions which should not be used when communicating with the remote server.
    This is useful if a server's EHLO response indicates supports for a particular extension but the implementation isn't working.
  - getConnectionId
```
public String getConnectionId()
```
    An opaque string that will be logged with any errors on this connection.
  - withRemoteAddress
```
public final SmtpSessionConfig withRemoteAddress(InetSocketAddress remoteAddress)
```
    Copy the current immutable object by setting a value for the remoteAddress attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    remoteAddress - A new value for remoteAddress
    
    Returns:
    
    A modified copy of the this object
  - withLocalAddress
```
public final SmtpSessionConfig withLocalAddress(InetSocketAddress value)
```
    Copy the current immutable object by setting a present value for the optional localAddress attribute.
    
    Parameters:
    
    value - The value for localAddress
    
    Returns:
    
    A modified copy of this object
  - withLocalAddress
```
public final SmtpSessionConfig withLocalAddress(Optional<InetSocketAddress> optional)
```
    Copy the current immutable object by setting an optional value for the localAddress attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for localAddress
    
    Returns:
    
    A modified copy of this object
  - withKeepAliveTimeout
```
public final SmtpSessionConfig withKeepAliveTimeout(Duration value)
```
    Copy the current immutable object by setting a present value for the optional keepAliveTimeout attribute.
    
    Parameters:
    
    value - The value for keepAliveTimeout
    
    Returns:
    
    A modified copy of this object
  - withKeepAliveTimeout
```
public final SmtpSessionConfig withKeepAliveTimeout(Optional<Duration> optional)
```
    Copy the current immutable object by setting an optional value for the keepAliveTimeout attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for keepAliveTimeout
    
    Returns:
    
    A modified copy of this object
  - withReadTimeout
```
public final SmtpSessionConfig withReadTimeout(Duration value)
```
    Copy the current immutable object by setting a present value for the optional readTimeout attribute.
    
    Parameters:
    
    value - The value for readTimeout
    
    Returns:
    
    A modified copy of this object
  - withReadTimeout
```
public final SmtpSessionConfig withReadTimeout(Optional<Duration> optional)
```
    Copy the current immutable object by setting an optional value for the readTimeout attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for readTimeout
    
    Returns:
    
    A modified copy of this object
  - withInitialResponseReadTimeout
```
@Deprecated
public final SmtpSessionConfig withInitialResponseReadTimeout(Duration value)
```
    Deprecated.
    
    Copy the current immutable object by setting a present value for the optional initialResponseReadTimeout attribute.
    
    Parameters:
    
    value - The value for initialResponseReadTimeout
    
    Returns:
    
    A modified copy of this object
  - withInitialResponseReadTimeout
```
@Deprecated
public final SmtpSessionConfig withInitialResponseReadTimeout(Optional<Duration> optional)
```
    Deprecated.
    
    Copy the current immutable object by setting an optional value for the initialResponseReadTimeout attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for initialResponseReadTimeout
    
    Returns:
    
    A modified copy of this object
  - withInitialResponseTimeout
```
public final SmtpSessionConfig withInitialResponseTimeout(Duration initialResponseTimeout)
```
    Copy the current immutable object by setting a value for the initialResponseTimeout attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    initialResponseTimeout - A new value for initialResponseTimeout
    
    Returns:
    
    A modified copy of the this object
  - withSendInterceptor
```
public final SmtpSessionConfig withSendInterceptor(SendInterceptor value)
```
    Copy the current immutable object by setting a present value for the optional sendInterceptor attribute.
    
    Parameters:
    
    value - The value for sendInterceptor
    
    Returns:
    
    A modified copy of this object
  - withSendInterceptor
```
public final SmtpSessionConfig withSendInterceptor(Optional<SendInterceptor> optional)
```
    Copy the current immutable object by setting an optional value for the sendInterceptor attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for sendInterceptor
    
    Returns:
    
    A modified copy of this object
  - withExceptionHandler
```
public final SmtpSessionConfig withExceptionHandler(Consumer<Throwable> value)
```
    Copy the current immutable object by setting a present value for the optional exceptionHandler attribute.
    
    Parameters:
    
    value - The value for exceptionHandler
    
    Returns:
    
    A modified copy of this object
  - withExceptionHandler
```
public final SmtpSessionConfig withExceptionHandler(Optional<Consumer<Throwable>> optional)
```
    Copy the current immutable object by setting an optional value for the exceptionHandler attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for exceptionHandler
    
    Returns:
    
    A modified copy of this object
  - withConnectionTimeout
```
@Deprecated
public final SmtpSessionConfig withConnectionTimeout(Duration connectionTimeout)
```
    Deprecated.
    
    Copy the current immutable object by setting a value for the connectionTimeout attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    connectionTimeout - A new value for connectionTimeout
    
    Returns:
    
    A modified copy of the this object
  - withDisabledExtensions
```
public final SmtpSessionConfig withDisabledExtensions(EnumSet<Extension> disabledExtensions)
```
    Copy the current immutable object by setting a value for the disabledExtensions attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    disabledExtensions - A new value for disabledExtensions
    
    Returns:
    
    A modified copy of the this object
  - withConnectionId
```
public final SmtpSessionConfig withConnectionId(String connectionId)
```
    Copy the current immutable object by setting a value for the connectionId attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    connectionId - A new value for connectionId
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of SmtpSessionConfig that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: remoteAddress, localAddress, keepAliveTimeout, readTimeout, initialResponseReadTimeout, initialResponseTimeout, sendInterceptor, exceptionHandler, connectionTimeout, disabledExtensions, connectionId.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SmtpSessionConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static SmtpSessionConfig.Builder builder()
```
    Creates a builder for SmtpSessionConfig.
    
    Returns:
    
    A new SmtpSessionConfig builder
  - check
```
@Value.Check
protected void check()
```
  - forRemoteAddress
```
public static SmtpSessionConfig forRemoteAddress(String host,
                                                 int port)
```
    Creates a configuration for a connection to a server on the specified host and port.
  - forRemoteAddress
```
public static SmtpSessionConfig forRemoteAddress(InetSocketAddress remoteAddress)
```
    Creates a configuration for a connection to a server on the specified host and port.

Class SmtpSessionConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRemoteAddress

getLocalAddress

getKeepAliveTimeout

getReadTimeout

getInitialResponseReadTimeout

getInitialResponseTimeout

getSendInterceptor

getExceptionHandler

getConnectionTimeout

getDisabledExtensions

getConnectionId

withRemoteAddress

withLocalAddress

withLocalAddress

withKeepAliveTimeout

withKeepAliveTimeout

withReadTimeout

withReadTimeout

withInitialResponseReadTimeout

withInitialResponseReadTimeout

withInitialResponseTimeout

withSendInterceptor

withSendInterceptor

withExceptionHandler

withExceptionHandler

withConnectionTimeout

withDisabledExtensions

withConnectionId

equals

hashCode

toString

builder

check

forRemoteAddress

forRemoteAddress