mail

type Attachment ¶

type Attachment struct {
	Name    string
	Content []byte
	MIME    string
}

Attachment represents a file attached to an email.

type LogMailer ¶

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

LogMailer implements the Mailer interface by writing emails to a local file/log.

func NewLogMailer(logDir string) *LogMailer

func (m *LogMailer) Send(ctx context.Context, msg *Message) error

type Mailable ¶

type Mailable interface {
	// Subject returns the email subject line.
	Subject() string
	// From returns the sender address (overrides mailer default if non-empty).
	From() string
	// To returns the list of recipient addresses.
	To() []string
	// Template returns the template name (without extension) relative to the
	// email template directory (e.g. "emails/welcome").
	Template() string
	// Data returns the template data map.
	Data() map[string]any
}

Mailable is the interface for structured, layout-aware HTML emails. Implement this to get automatic layout wrapping, data interpolation, and seamless integration with the notification package.

Example:

type WelcomeMail struct {
    User schema.User
}

func (m *WelcomeMail) Subject() string         { return "Welcome to Astra!" }
func (m *WelcomeMail) From() string            { return "noreply@example.com" }
func (m *WelcomeMail) To() []string            { return []string{m.User.Email} }
func (m *WelcomeMail) Template() string        { return "emails/welcome" }
func (m *WelcomeMail) Data() map[string]any    { return map[string]any{"User": m.User} }

type MailableLayout ¶

type MailableLayout interface {
	Mailable
	// Layout returns the layout template name relative to the email template
	// directory (e.g. "layouts/email"). Return "" to disable layout.
	Layout() string
}

MailableLayout optionally implemented by a Mailable to override the layout. If not implemented, the mailer's default layout is used.

type MailableSender ¶

type MailableSender interface {
	SendMailable(m Mailable) error
}

MailableSender can send Mailable instances. Combine with TemplateMailer to get HTML rendering + delivery.

type Mailer ¶

type Mailer interface {
	Send(ctx context.Context, msg *Message) error
}

Mailer defines the interface for sending emails.

type Message ¶

type Message struct {
	From        string
	To          []string
	Subject     string
	Body        string
	HTML        string
	Attachments []Attachment
}

Message represents an email message.

type QueuedMailPayload ¶

type QueuedMailPayload struct {
	Message *Message
	Driver  string
}

QueuedMailPayload holds the data for a background email task.

type ResendMailer ¶

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

ResendMailer implements the Mailer interface using Resend.com.

func NewResendMailer(cfg config.MailConfig, emitter *event.Emitter) *ResendMailer

func (m *ResendMailer) Send(ctx context.Context, msg *Message) error

type SMTPMailer ¶

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

SMTPMailer implements the Mailer interface using SMTP.

func NewSMTPMailer(cfg config.MailConfig, emitter *event.Emitter) *SMTPMailer

func (m *SMTPMailer) Send(ctx context.Context, msg *Message) error

type TemplateMailer ¶

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

TemplateMailer wraps a base Mailer and adds HTML template rendering for Mailable.

func NewTemplateMailer(base Mailer, opts ...TemplateMailerOption) *TemplateMailer

func (tm *TemplateMailer) QueueMailable(m Mailable) (*queue.GenericJob[QueuedMailPayload], error)

func (tm *TemplateMailer) Send(ctx context.Context, msg *Message) error

func (tm *TemplateMailer) SendMailable(m Mailable) (*Message, error)

type TemplateMailerOption ¶

type TemplateMailerOption func(*TemplateMailer)

TemplateMailerOption configures a TemplateMailer.

func WithDefaultFrom(from string) TemplateMailerOption

func WithDefaultLayout(layout string) TemplateMailerOption

func WithMailExtension(ext string) TemplateMailerOption

func WithMailFS(filesystem fs.FS) TemplateMailerOption

type TemplateRenderer ¶

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

TemplateRenderer handles HTML email templates.

func NewTemplateRenderer(fileSystem fs.FS) *TemplateRenderer

func (r *TemplateRenderer) Render(name string, data any) (string, error)