email

Documentation

Index

• type BrevoProvider
  • func NewBrevoProvider(config *config.NotificationConfiguration) *BrevoProvider
  • func (b *BrevoProvider) GetName() string
  • func (b *BrevoProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
  • func (b *BrevoProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)
• type EmailProvider
• type EmailService
  • func NewEmailService() *EmailService
  • func (e *EmailService) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
  • func (e *EmailService) SendKYBApprovalEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendKYBRejectionEmail(ctx context.Context, email, firstName, reasonForDecline string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendPasswordResetEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendVerificationEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendWebhookFailureEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)
  • func (e *EmailService) SendWelcomeEmail(ctx context.Context, email, firstName string, scopes []string) (types.SendEmailResponse, error)
• type EmailServiceInterface
  • func NewEmailServiceWithProviders() EmailServiceInterface
• type MailgunProvider
  • func NewMailgunProvider(config *config.NotificationConfiguration) *MailgunProvider
  • func (m *MailgunProvider) GetName() string
  • func (m *MailgunProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
  • func (m *MailgunProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)
• type ProviderFactory
  • func NewProviderFactory(config *config.NotificationConfiguration) *ProviderFactory
  • func (pf *ProviderFactory) CreateProvider(providerName string) (EmailProvider, error)
  • func (pf *ProviderFactory) GetDefaultProvider() (EmailProvider, error)
• type SendGridProvider
  • func NewSendGridProvider(config *config.NotificationConfiguration) *SendGridProvider
  • func (s *SendGridProvider) GetName() string
  • func (s *SendGridProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
  • func (s *SendGridProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)

Types

type BrevoProvider

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

BrevoProvider implements EmailProvider for Brevo

func NewBrevoProvider

func NewBrevoProvider(config *config.NotificationConfiguration) *BrevoProvider

NewBrevoProvider creates a new Brevo provider

func (*BrevoProvider) GetName

func (b *BrevoProvider) GetName() string

GetName returns the provider name

func (*BrevoProvider) SendEmail

func (b *BrevoProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)

SendEmail sends an email via Brevo

func (*BrevoProvider) SendTemplateEmail

func (b *BrevoProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)

SendTemplateEmail sends a template email via Brevo

type EmailProvider

type EmailProvider interface {
	SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
	SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)
	GetName() string
}

EmailProvider defines the interface for email providers

type EmailService

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

EmailService provides functionality for sending emails with provider abstraction and fallback support

func NewEmailService

func NewEmailService() *EmailService

NewEmailService creates a new EmailService with dynamic provider selection

func (*EmailService) SendEmail

func (e *EmailService) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)

SendEmail sends an email with fallback support

func (*EmailService) SendKYBApprovalEmail

func (e *EmailService) SendKYBApprovalEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)

SendKYBApprovalEmail sends a KYB approval email

func (*EmailService) SendKYBRejectionEmail

func (e *EmailService) SendKYBRejectionEmail(ctx context.Context, email, firstName, reasonForDecline string) (types.SendEmailResponse, error)

SendKYBRejectionEmail sends a KYB rejection email

func (*EmailService) SendPasswordResetEmail

func (e *EmailService) SendPasswordResetEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)

SendPasswordResetEmail sends a password reset email

func (*EmailService) SendTemplateEmail

func (e *EmailService) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)

SendTemplateEmail sends a template email with fallback support

func (*EmailService) SendVerificationEmail

func (e *EmailService) SendVerificationEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)

SendVerificationEmail sends a verification email

func (*EmailService) SendWebhookFailureEmail

func (e *EmailService) SendWebhookFailureEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)

SendWebhookFailureEmail sends a webhook failure notification email

func (*EmailService) SendWelcomeEmail

func (e *EmailService) SendWelcomeEmail(ctx context.Context, email, firstName string, scopes []string) (types.SendEmailResponse, error)

SendWelcomeEmail sends a welcome email

type EmailServiceInterface

type EmailServiceInterface interface {
	SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)
	SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)
	SendVerificationEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)
	SendPasswordResetEmail(ctx context.Context, token, email, firstName string) (types.SendEmailResponse, error)
	SendWelcomeEmail(ctx context.Context, email, firstName string, scopes []string) (types.SendEmailResponse, error)
	SendKYBApprovalEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)
	SendKYBRejectionEmail(ctx context.Context, email, firstName, reasonForDecline string) (types.SendEmailResponse, error)
	SendWebhookFailureEmail(ctx context.Context, email, firstName string) (types.SendEmailResponse, error)
}

EmailServiceInterface provides the interface for the email service

func NewEmailServiceWithProviders

func NewEmailServiceWithProviders() EmailServiceInterface

NewEmailServiceWithProviders creates a new email service with dynamic provider selection

type MailgunProvider

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

MailgunProvider implements EmailProvider for Mailgun

func NewMailgunProvider

func NewMailgunProvider(config *config.NotificationConfiguration) *MailgunProvider

NewMailgunProvider creates a new Mailgun provider

func (*MailgunProvider) GetName

func (m *MailgunProvider) GetName() string

GetName returns the provider name

func (*MailgunProvider) SendEmail

func (m *MailgunProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)

SendEmail sends an email via Mailgun

func (*MailgunProvider) SendTemplateEmail

func (m *MailgunProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)

SendTemplateEmail sends a template email via Mailgun

type ProviderFactory

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

ProviderFactory creates email providers based on configuration

func NewProviderFactory

func NewProviderFactory(config *config.NotificationConfiguration) *ProviderFactory

NewProviderFactory creates a new provider factory

func (*ProviderFactory) CreateProvider

func (pf *ProviderFactory) CreateProvider(providerName string) (EmailProvider, error)

CreateProvider creates an email provider based on the provider name

func (*ProviderFactory) GetDefaultProvider

func (pf *ProviderFactory) GetDefaultProvider() (EmailProvider, error)

GetDefaultProvider returns the default provider based on configuration

type SendGridProvider

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

SendGridProvider implements EmailProvider for SendGrid

func NewSendGridProvider

func NewSendGridProvider(config *config.NotificationConfiguration) *SendGridProvider

NewSendGridProvider creates a new SendGrid provider

func (*SendGridProvider) GetName

func (s *SendGridProvider) GetName() string

GetName returns the provider name

func (*SendGridProvider) SendEmail

func (s *SendGridProvider) SendEmail(ctx context.Context, payload types.SendEmailPayload) (types.SendEmailResponse, error)

SendEmail sends an email via SendGrid

func (*SendGridProvider) SendTemplateEmail

func (s *SendGridProvider) SendTemplateEmail(ctx context.Context, payload types.SendEmailPayload, templateID string) (types.SendEmailResponse, error)

SendTemplateEmail sends a template email via SendGrid