smtp/at.quickme.kotlinmailer.smtp

Package-level declarations

Types

AppleSmtpSocketFactory

object AppleSmtpSocketFactory : SmtpSocketFactory

SmtpSocketFactory based on Foundation streams, using the system's TLS stack and trust store.

KtorSmtpSocketFactory

class KtorSmtpSocketFactory(tls: TLSConfigBuilder.() -> Unit = {}) : SmtpSocketFactory

SmtpSocketFactory based on ktor-network, with TLS from ktor-network-tls.

NodeSmtpSocketFactory

class NodeSmtpSocketFactory(tlsOptions: dynamic = null) : SmtpSocketFactory

SmtpSocketFactory based on the Node.js net and tls modules. Not available in browsers.

sealed interface SmtpAuth

Credentials for SMTP AUTH (RFC 4954).

class SmtpConfig(val host: String, val port: Int = SmtpSecurity.STARTTLS.defaultPort, val security: SmtpSecurity = SmtpSecurity.STARTTLS, val auth: SmtpAuth? = null, val clientHostname: String = "localhost", val connectTimeout: Duration = 30.seconds, val commandTimeout: Duration = 5.minutes, val dataTimeout: Duration = 10.minutes, val maxConnections: Int = 1, val reuseConnections: Boolean = true, val failOnRejectedRecipient: Boolean = true, val allowInsecureAuth: Boolean = false, val socketFactory: SmtpSocketFactory = defaultSmtpSocketFactory())

Settings of an SmtpMailer.

class SmtpException(message: String, val replyCode: Int? = null, val enhancedStatusCode: String? = null, cause: Throwable? = null) : MailException

An SMTP failure. If the server rejected a command, replyCode and enhancedStatusCode are set.

class SmtpMailer(val config: SmtpConfig) : Mailer

Sends emails via SMTP, keeping up to SmtpConfig.maxConnections connections open.

SmtpMailerBuilder

class SmtpMailerBuilder(var host: String)

Builder for SmtpMailer, see smtpMailer.

enum SmtpSecurity : Enum<SmtpSecurity>

How the connection to the SMTP server is secured.

interface SmtpSocket

A bidirectional byte stream to an SMTP server that can be upgraded to TLS.

SmtpSocketFactory

fun interface SmtpSocketFactory

Opens SmtpSockets.

Functions

defaultSmtpSocketFactory

actual fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

expect fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

actual fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

actual fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

actual fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

actual fun defaultSmtpSocketFactory(): SmtpSocketFactory

The socket factory of the current platform.

inline fun smtpMailer(host: String, builder: SmtpMailerBuilder.() -> Unit = {}): SmtpMailer

Create an SmtpMailer and register it at MailerManager.