class MIME::Multipart::Builder

• MIME::Multipart::Builder
• Reference
• Object

Overview

Builds a multipart MIME message.

Example

require "mime/multipart"

io = IO::Memory.new # This is a stub. Actually, any IO can be used.
multipart = MIME::Multipart::Builder.new(io)
multipart.body_part HTTP::Headers{"Content-Type" => "text/plain"}, "hello!"
multipart.finish
io.to_s # => "----------------------------DTf61dRTHYzprx7rwVQhTWr7\r\nContent-Type: text/plain\r\n\r\nhello!\r\n----------------------------DTf61dRTHYzprx7rwVQhTWr7--"

Defined in:

Constructors

• .new(io : IO, boundary : String = Multipart.generate_boundary)

  Creates a newMultipart::Builder which writes the generated multipart message toio, using the multipart boundaryboundary.

Instance Method Summary

• #body_part(headers : HTTP::Headers, string : String) : Nil

  Appends a body part to the multipart message with the givenheaders andstring.

• #body_part(headers : HTTP::Headers, data : Bytes) : Nil

  Appends a body part to the multipart message with the givenheaders anddata.

• #body_part(headers : HTTP::Headers, body_io : IO) : Nil

  Appends a body part to the multipart message with the givenheaders and data frombody_io.

• #body_part(headers : HTTP::Headers, &)

  Yields an IO that can be used to write to a body part which is appended to the multipart message with the givenheaders.

• #body_part(headers : HTTP::Headers) : Nil

  Appends a body part to the multipart message with the givenheaders and no body data.

• #boundary : String
• #content_type(subtype : String = "mixed") : String

  Returns a content type header with multipart subtypesubtype, and boundary parameter added.

• #epilogue(string : String) : Nil

  Appendsstring to the epilogue segment of the multipart message.

• #epilogue(data : Bytes) : Nil

  Appendsdata to the epilogue segment of the multipart message.

• #epilogue(epilogue_io : IO) : Nil

  Appendspreamble_io to the epilogue segment of the multipart message.

• #epilogue(&)

  Yields an IO that can be used to append to the epilogue of the multipart message.

• #finish : Nil

  Finalizes the multipart message, this method must be called to properly end the multipart message.

• #preamble(string : String) : Nil

  Appendsstring to the preamble segment of the multipart message.

• #preamble(data : Bytes) : Nil

  Appendsdata to the preamble segment of the multipart message.

• #preamble(preamble_io : IO) : Nil

  Appendspreamble_io to the preamble segment of the multipart message.

• #preamble(&)

  Yields an IO that can be used to append to the preamble of the multipart message.

Constructor Detail

Instance Method Detail

require "mime/multipart"

io = IO::Memory.new # This is a stub. Actually, any IO can be used.
builder = MIME::Multipart::Builder.new(io, "a4VF")
builder.content_type("mixed") # => "multipart/mixed; boundary=a4VF"