Trait/Object

spinoco.fs2.mail.smtp

SMTPClient

Related Docs: object SMTPClient | package smtp

Permalink

trait SMTPClient[F[_]] extends AnyRef

SMTP Client implemented according to RFC 5321

Source
SMTPClient.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SMTPClient
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def connect(domain: String): F[Seq[String]]

    Permalink

    Connects with SMTP server.

    Connects with SMTP server. Returns a list of supported extensions of this server.

    domain

    domain name to present on HELO/EHLO

  2. abstract def login(userName: String, password: String): F[Unit]

    Permalink

    login to SMTP server with supplied user and password.

    login to SMTP server with supplied user and password. This is equivalent to AUTH LOGIN *

  3. abstract def loginCramMD5(userName: String, password: String): F[Unit]

    Permalink

    login to SMTP server with CRAM MD5.

    login to SMTP server with CRAM MD5. This is equivalent to AUTH CRAM-MD5 command *

  4. abstract def loginPlain(authorizationId: String, authenticationId: String, pass: String): F[Unit]

    Permalink

    login to SMP server with supplied credentials.

    login to SMP server with supplied credentials. This is equivalent to AUTH PLAIN command *

  5. abstract def quit: F[Unit]

    Permalink

    Terminates SMTP Session with the server.

  6. abstract def send(from: @@[String, EmailAddress], recipients: Seq[@@[String, EmailAddress]], header: EmailHeader, body: MIMEPart[F]): F[Option[SMTPError]]

    Permalink

    Send the mail where body is supplied as MIME Part (eventually multiple)

    Send the mail where body is supplied as MIME Part (eventually multiple)

    from

    Source address presented to server

    recipients

    Recipients for this email.

    header

    Header of email message

    body

    Body of the email (MIME).

    returns

    nonempty if sent was ok, Some(result) otherwise

  7. abstract def sendText(from: @@[String, EmailAddress], recipients: Seq[@@[String, EmailAddress]], header: EmailHeader, text: Stream[F, Char]): F[Option[SMTPError]]

    Permalink

    Sends simple text message where text forms a body of the message.

    Sends simple text message where text forms a body of the message. Encodes as QuotedPrintable, UTF-8 encoding

    from

    source address presented to server.

    recipients

    Recipients for this email.

    header

    Header present to server

    text

    text to send as body

    returns

    nonempty if sent was ok, Some(result) otherwise

  8. abstract def serverId: F[String]

    Permalink

    Contains server's welcome message, i.e.

    Contains server's welcome message, i.e. 220 foo.com Simple Mail Transfer Service Ready *

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to any2stringadd[SMTPClient[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (SMTPClient[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to ArrowAssoc[SMTPClient[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (SMTPClient[F]) ⇒ Boolean, msg: ⇒ Any): SMTPClient[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to Ensuring[SMTPClient[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (SMTPClient[F]) ⇒ Boolean): SMTPClient[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to Ensuring[SMTPClient[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): SMTPClient[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to Ensuring[SMTPClient[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): SMTPClient[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to Ensuring[SMTPClient[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to StringFormat[SMTPClient[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (SMTPClient[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SMTPClient[F] to ArrowAssoc[SMTPClient[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SMTPClient[F] to any2stringadd[SMTPClient[F]]

Inherited by implicit conversion StringFormat from SMTPClient[F] to StringFormat[SMTPClient[F]]

Inherited by implicit conversion Ensuring from SMTPClient[F] to Ensuring[SMTPClient[F]]

Inherited by implicit conversion ArrowAssoc from SMTPClient[F] to ArrowAssoc[SMTPClient[F]]

Ungrouped