mail.md

发送邮件

[[toc]]

简介

Goravel 可以使用 facades.Mail() 便捷的在本地发送邮件。

配置

在发送邮件前，需要先对 config/mail.go 配置文件进行配置。

发送邮件

import "github.com/goravel/framework/mail"

err := facades.Mail().To([]string{"[email protected]"}).
  Cc([]string{"[email protected]"}).
  Bcc([]string{"[email protected]"}).
  Attach([]string{"file.png"}).
  Content(mail.Html("<h1>Hello Goravel</h1>")).
  Subject("Subject").
  Send()

以队列发送邮件

import "github.com/goravel/framework/mail"

err := facades.Mail().To([]string{"[email protected]"}).
  Cc([]string{"[email protected]"}).
  Bcc([]string{"[email protected]"}).
  Attach([]string{"file.png"}).
  Content(mail.Html("<h1>Hello Goravel</h1>")).
  Subject("Subject").
  Queue()

也可以自定义队列

import "github.com/goravel/framework/mail"

err := facades.Mail().To([]string{"[email protected]"}).
  Cc([]string{"[email protected]"}).
  Bcc([]string{"[email protected]"}).
  Attach([]string{"file.png"}).
  Content(mail.Html("<h1>Hello Goravel</h1>")).
  Subject("Subject").
  Queue(mail.Queue().Connection("high").Queue("mail"))

设置发件人

默认框架会使用 config/mail.go 配置文件中的 MAIL_FROM_ADDRESS 与 MAIL_FROM_NAME 作为全局发件人，你也可以自定义发件人，但需要注意发送邮箱需要与配置的 STMP 保持一致：

import "github.com/goravel/framework/mail"

err := facades.Mail().To([]string{"[email protected]"}).
  From(mail.Address(testFromAddress, testFromName)).
  Cc([]string{"[email protected]"}).
  Bcc([]string{"[email protected]"}).
  Attach([]string{"file.png"}).
  Content(mail.Html("<h1>Hello Goravel</h1>")).
  Subject("Subject").
  Queue(mail.Queue().Connection("high").Queue("mail"))

使用 Mailable

邮件的所有参数都可以在一个 Mailable struct 中设置。这些 struct 存储在 app/mails 目录中。可以通过 make:mail Artisan 命令快速创建一个 Mailable：

go run . artisan make:mail OrderShipped

生成的 OrderShipped struct 如下：

import "github.com/goravel/framework/contracts/mail"

type OrderShipped struct {
}

func NewOrderShipped() *OrderShipped {
	return &OrderShipped{}
}

func (m *OrderShipped) Attachments() []string {
	return []string{"../logo.png"}
}

func (m *OrderShipped) Content() *mail.Content {
	return &mail.Content{Html: "<h1>Hello Goravel</h1>"}
}

func (m *OrderShipped) Envelope() *mail.Envelope {
	return &mail.Envelope{
		Bcc:     []string{"[email protected]"},
		Cc:      []string{"[email protected]"},
		From:    mail.From{Address: "[email protected]", Name: "from"},
		Subject: "Goravel",
		To:      []string{"[email protected]"},
	}
}

func (m *OrderShipped) Queue() *mail.Queue {
  return &mail.Queue{
    Connection: "high",
    Queue:      "mail",
  }
}

然后可以就可以在 Send 与 Queue 方法中使用该 Mailalbe：

err := facades.Mail().Send(mails.NewOrderShipped())
err := facades.Mail().Queue(mails.NewOrderShipped())