mime/multipart
Package multipart
Overview
Package multipart implements MIME multipart parsing, as defined in RFC 2046.
The implementation is sufficient for HTTP (RFC 2388) and the multipart bodies generated by popular browsers.
Index
Examples
Package files
formdata.go multipart.go writer.go
type FileSource
File is an interface to access the file part of a multipart message. Its contents may be either stored in memory or on disk. If stored on disk, the File's underlying concrete type will be an *os.File.
type File interface { io.Reader io.ReaderAt io.Seeker io.Closer }
type FileHeaderSource
A FileHeader describes a file part of a multipart request.
type FileHeader struct { Filename string Header textproto.MIMEHeader // contains filtered or unexported fields }
func (*FileHeader) OpenSource
func (fh *FileHeader) Open() (File, error)
Open opens and returns the FileHeader's associated File.
type FormSource
Form is a parsed multipart form. Its File parts are stored either in memory or on disk, and are accessible via the *FileHeader's Open method. Its Value parts are stored as strings. Both are keyed by field name.
type Form struct { Value map[string][]string File map[string][]*FileHeader }
func (*Form) RemoveAllSource
func (f *Form) RemoveAll() error
RemoveAll removes any temporary files associated with a Form.
type PartSource
A Part represents a single part in a multipart body.
type Part struct { // The headers of the body, if any, with the keys canonicalized // in the same fashion that the Go http.Request headers are. // For example, "foo-bar" changes case to "Foo-Bar" // // As a special case, if the "Content-Transfer-Encoding" header // has a value of "quoted-printable", that header is instead // hidden from this map and the body is transparently decoded // during Read calls. Header textproto.MIMEHeader // contains filtered or unexported fields }
func (*Part) CloseSource
func (p *Part) Close() error
func (*Part) FileNameSource
func (p *Part) FileName() string
FileName returns the filename parameter of the Part's Content-Disposition header.
func (*Part) FormNameSource
func (p *Part) FormName() string
FormName returns the name parameter if p has a Content-Disposition of type "form-data". Otherwise it returns the empty string.
func (*Part) ReadSource
func (p *Part) Read(d []byte) (n int, err error)
Read reads the body of a part, after its headers and before the next part (if any) begins.
type ReaderSource
Reader is an iterator over parts in a MIME multipart body. Reader's underlying parser consumes its input as needed. Seeking isn't supported.
type Reader struct { // contains filtered or unexported fields }
func NewReaderSource
func NewReader(r io.Reader, boundary string) *Reader
NewReader creates a new multipart Reader reading from r using the given MIME boundary.
The boundary is usually obtained from the "boundary" parameter of the message's "Content-Type" header. Use mime.ParseMediaType to parse such headers.
Example
package main import ( "fmt" "io" "io/ioutil" "log" "mime" "mime/multipart" "net/mail" "strings" ) func main() { msg := &mail.Message{ Header: map[string][]string{ "Content-Type": {"multipart/mixed; boundary=foo"}, }, Body: strings.NewReader( "--foo\r\nFoo: one\r\n\r\nA section\r\n" + "--foo\r\nFoo: two\r\n\r\nAnd another\r\n" + "--foo--\r\n"), } mediaType, params, err := mime.ParseMediaType(msg.Header.Get("Content-Type")) if err != nil { log.Fatal(err) } if strings.HasPrefix(mediaType, "multipart/") { mr := multipart.NewReader(msg.Body, params["boundary"]) for { p, err := mr.NextPart() if err == io.EOF { return } if err != nil { log.Fatal(err) } slurp, err := ioutil.ReadAll(p) if err != nil { log.Fatal(err) } fmt.Printf("Part %q: %q\n", p.Header.Get("Foo"), slurp) } } }
func (*Reader) NextPartSource
func (r *Reader) NextPart() (*Part, error)
NextPart returns the next part in the multipart or an error. When there are no more parts, the error io.EOF is returned.
func (*Reader) ReadFormSource
func (r *Reader) ReadForm(maxMemory int64) (*Form, error)
ReadForm parses an entire multipart message whose parts have a Content-Disposition of "form-data". It stores up to maxMemory bytes of the file parts in memory and the remainder on disk in temporary files.
type WriterSource
A Writer generates multipart messages.
type Writer struct { // contains filtered or unexported fields }
func NewWriterSource
func NewWriter(w io.Writer) *Writer
NewWriter returns a new multipart Writer with a random boundary, writing to w.
func (*Writer) BoundarySource
func (w *Writer) Boundary() string
Boundary returns the Writer's boundary.
func (*Writer) CloseSource
func (w *Writer) Close() error
Close finishes the multipart message and writes the trailing boundary end line to the output.
func (*Writer) CreateFormFieldSource
func (w *Writer) CreateFormField(fieldname string) (io.Writer, error)
CreateFormField calls CreatePart with a header using the given field name.
func (*Writer) CreateFormFileSource
func (w *Writer) CreateFormFile(fieldname, filename string) (io.Writer, error)
CreateFormFile is a convenience wrapper around CreatePart. It creates a new form-data header with the provided field name and file name.
func (*Writer) CreatePartSource
func (w *Writer) CreatePart(header textproto.MIMEHeader) (io.Writer, error)
CreatePart creates a new multipart section with the provided header. The body of the part should be written to the returned Writer. After calling CreatePart, any previous part may no longer be written to.
func (*Writer) FormDataContentTypeSource
func (w *Writer) FormDataContentType() string
FormDataContentType returns the Content-Type for an HTTP multipart/form-data with this Writer's Boundary.
func (*Writer) SetBoundarySource
func (w *Writer) SetBoundary(boundary string) error
SetBoundary overrides the Writer's default randomly-generated boundary separator with an explicit value.
SetBoundary must be called before any parts are created, may only contain certain ASCII characters, and must be non-empty and at most 69 bytes long.
func (*Writer) WriteFieldSource
func (w *Writer) WriteField(fieldname, value string) error
WriteField calls CreateFormField and then writes the given value.
© Google, Inc.
Licensed under the Creative Commons Attribution License 3.0.
https://golang.org/pkg/mime/multipart/