package mime

import "mime"

Package mime implements parts of the MIME spec.

Index

Examples

Constants

const (
	// BEncoding represents Base64 encoding scheme as defined by RFC 2045.
	BEncoding = WordEncoder('b')
	// QEncoding represents the Q-encoding scheme as defined by RFC 2047.
	QEncoding = WordEncoder('q')
)

Variables

var ErrInvalidMediaParameter = errors.New("mime: invalid media parameter")

ErrInvalidMediaParameter 在找到媒体类型值但解析可选参数出错时由 ParseMediaType 返回。

Functions

func AddExtensionType

func AddExtensionType(ext, typ string) error

AddExtensionType 将与扩展名 ext 关联的 MIME 类型设置为 typ。 扩展名应以点号开头，如 ".html"。

func ExtensionsByType

func ExtensionsByType(typ string) ([]string, error)

ExtensionsByType 返回与 MIME 类型 typ 关联的扩展名。 返回的扩展名均以点号开头，如 ".html"。 当 typ 没有关联扩展名时，ExtensionsByType 返回 nil。

内置表很小，但在 Unix 系统上，若以下任一位置存在本地系统的 MIME-info 数据库或 mime.types 文件， 则会利用它们进行扩充： 

/usr/local/share/mime/globs2
/usr/share/mime/globs2
/etc/mime.types
/etc/apache2/mime.types
/etc/apache/mime.types
/etc/httpd/conf/mime.types

在 Windows 上，扩展名从注册表中提取。

func FormatMediaType

func FormatMediaType(t string, param map[string]string) string

FormatMediaType 将媒体类型 t 及参数 param 序列化为符合 RFC 2045 和 RFC 2616 的媒体类型字符串。 类型和参数名以小写形式写出。 当任一参数导致违反标准时，FormatMediaType 返回空字符串。

Example 
package main

import (
	"fmt"
	"mime"
)

func main() {
	mediatype := "text/html"
	params := map[string]string{
		"charset": "utf-8",
	}

	result := mime.FormatMediaType(mediatype, params)

	fmt.Println("result:", result)
}

Output:

result: text/html; charset=utf-8

func ParseMediaType

func ParseMediaType(v string) (mediatype string, params map[string]string, err error)

ParseMediaType 解析媒体类型值及其可选参数，依据 RFC 1521。 媒体类型为 Content-Type 和 Content-Disposition 头部中的值（RFC 2183）。 成功时，ParseMediaType 返回转换为小写且去除空白后的媒体类型，以及非空的 params 映射。 解析可选参数出错时，将返回媒体类型及错误 ErrInvalidMediaParameter。 返回的映射 params 将小写属性名映射到属性值，属性值的大小写保持不变。

Example 
package main

import (
	"fmt"
	"mime"
)

func main() {
	mediatype, params, err := mime.ParseMediaType("text/html; charset=utf-8")
	if err != nil {
		panic(err)
	}

	fmt.Println("type:", mediatype)
	fmt.Println("charset:", params["charset"])
}

Output:

type: text/html
charset: utf-8

func TypeByExtension

func TypeByExtension(ext string) string

TypeByExtension 返回与文件扩展名 ext 关联的 MIME 类型。 ext 应以点号开头，如 ".html"。 当 ext 没有关联类型时，TypeByExtension 返回 ""。

扩展名首先按大小写敏感方式查找，若未找到则按大小写不敏感方式查找。

内置表很小，但在 Unix 系统上，若以下任一位置存在本地系统的 MIME-info 数据库或 mime.types 文件， 则会利用它们进行扩充： 

/usr/local/share/mime/globs2
/usr/share/mime/globs2
/etc/mime.types
/etc/apache2/mime.types
/etc/apache/mime.types
/etc/httpd/conf/mime.types

在 Windows 上，MIME 类型从注册表中提取。

文本类型的字符集参数默认设置为 "utf-8"。

Types

type WordDecoder

type WordDecoder struct {
	// CharsetReader，若非 nil，定义一个函数用于生成字符集转换读取器，
	// 将给定字符集转换为 UTF-8。
	// 字符集始终为小写。utf-8、iso-8859-1 和 us-ascii 字符集由默认处理。
	// CharsetReader 的其中一个结果值必须非 nil。
	CharsetReader func(charset string, input io.Reader) (io.Reader, error)
}

WordDecoder 解码包含 RFC 2047 编码字词的 MIME 头部。

func (*WordDecoder) Decode

func (d *WordDecoder) Decode(word string) (string, error)

Decode 解码一个 RFC 2047 编码字词。

Example 
package main

import (
	"bytes"
	"fmt"
	"io"
	"mime"
)

func main() {
	dec := new(mime.WordDecoder)
	header, err := dec.Decode("=?utf-8?q?=C2=A1Hola,_se=C3=B1or!?=")
	if err != nil {
		panic(err)
	}
	fmt.Println(header)

	dec.CharsetReader = func(charset string, input io.Reader) (io.Reader, error) {
		switch charset {
		case "x-case":
			// Fake character set for example.
			// Real use would integrate with packages such
			// as code.google.com/p/go-charset
			content, err := io.ReadAll(input)
			if err != nil {
				return nil, err
			}
			return bytes.NewReader(bytes.ToUpper(content)), nil
		default:
			return nil, fmt.Errorf("unhandled charset %q", charset)
		}
	}
	header, err = dec.Decode("=?x-case?q?hello!?=")
	if err != nil {
		panic(err)
	}
	fmt.Println(header)
}

Output:

¡Hola, señor!
HELLO!

func (*WordDecoder) DecodeHeader

func (d *WordDecoder) DecodeHeader(header string) (string, error)

DecodeHeader 解码给定字符串中的所有编码字词。 当且仅当 d 的 WordDecoder.CharsetReader 返回错误时，该函数才返回错误。

Example 
package main

import (
	"bytes"
	"fmt"
	"io"
	"mime"
)

func main() {
	dec := new(mime.WordDecoder)
	header, err := dec.DecodeHeader("=?utf-8?q?=C3=89ric?= <eric@example.org>, =?utf-8?q?Ana=C3=AFs?= <anais@example.org>")
	if err != nil {
		panic(err)
	}
	fmt.Println(header)

	header, err = dec.DecodeHeader("=?utf-8?q?=C2=A1Hola,?= =?utf-8?q?_se=C3=B1or!?=")
	if err != nil {
		panic(err)
	}
	fmt.Println(header)

	dec.CharsetReader = func(charset string, input io.Reader) (io.Reader, error) {
		switch charset {
		case "x-case":
			// Fake character set for example.
			// Real use would integrate with packages such
			// as code.google.com/p/go-charset
			content, err := io.ReadAll(input)
			if err != nil {
				return nil, err
			}
			return bytes.NewReader(bytes.ToUpper(content)), nil
		default:
			return nil, fmt.Errorf("unhandled charset %q", charset)
		}
	}
	header, err = dec.DecodeHeader("=?x-case?q?hello_?= =?x-case?q?world!?=")
	if err != nil {
		panic(err)
	}
	fmt.Println(header)
}

Output:

Éric <eric@example.org>, Anaïs <anais@example.org>
¡Hola, señor!
HELLO WORLD!

type WordEncoder

type WordEncoder byte

WordEncoder 是 RFC 2047 编码字词编码器。

func (WordEncoder) Encode

func (e WordEncoder) Encode(charset, s string) string

Encode 返回 s 的编码字词形式。若 s 为纯 ASCII 且无特殊字符，则原样返回。 所提供的 charset 为 s 的 IANA 字符集名称，不区分大小写。

Example 
package main

import (
	"fmt"
	"mime"
)

func main() {
	fmt.Println(mime.QEncoding.Encode("utf-8", "¡Hola, señor!"))
	fmt.Println(mime.QEncoding.Encode("utf-8", "Hello!"))
	fmt.Println(mime.BEncoding.Encode("UTF-8", "¡Hola, señor!"))
	fmt.Println(mime.QEncoding.Encode("ISO-8859-1", "Caf\xE9"))
}

Output:

=?utf-8?q?=C2=A1Hola,_se=C3=B1or!?=
Hello!
=?UTF-8?b?wqFIb2xhLCBzZcOxb3Ih?=
=?ISO-8859-1?q?Caf=E9?=

Directories

multipart Package multipart 实现 MIME 多部分解析，如 RFC 2046 所定义。
quotedprintable Package quotedprintable implements quoted-printable encoding as specified by RFC 2045.