notification

package

Go to main page

Versions in this module

v0

v0.0.14

Jan 4, 2026

v0.0.13

Jan 3, 2026

v0.0.12

Jan 3, 2026

v0.0.11

Jan 3, 2026

v0.0.10

Jan 3, 2026

v0.0.9

Jan 3, 2026

v0.0.8

Dec 31, 2025

v0.0.7

Dec 29, 2025

Changes in this version

+ type AsyncAdapter struct

+ func NewAsyncAdapter(adapter *Adapter, config AsyncConfig, dispatcher *notification.Dispatcher, ...) *AsyncAdapter

+ func (a *AsyncAdapter) SendAccountDeleted(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *AsyncAdapter) SendAccountReactivated(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *AsyncAdapter) SendAccountSuspended(ctx context.Context, appID xid.ID, email, userName, reason, timestamp string) error

+ func (a *AsyncAdapter) SendAllSessionsRevoked(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *AsyncAdapter) SendDeviceRemoved(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendEmailChangeRequest(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendEmailChanged(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendEmailOTP(ctx context.Context, appID xid.ID, email, code string, expiryMinutes int) error

+ func (a *AsyncAdapter) SendMFACode(ctx context.Context, appID xid.ID, recipient, code string, expiryMinutes int, ...) error

+ func (a *AsyncAdapter) SendMagicLink(ctx context.Context, appID xid.ID, email, userName, magicLink string, ...) error

+ func (a *AsyncAdapter) SendNewDeviceLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendNewLocationLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendOrgInvite(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendOrgMemberAdded(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendOrgMemberRemoved(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendPasswordChanged(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *AsyncAdapter) SendPasswordReset(ctx context.Context, appID xid.ID, email, userName, resetURL, resetCode string, ...) error

+ func (a *AsyncAdapter) SendPhoneOTP(ctx context.Context, appID xid.ID, phone, code string) error

+ func (a *AsyncAdapter) SendSecurityAlert(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendSuspiciousLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendUsernameChanged(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendVerificationEmail(ctx context.Context, appID xid.ID, ...) error

+ func (a *AsyncAdapter) SendWelcomeEmail(ctx context.Context, appID xid.ID, email, userName, loginURL string) error

+ type AsyncConfig struct

+ Enabled bool

+ MaxRetries int

+ PersistFailures bool

+ QueueSize int

+ RetryBackoff []string

+ RetryEnabled bool

+ WorkerPoolSize int

type Config

+ Async AsyncConfig

+ type DeclareABTestWinnerRequest struct

+ TemplateID string

+ type DeleteProviderRequest struct

+ ID string

+ type DeleteTemplateRequest struct

+ ID string

+ type GetABTestResultsRequest struct

+ TemplateID string

+ type GetNotificationRequest struct

+ ID string

+ type GetProviderRequest struct

+ ID string

+ type GetTemplateAnalyticsRequest struct

+ TemplateID string

+ type GetTemplateRequest struct

+ ID string

+ type GetTemplateVersionRequest struct

+ TemplateID string

+ VersionID string

type Plugin

+ func (p *Plugin) Stop()

+ type PreviewTemplateRequest struct

+ ID string

+ type RenderTemplateRequest struct

+ ID string

+ type ResendNotificationRequest struct

+ ID string

+ type ResetTemplateRequest struct

+ ID string

+ type RestoreTemplateVersionRequest struct

+ TemplateID string

+ VersionID string

+ type UpdateProviderRequest struct

+ ID string

+ type UpdateTemplateRequest struct

+ ID string

v0.0.6

Dec 17, 2025

Changes in this version

+ type AccountAutoSendConfig struct

+ Deleted bool

+ EmailChangeRequest bool

+ EmailChanged bool

+ PasswordChanged bool

+ Reactivated bool

+ Suspended bool

+ UsernameChanged bool

type Adapter

+ func (a *Adapter) SendAccountDeleted(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *Adapter) SendAccountReactivated(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *Adapter) SendAccountSuspended(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendAllSessionsRevoked(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *Adapter) SendDeviceRemoved(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendEmailChangeRequest(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendEmailChanged(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendNewDeviceLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendNewLocationLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgDeleted(ctx context.Context, appID xid.ID, recipientEmail, userName, orgName string) error

+ func (a *Adapter) SendOrgInvite(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgMemberAdded(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgMemberLeft(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgMemberRemoved(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgRoleChanged(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendOrgTransfer(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendPasswordChanged(ctx context.Context, appID xid.ID, recipientEmail, userName, timestamp string) error

+ func (a *Adapter) SendSuspiciousLogin(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendUsernameChanged(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) WithAppName(name string) *Adapter

+ func (a *Adapter) WithAppService(appSvc interface{}) *Adapter

+ type AuthAutoSendConfig struct

+ EmailOTP bool

+ MFACode bool

+ MagicLink bool

+ PasswordReset bool

+ VerificationEmail bool

+ Welcome bool

+ type AutoSendConfig struct

+ Account AccountAutoSendConfig

+ Auth AuthAutoSendConfig

+ Organization OrganizationAutoSendConfig

+ Session SessionAutoSendConfig

type Config

+ AppName string

+ AutoSend AutoSendConfig

type DashboardExtension

+ func (e *DashboardExtension) HandleUpdateSettings(c forge.Context) error

+ type OrganizationAutoSendConfig struct

+ Deleted bool

+ Invite bool

+ MemberAdded bool

+ MemberLeft bool

+ MemberRemoved bool

+ RoleChanged bool

+ Transfer bool

+ type SessionAutoSendConfig struct

+ AllRevoked bool

+ DeviceRemoved bool

+ NewDevice bool

+ NewLocation bool

+ SuspiciousLogin bool

v0.0.5

Dec 12, 2025

v0.0.4

Dec 8, 2025

v0.0.3

Dec 8, 2025

Changes in this version

type DashboardExtension

+ func (e *DashboardExtension) GetSampleTemplate(c forge.Context) error

+ func (e *DashboardExtension) PreviewBuilderTemplate(c forge.Context) error

+ func (e *DashboardExtension) SaveBuilderTemplate(c forge.Context) error

+ func (e *DashboardExtension) ServeEmailBuilder(c forge.Context) error

+ func (e *DashboardExtension) ServeEmailBuilderWithTemplate(c forge.Context) error

v0.0.2

Nov 24, 2025

v0.0.1

Nov 20, 2025

Changes in this version

+ var NewMailerSendProvider = providers.NewMailerSendProvider

+ var NewPostmarkProvider = providers.NewPostmarkProvider

+ var NewResendProvider = providers.NewResendProvider

+ type Adapter struct

+ func NewAdapter(templateSvc *TemplateService) *Adapter

+ func (a *Adapter) SendCustom(ctx context.Context, appID xid.ID, templateKey, recipient string, ...) error

+ func (a *Adapter) SendDirectEmail(ctx context.Context, appID xid.ID, recipient, subject, body string) error

+ func (a *Adapter) SendDirectSMS(ctx context.Context, appID xid.ID, recipient, body string) error

+ func (a *Adapter) SendEmailOTP(ctx context.Context, appID xid.ID, email, code string, expiryMinutes int) error

+ func (a *Adapter) SendMFACode(ctx context.Context, appID xid.ID, recipient, code string, expiryMinutes int, ...) error

+ func (a *Adapter) SendMagicLink(ctx context.Context, appID xid.ID, email, userName, magicLink string, ...) error

+ func (a *Adapter) SendPasswordReset(ctx context.Context, appID xid.ID, email, userName, resetURL, resetCode string, ...) error

+ func (a *Adapter) SendPhoneOTP(ctx context.Context, appID xid.ID, phone, code string) error

+ func (a *Adapter) SendSecurityAlert(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendVerificationEmail(ctx context.Context, appID xid.ID, ...) error

+ func (a *Adapter) SendWelcomeEmail(ctx context.Context, appID xid.ID, email, userName, loginURL string) error

+ type ChannelsResponse struct

+ Channels interface{}

+ Count int

+ type Config struct

+ AddDefaultTemplates bool

+ AllowAppOverrides bool

+ AllowTemplateReset bool

+ AutoPopulateTemplates bool

+ AutoSendWelcome bool

+ CleanupAfter time.Duration

+ DefaultLanguage string

+ Providers ProvidersConfig

+ RateLimits map[string]RateLimit

+ RetryAttempts int

+ RetryDelay time.Duration

+ func DefaultConfig() Config

+ func (c *Config) Validate() error

+ type DashboardExtension struct

+ func NewDashboardExtension(plugin *Plugin) *DashboardExtension

+ func (e *DashboardExtension) DashboardWidgets() []ui.DashboardWidget

+ func (e *DashboardExtension) ExtensionID() string

+ func (e *DashboardExtension) NavigationItems() []ui.NavigationItem

+ func (e *DashboardExtension) PreviewTemplate(c forge.Context) error

+ func (e *DashboardExtension) RenderDashboardWidget(basePath string, currentApp *app.App) g.Node

+ func (e *DashboardExtension) Routes() []ui.Route

+ func (e *DashboardExtension) SaveNotificationSettings(c forge.Context) error

+ func (e *DashboardExtension) ServeAnalyticsSettings(c forge.Context) error

+ func (e *DashboardExtension) ServeCreateTemplate(c forge.Context) error

+ func (e *DashboardExtension) ServeEditTemplate(c forge.Context) error

+ func (e *DashboardExtension) ServeNotificationSettings(c forge.Context) error

+ func (e *DashboardExtension) ServeNotificationsOverview(c forge.Context) error

+ func (e *DashboardExtension) ServeProviderSettings(c forge.Context) error

+ func (e *DashboardExtension) ServeTemplatesList(c forge.Context) error

+ func (e *DashboardExtension) SetRegistry(registry *dashboard.ExtensionRegistry)

+ func (e *DashboardExtension) SettingsPages() []ui.SettingsPage

+ func (e *DashboardExtension) SettingsSections() []ui.SettingsSection

+ func (e *DashboardExtension) TestProvider(c forge.Context) error

+ func (e *DashboardExtension) TestSendTemplate(c forge.Context) error

+ type EmailProviderConfig struct

+ Config map[string]interface{}

+ From string

+ FromName string

+ Provider string

+ ReplyTo string

+ type ErrorResponse = responses.ErrorResponse

+ type Handler struct

+ func NewHandler(service *notification.Service, templateSvc *TemplateService, config Config) *Handler

+ func (h *Handler) CreateABTestVariant(c forge.Context) error

+ func (h *Handler) CreateProvider(c forge.Context) error

+ func (h *Handler) CreateTemplate(c forge.Context) error

+ func (h *Handler) CreateTemplateVersion(c forge.Context) error

+ func (h *Handler) DeclareABTestWinner(c forge.Context) error

+ func (h *Handler) DeleteProvider(c forge.Context) error

+ func (h *Handler) DeleteTemplate(c forge.Context) error

+ func (h *Handler) GetABTestResults(c forge.Context) error

+ func (h *Handler) GetAppAnalytics(c forge.Context) error

+ func (h *Handler) GetNotification(c forge.Context) error

+ func (h *Handler) GetOrgAnalytics(c forge.Context) error

+ func (h *Handler) GetProvider(c forge.Context) error

+ func (h *Handler) GetTemplate(c forge.Context) error

+ func (h *Handler) GetTemplateAnalytics(c forge.Context) error

+ func (h *Handler) GetTemplateDefaults(c forge.Context) error

+ func (h *Handler) GetTemplateVersion(c forge.Context) error

+ func (h *Handler) HandleWebhook(c forge.Context) error

+ func (h *Handler) ListNotifications(c forge.Context) error

+ func (h *Handler) ListProviders(c forge.Context) error

+ func (h *Handler) ListTemplateVersions(c forge.Context) error

+ func (h *Handler) ListTemplates(c forge.Context) error

+ func (h *Handler) PreviewTemplate(c forge.Context) error

+ func (h *Handler) RenderTemplate(c forge.Context) error

+ func (h *Handler) ResendNotification(c forge.Context) error

+ func (h *Handler) ResetAllTemplates(c forge.Context) error

+ func (h *Handler) ResetTemplate(c forge.Context) error

+ func (h *Handler) RestoreTemplateVersion(c forge.Context) error

+ func (h *Handler) SendNotification(c forge.Context) error

+ func (h *Handler) TrackNotificationEvent(c forge.Context) error

+ func (h *Handler) UpdateProvider(c forge.Context) error

+ func (h *Handler) UpdateTemplate(c forge.Context) error

+ type MailerSendConfig = providers.MailerSendConfig

+ type MessageResponse = responses.MessageResponse

+ type NotificationErrorResponse struct

+ Error string

+ type NotificationListResponse struct

+ Notifications []interface{}

+ Total int

+ type NotificationPreviewResponse struct

+ Body string

+ Subject string

+ type NotificationResponse struct

+ Notification interface{}

+ type NotificationStatusResponse struct

+ Status string

+ type NotificationTemplateListResponse struct

+ Templates []interface{}

+ Total int

+ type NotificationTemplateResponse struct

+ Template interface{}

+ type NotificationWebhookResponse struct

+ Status string

+ type NotificationsResponse struct

+ Count int

+ Notifications interface{}

+ type Plugin struct

+ func NewPlugin(opts ...PluginOption) *Plugin

+ func (p *Plugin) DashboardExtension() ui.DashboardExtension

+ func (p *Plugin) GetService() *notification.Service

+ func (p *Plugin) GetTemplateService() *TemplateService

+ func (p *Plugin) ID() string

+ func (p *Plugin) Init(authInst core.Authsome) error

+ func (p *Plugin) Migrate() error

+ func (p *Plugin) RegisterHooks(hookRegistry *hooks.HookRegistry) error

+ func (p *Plugin) RegisterRoutes(router forge.Router) error

+ func (p *Plugin) RegisterServiceDecorators(services *registry.ServiceRegistry) error

+ type PluginOption func(*Plugin)

+ func WithAddDefaultTemplates(add bool) PluginOption

+ func WithAllowAppOverrides(allow bool) PluginOption

+ func WithAutoSendWelcome(auto bool) PluginOption

+ func WithDefaultConfig(cfg Config) PluginOption

+ func WithDefaultLanguage(lang string) PluginOption

+ func WithEmailProvider(provider, from, fromName string) PluginOption

+ func WithRetryConfig(attempts int, delay time.Duration) PluginOption

+ func WithSMSProvider(provider, from string) PluginOption

+ type PostmarkConfig = providers.PostmarkConfig

+ type ProvidersConfig struct

+ Email EmailProviderConfig

+ SMS *SMSProviderConfig

+ type RateLimit struct

+ MaxRequests int

+ Window time.Duration

+ type ResendConfig = providers.ResendConfig

+ type SMSProviderConfig struct

+ Config map[string]interface{}

+ From string

+ Provider string

+ type SendWithTemplateRequest struct

+ AppID xid.ID

+ Language string

+ Metadata map[string]interface{}

+ Recipient string

+ TemplateKey string

+ Type notification.NotificationType

+ Variables map[string]interface{}

+ type StatusResponse = responses.StatusResponse

+ type SuccessResponse = responses.SuccessResponse

+ type TemplateDefault struct

+ BodyHTML string

+ BodyText string

+ Description string

+ Subject string

+ TemplateKey string

+ Type string

+ Variables []string

+ func DefaultTemplates() []TemplateDefault

+ type TemplateEngine struct

+ func NewTemplateEngine() *TemplateEngine

+ func (e *TemplateEngine) ExtractVariables(templateStr string) ([]string, error)

+ func (e *TemplateEngine) Render(templateStr string, variables map[string]interface{}) (string, error)

+ func (e *TemplateEngine) ValidateTemplate(templateStr string) error

+ type TemplateService struct

+ func NewTemplateService(notificationSvc *notification.Service, repo notification.Repository, ...) *TemplateService

+ func (s *TemplateService) RenderTemplate(ctx context.Context, templateID xid.ID, variables map[string]interface{}) (subject, body string, err error)

+ func (s *TemplateService) SendDirect(ctx context.Context, appID xid.ID, notifType notification.NotificationType, ...) (*notification.Notification, error)

+ func (s *TemplateService) SendEmail(ctx context.Context, appID xid.ID, templateKey, to string, ...) error

+ func (s *TemplateService) SendSMS(ctx context.Context, appID xid.ID, templateKey, to string, ...) error

+ func (s *TemplateService) SendWithTemplate(ctx context.Context, req *SendWithTemplateRequest) (*notification.Notification, error)

+ type TemplatesResponse struct

+ Count int

+ Templates interface{}

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL