目录 搜索
archive archive/tar archive/zip bufio bufio(缓存) builtin builtin(内置包) bytes bytes(包字节) compress compress/bzip2(压缩/bzip2) compress/flate(压缩/flate) compress/gzip(压缩/gzip) compress/lzw(压缩/lzw) compress/zlib(压缩/zlib) container container/heap(容器数据结构heap) container/list(容器数据结构list) container/ring(容器数据结构ring) context context(上下文) crypto crypto(加密) crypto/aes(加密/aes) crypto/cipher(加密/cipher) crypto/des(加密/des) crypto/dsa(加密/dsa) crypto/ecdsa(加密/ecdsa) crypto/elliptic(加密/elliptic) crypto/hmac(加密/hmac) crypto/md5(加密/md5) crypto/rand(加密/rand) crypto/rc4(加密/rc4) crypto/rsa(加密/rsa) crypto/sha1(加密/sha1) crypto/sha256(加密/sha256) crypto/sha512(加密/sha512) crypto/subtle(加密/subtle) crypto/tls(加密/tls) crypto/x509(加密/x509) crypto/x509/pkix(加密/x509/pkix) database database/sql(数据库/sql) database/sql/driver(数据库/sql/driver) debug debug/dwarf(调试/dwarf) debug/elf(调试/elf) debug/gosym(调试/gosym) debug/macho(调试/macho) debug/pe(调试/pe) debug/plan9obj(调试/plan9obj) encoding encoding(编码) encoding/ascii85(编码/ascii85) encoding/asn1(编码/asn1) encoding/base32(编码/base32) encoding/base64(编码/base64) encoding/binary(编码/binary) encoding/csv(编码/csv) encoding/gob(编码/gob) encoding/hex(编码/hex) encoding/json(编码/json) encoding/pem(编码/pem) encoding/xml(编码/xml) errors errors(错误) expvar expvar flag flag(命令行参数解析flag包) fmt fmt go go/ast(抽象语法树) go/build go/constant(常量) go/doc(文档) go/format(格式) go/importer go/parser go/printer go/scanner(扫描仪) go/token(令牌) go/types(类型) hash hash(散列) hash/adler32 hash/crc32 hash/crc64 hash/fnv html html html/template(模板) image image(图像) image/color(颜色) image/color/palette(调色板) image/draw(绘图) image/gif image/jpeg image/png index index/suffixarray io io io/ioutil log log log/syslog(日志系统) math math math/big math/big math/bits math/bits math/cmplx math/cmplx math/rand math/rand mime mime mime/multipart(多部分) mime/quotedprintable net net net/http net/http net/http/cgi net/http/cookiejar net/http/fcgi net/http/httptest net/http/httptrace net/http/httputil net/http/internal net/http/pprof net/mail net/mail net/rpc net/rpc net/rpc/jsonrpc net/smtp net/smtp net/textproto net/textproto net/url net/url os os os/exec os/signal os/user path path path/filepath(文件路径) plugin plugin(插件) reflect reflect(反射) regexp regexp(正则表达式) regexp/syntax runtime runtime(运行时) runtime/debug(调试) runtime/internal/sys runtime/pprof runtime/race(竞争) runtime/trace(执行追踪器) sort sort(排序算法) strconv strconv(转换) strings strings(字符串) sync sync(同步) sync/atomic(原子操作) syscall syscall(系统调用) testing testing(测试) testing/iotest testing/quick text text/scanner(扫描文本) text/tabwriter text/template(定义模板) text/template/parse time time(时间戳) unicode unicode unicode/utf16 unicode/utf8 unsafe unsafe
文字

  • import "net/smtp"

  • 概观

  • 索引

  • 示例

概观

smtp 包实现了RFC 5321中定义的简单邮件传输协议。它还实现了以下扩展:

8BITMIME  RFC 1652AUTH      RFC 2554STARTTLS  RFC 3207

其他扩展可能由客户端处理。

smtp 软件包被冻结,不接受新的功能。一些外部软件包提供更多功能。看到:

https://godoc.org/?q=smtp

示例

编码:

// Connect to the remote SMTP server.c, err := smtp.Dial("mail.example.com:25")if err != nil {
        log.Fatal(err)}// Set the sender and recipient firstif err := c.Mail("sender@example.org"); err != nil {
        log.Fatal(err)}if err := c.Rcpt("recipient@example.net"); err != nil {
        log.Fatal(err)}// Send the email body.wc, err := c.Data()if err != nil {
        log.Fatal(err)}_, err = fmt.Fprintf(wc, "This is the email body")if err != nil {
        log.Fatal(err)}err = wc.Close()if err != nil {
        log.Fatal(err)}// Send the QUIT command and close the connection.err = c.Quit()if err != nil {
        log.Fatal(err)}

索引

  • func SendMail(addr string, a Auth, from string, to []string, msg []byte) error

  • type Auth

  • func CRAMMD5Auth(username, secret string) Auth

  • func PlainAuth(identity, username, password, host string) Auth

  • type Client

  • func Dial(addr string) (*Client, error)

  • func NewClient(conn net.Conn, host string) (*Client, error)

  • func (c *Client) Auth(a Auth) error

  • func (c *Client) Close() error

  • func (c *Client) Data() (io.WriteCloser, error)

  • func (c *Client) Extension(ext string) (bool, string)

  • func (c *Client) Hello(localName string) error

  • func (c *Client) Mail(from string) error

  • func (c *Client) Quit() error

  • func (c *Client) Rcpt(to string) error

  • func (c *Client) Reset() error

  • func (c *Client) StartTLS(config *tls.Config) error

  • func (c *Client) TLSConnectionState() (state tls.ConnectionState, ok bool)

  • func (c *Client) Verify(addr string) error

  • type ServerInfo

示例

打包 PlainAuth SendMail

打包文件

auth.go smtp.go

func SendMail

func SendMail(addr string, a Auth, from string, to []string, msg []byte) error

SendMail 在 addr 连接到服务器,如果可能的话,切换到 TLS,如果可能,使用可选机制进行身份验证,然后使用消息 msg 从地址发送到地址的电子邮件。addr 必须包含一个端口,如“mail.example.com:smtp”中所示。

to 参数中的地址是 SMTP RCPT 地址。

msg 参数应该是一个 RFC 822 风格的电子邮件,首先包含标题,空白行,然后是邮件正文。msg 的行应该是 CRLF 终止的。 msg 标题通常应包含“From”,“To”,“Subject”和“Cc”等字段。发送“密件抄送”邮件是通过在 to 参数中包含一个电子邮件地址来完成的,但不包括在msg头文件中。

SendMail 函数和 net / smtp 包是低级机制,不支持 DKIM 签名,MIME 附件(请参阅mime / multipart包)或其他邮件功能。更高级别的软件包存在于标准库之外。

示例

package mainimport ("log""net/smtp")func main() {// Set up authentication information.
	auth := smtp.PlainAuth("", "user@example.com", "password", "mail.example.com")// Connect to the server, authenticate, set the sender and recipient,// and send the email all in one step.
	to := []string{"recipient@example.net"}
	msg := []byte("To: recipient@example.net\r\n" +"Subject: discount Gophers!\r\n" +"\r\n" +"This is the email body.\r\n")
	err := smtp.SendMail("mail.example.com:25", auth, "sender@example.org", to, msg)if err != nil {
		log.Fatal(err)}}

type Auth

身份验证通过 SMTP 身份验证机制实施。

type Auth interface {        // Start begins an authentication with a server.        // It returns the name of the authentication protocol        // and optionally data to include in the initial AUTH message        // sent to the server. It can return proto == "" to indicate        // that the authentication should be skipped.        // If it returns a non-nil error, the SMTP client aborts        // the authentication attempt and closes the connection.        Start(server *ServerInfo) (proto string, toServer []byte, err error)        // Next continues the authentication. The server has just sent        // the fromServer data. If more is true, the server expects a        // response, which Next should return as toServer; otherwise        // Next should return toServer == nil.        // If Next returns a non-nil error, the SMTP client aborts        // the authentication attempt and closes the connection.        Next(fromServer []byte, more bool) (toServer []byte, err error)}

func CRAMMD5Auth

func CRAMMD5Auth(username, secret string) Auth

CRAMMD5Auth 返回一个Auth,它实现 RFC 2195 中定义的 CRAM-MD5 认证机制。返回的 Auth 使用给定的用户名和密码使用质询 - 响应机制向服务器进行认证。

func PlainAuth

func PlainAuth(identity, username, password, host string) Auth

PlainAuth 返回一个 Auth,它实现 RFC 4616 中定义的 PLAIN 身份验证机制。返回的 Auth 使用给定的用户名和密码对主机进行身份验证,并充当身份。通常身份应该是空字符串,充当用户名。

如果连接使用 TLS 或连接到本地主机,PlainAuth 将仅发送凭据。否则,身份验证将失败并出现错误,而不会发送凭据。

示例

编码:

// hostname is used by PlainAuth to validate the TLS certificate.hostname := "mail.example.com"auth := smtp.PlainAuth("", "user@example.com", "password", hostname)err := smtp.SendMail(hostname+":25", auth, from, recipients, msg)if err != nil {
        log.Fatal(err)}

type Client

客户端代表到 SMTP 服务器的客户端连接。

type Client struct {        // Text is the textproto.Conn used by the Client. It is exported to allow for        // clients to add extensions.
        Text *textproto.Conn        // contains filtered or unexported fields}

func Dial

func Dial(addr string) (*Client, error)

Dial 返回一个新的连接到 SMTP 服务器的客户端。 addr 必须包含一个端口,如“mail.example.com:smtp”中所示。

func NewClient

func NewClient(conn net.Conn, host string) (*Client, error)

NewClient 使用现有连接和主机作为服务器名称返回一个新的客户端,以便在进行身份验证时使用。

func (*Client) Auth

func (c *Client) Auth(a Auth) error

Auth 使用提供的认证机制来认证客户端。认证失败将关闭连接。只有通告 AUTH 扩展的服务器才支持此功能。

func (*Client) Close

func (c *Client) Close() error

Close 关闭连接。

func (*Client) Data

func (c *Client) Data() (io.WriteCloser, error)

数据向服务器发出 DATA 命令并返回可用于写入邮件标题和正文的编写器。调用者应该在调用c上的更多方法之前关闭作者。对数据的调用必须在一个或多个对 Rcpt 的调用之前进行。

func (*Client) Extension

func (c *Client) Extension(ext string) (bool, string)

Extension 报告扩展是否受服务器支持。扩展名不区分大小写。如果支持扩展,Extension 还会返回一个字符串,其中包含服务器为扩展指定的任何参数。

func (*Client) Hello

func (c *Client) Hello(localName string) error

Hello 将 HELO 或 EHLO 作为给定的主机名称发送到服务器。仅当客户端需要控制所使用的主机名称时才需要调用此方法。否则客户端会自动将自身介绍为“本地主机”。如果调用 Hello,则必须在任何其他方法之前调用它。

func (*Client) Mail

func (c *Client) Mail(from string) error

邮件使用提供的电子邮件地址向服务器发出MAIL 命令。如果服务器支持 8BITMIME 扩展,则 Mail 会添加 BODY = 8BITMIME 参数。这将启动一个邮件事务,然后是一个或多个 Rcpt 调用。

func (*Client) Quit

func (c *Client) Quit() error

退出发送 QUIT 命令并关闭连接到服务器。

func (*Client) Rcpt

func (c *Client) Rcpt(to string) error

Rcpt 使用提供的电子邮件地址向服务器发出 RCPT 命令。对 Rcpt 的调用必须在对 Mail 的调用之后进行,然后可以进行数据调用或其他 Rcpt 调用。

func (*Client) Reset

func (c *Client) Reset() error

重置将 RSET 命令发送到服务器,中止当前的邮件事务。

func (*Client) StartTLS

func (c *Client) StartTLS(config *tls.Config) error

StartTLS 发送 STARTTLS 命令并加密所有进一步的通信。只有通告 STARTTLS 扩展的服务器才支持此功能。

func (*Client) TLSConnectionState

func (c *Client) TLSConnectionState() (state tls.ConnectionState, ok bool)

TLSConnectionState 返回客户端的 TLS 连接状态。如果 StartTLS 不成功,则返回值为零值。

func (*Client) Verify

func (c *Client) Verify(addr string) error

验证检查服务器上电子邮件地址的有效性。如果验证返回 nil ,则地址有效。非零返回不一定表示无效地址。出于安全原因,许多服务器不会验证地址。

type ServerInfo

ServerInfo 记录有关 SMTP 服务器的信息。

type ServerInfo struct {
        Name string   // SMTP server name
        TLS  bool     // using TLS, with valid certificate for Name
        Auth []string // advertised authentication mechanisms}
上一篇: 下一篇: