Object/Trait

spinoco.fs2.mail.mime

MIMEPart

Related Docs: trait MIMEPart | package mime

Permalink

object MIMEPart

Source
MIMEPart.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MIMEPart
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class MultiPart[F[_]](header: MIMEHeader, boundary: String, parts: Stream[F, MIMEPart[F]]) extends MIMEPart[F] with Product with Serializable

    Permalink

    A mime part that is multipart.

    A mime part that is multipart. i.e. instead containing data directly, this will contain other mime parts

    header

    Header of the multipart

    boundary

    Boundary identification, to divide parts accoding to RFC

    parts

    Parts to eb included.

  2. case class SinglePart[F[_]](header: MIMEHeader, data: Stream[F, Byte]) extends MIMEPart[F] with Product with Serializable

    Permalink

    Represents a mime part within the Email body

    Represents a mime part within the Email body

    header

    Header of the Mime part

    data

    Data expressed as bytes, encoded according to information provided in header. For multipart part, this is empty.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def alternative[F[_]](fallback: MIMEPart[F], alternative: MIMEPart[F], boundary: ⇒ String = ...): MultiPart[F]

    Permalink

    Creates a MIME part with alternative message content.

    Creates a MIME part with alternative message content.

    fallback

    A content that is used as fallback (i.e. text/plain) if none of the alternatives work.

    alternative

    An alternative content to send (i.e. text/html)

    boundary

    A boundary string denoting one part. This string cannot be longer than 70 characters and must not contain any whitespaces.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def binary[F[_]](id: String, tpe: DefaultMediaType, stream: Stream[F, Byte]): SinglePart[F]

    Permalink

    Creates a MIME part, that encodes binary stream with supplied encdoing any media type.

    Creates a MIME part, that encodes binary stream with supplied encdoing any media type.

    id

    Id fo the content

    tpe

    Type of the media of the binary content

    stream

    Stream of byted

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def file[F[_]](id: String, fileName: String, tpe: DefaultMediaType, stream: Stream[F, Byte]): SinglePart[F]

    Permalink

    Allows to mark the attachement as the file

    Allows to mark the attachement as the file

    id

    Id of the content

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. def html[F[_]](stream: Stream[F, Char], charset: Charset = StandardCharsets.UTF_8, enc: StandardEncoding = TransferEncoding.QuotedPrintable)(implicit arg0: Sync[F]): SinglePart[F]

    Permalink

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of text/html and supplied charset.

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of text/html and supplied charset.

    stream

    Stream of characters

    charset

    Charset to encode the characters to

    enc

    Encoding to use

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def mixed[F[_]](parts: Stream[F, MIMEPart[F]], boundary: ⇒ String = ...): MultiPart[F]

    Permalink

    Creates a MIME part with mixed message content.

    Creates a MIME part with mixed message content.

    The separate parts will be displayed in sequence. The inner parts will be displayed properly, meaning if there is an alternative in the mixed parts, the alternative will work as if it were on top level.

    parts

    The parts to make this mixed type

    boundary

    A boundary string denoting one part. This string cannot be longer than 70 characters and must not contain any whitespaces.

  17. def multipart[F[_]](subtype: String, parts: Stream[F, MIMEPart[F]], encoding: TransferEncoding = TransferEncoding.Bits8, boundary: ⇒ String = ...): MultiPart[F]

    Permalink

    Creates a multipart with supplied subtype and encoding.

    Creates a multipart with supplied subtype and encoding.

    subtype

    Subtype (i.e. alternate/mixed)

    parts

    Parts to include in this mime part. Parts may be nested.

    encoding

    Encoding (note the 7Bit, 8Bit, Binary must be used according to RFC

    boundary

    A boundary string denoting one part. This string cannot be longer than 70 characters and must not contain any whitespaces.

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

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def plain[F[_]](stream: Stream[F, Char], charset: Charset = StandardCharsets.UTF_8, enc: StandardEncoding = TransferEncoding.QuotedPrintable)(implicit arg0: Sync[F]): SinglePart[F]

    Permalink

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of text/plain and supplied charset.

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of text/plain and supplied charset.

    stream

    Stream of characters

    charset

    Charset to encode the characters to

    enc

    Encoding to use

  22. def related[F[_]](mainPart: SinglePart[F], related: Stream[F, MIMEPart[F]], boundary: ⇒ String = ...): MultiPart[F]

    Permalink

    Creates a MIME part with related message content.

    Creates a MIME part with related message content.

    mainPart

    Displayed part. Contains links to related parts (cid:Content-Id)

    related

    Related parts referenced from mainPart.

    boundary

    A boundary string denoting one part. This string cannot be longer than 70 characters and must not contain any whitespaces.

    See also

    https://tools.ietf.org/html/rfc2387

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

    Permalink
    Definition Classes
    AnyRef
  24. def text[F[_]](stream: Stream[F, Char], tpe: DefaultMediaType, charset: Charset = StandardCharsets.UTF_8, enc: StandardEncoding = TransferEncoding.QuotedPrintable)(implicit arg0: Sync[F]): SinglePart[F]

    Permalink

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of tpe and supplied charset.

    Creates a MIME part, that encodes supplied stream of chars as encoding with type of tpe and supplied charset.

    stream

    Stream of characters

    tpe

    Type of the content

    charset

    Charset to encode the characters to

    enc

    Encoding to use

  25. def textEncoder[F[_]](enc: StandardEncoding): Pipe[F, Byte, Byte]

    Permalink

    for supplied encoding creates an encoder *

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

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

Deprecated Value Members

  1. def alternate[F[_]](fallback: MIMEPart[F], alternative: MIMEPart[F], boundary: ⇒ String = ...): MultiPart[F]

    Permalink

    Creates a MIME part with alternative message content.

    Creates a MIME part with alternative message content.

    fallback

    A content that is used as fallback (i.e. text/plain) if none of the alternatives work.

    alternative

    An alternative content to send (i.e. text/html)

    boundary

    A boundary string denoting one part. This string cannot be longer than 70 characters and must not contain any whitespaces.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.1) Deprecated in favour of MIMEPart.alternative

Inherited from AnyRef

Inherited from Any

Ungrouped