email

Documentation

Overview

Package email supports sending emails.

Index

• type Client
  • func NewClient(emailProvider email.Provider, taskManager asynctask.Manager, ...) Client
• type MockClient
  • func NewMockClient(t mockConstructorTestingTNewMockClient) *MockClient
  • func (_m *MockClient) SendMail(ctx context.Context, input *SendMailInput)
• type SendMailInput

Types

type Client

type Client interface {
	SendMail(ctx context.Context, input *SendMailInput)
}

Client is used for sending emails

func NewClient

func NewClient(emailProvider email.Provider, taskManager asynctask.Manager, dbClient *db.Client, logger logger.Logger, frontendURL string, emailFooter string) Client

NewClient returns a new client

type MockClient

type MockClient struct {
	mock.Mock
}

MockClient is an autogenerated mock type for the Client type

func NewMockClient

func NewMockClient(t mockConstructorTestingTNewMockClient) *MockClient

NewMockClient creates a new instance of MockClient. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.

func (*MockClient) SendMail

func (_m *MockClient) SendMail(ctx context.Context, input *SendMailInput)

SendMail provides a mock function with given fields: ctx, input

type SendMailInput

type SendMailInput struct {
	UsersIDs       []string
	TeamsIDs       []string
	ExcludeUserIDs []string
	Subject        string
	Builder        builder.EmailBuilder
}

SendMailInput is the input for sending an email