aliyun

Documentation

Index

• Constants
• type Aliyun
  • func MustNewAliyun(c Config, opts ...notifytypes.Option) *Aliyun
  • func NewAliyun(c Config, opts ...notifytypes.Option) (*Aliyun, error)
  • func (a *Aliyun) LoadEmailExtraMap(eem map[string]EmailExtra)
  • func (a *Aliyun) Platform() string
  • func (a *Aliyun) SendEmail(receiver, templateID string, params ...notifytypes.Param) error
  • func (a *Aliyun) SendSms(receiver, templateID string, params ...notifytypes.Param) error
• type App
• type Config
• type EmailExtra

Constants

const (
	// PlatformAliyun 阿里云通知平台
	PlatformAliyun = "aliyun"
)

Types

type Aliyun

type Aliyun struct {
	// contains filtered or unexported fields
}

Aliyun 阿里云通知服务

func MustNewAliyun

func MustNewAliyun(c Config, opts ...notifytypes.Option) *Aliyun

MustNewAliyun 新建阿里云通知服务

func NewAliyun

func NewAliyun(c Config, opts ...notifytypes.Option) (*Aliyun, error)

NewAliyun 新建阿里云通知服务

func (*Aliyun) LoadEmailExtraMap

func (a *Aliyun) LoadEmailExtraMap(eem map[string]EmailExtra)

LoadEmailExtraMap 加载邮件额外信息映射

func (*Aliyun) Platform

func (a *Aliyun) Platform() string

Platform 服务平台

func (*Aliyun) SendEmail

func (a *Aliyun) SendEmail(receiver, templateID string, params ...notifytypes.Param) error

SendEmail 发送邮件

func (*Aliyun) SendSms

func (a *Aliyun) SendSms(receiver, templateID string, params ...notifytypes.Param) error

SendSms 发送短信

type App

type App struct {
	RegionID        string `json:",default=cn-hangzhou"` // 地域ID
	AccessKeyID     string // 访问鉴权ID
	AccessKeySecret string // 访问鉴权私钥
	SignName        string // 签名名称
	AccountName     string `json:",optional"` // 发信地址（邮件应用使用）
}

App 应用配置

type Config

type Config struct {
	Sms   *App // 短信应用配置
	Email *App // 邮件应用配置
}

Config 阿里云通知服务配置

type EmailExtra

type EmailExtra struct {
	Subject  string `json:"subject"`   // 邮件标题
	TextBody string `json:"text_body"` // 邮件text正文
}

EmailExtra 邮件额外信息