email

Documentation

Index

• type EmailService
• type ExpiringTokenEmailData
• type NoOpService
  • func (s *NoOpService) IsValid() bool
  • func (s *NoOpService) SendExpiringTokenEmail(ctx context.Context, emails []string, data ExpiringTokenEmailData) error
  • func (s *NoOpService) SendTenantInviteEmail(ctx context.Context, email string, data TenantInviteEmailData) error
  • func (s *NoOpService) SendTenantResourceLimitAlert(ctx context.Context, emails []string, data ResourceLimitAlertData) error
  • func (s *NoOpService) SendWorkflowRunFailedAlerts(ctx context.Context, emails []string, data WorkflowRunsFailedEmailData) error
• type ResourceLimitAlertData
• type TenantInviteEmailData
• type WorkflowRunsFailedEmailData

Types

type EmailService

type EmailService interface {
	// for clients to show email settings
	IsValid() bool

	SendTenantInviteEmail(ctx context.Context, email string, data TenantInviteEmailData) error
	SendWorkflowRunFailedAlerts(ctx context.Context, emails []string, data WorkflowRunsFailedEmailData) error
	SendExpiringTokenEmail(ctx context.Context, emails []string, data ExpiringTokenEmailData) error
	SendTenantResourceLimitAlert(ctx context.Context, emails []string, data ResourceLimitAlertData) error
}

type ExpiringTokenEmailData

type ExpiringTokenEmailData struct {
	ExpiresAtAbsoluteDate string `json:"expires_at_absolute_date"`
	ExpiresAtRelativeDate string `json:"expires_at_relative_date"`
	TokenName             string `json:"token_name"`
	Subject               string `json:"subject"`
	TenantName            string `json:"tenant_name"`
	TokenSettings         string `json:"token_settings"`
	SettingsLink          string `json:"settings_link"`
}

type NoOpService

type NoOpService struct{}

func (*NoOpService) IsValid

func (s *NoOpService) IsValid() bool

func (*NoOpService) SendExpiringTokenEmail

func (s *NoOpService) SendExpiringTokenEmail(ctx context.Context, emails []string, data ExpiringTokenEmailData) error

func (*NoOpService) SendTenantInviteEmail

func (s *NoOpService) SendTenantInviteEmail(ctx context.Context, email string, data TenantInviteEmailData) error

func (*NoOpService) SendTenantResourceLimitAlert

func (s *NoOpService) SendTenantResourceLimitAlert(ctx context.Context, emails []string, data ResourceLimitAlertData) error

func (*NoOpService) SendWorkflowRunFailedAlerts

func (s *NoOpService) SendWorkflowRunFailedAlerts(ctx context.Context, emails []string, data WorkflowRunsFailedEmailData) error

type ResourceLimitAlertData

type ResourceLimitAlertData struct {
	Subject      string `json:"subject"`
	Summary      string `json:"summary"`
	Summary2     string `json:"summary2"`
	TenantName   string `json:"tenant_name"`
	Link         string `json:"link"`
	Resource     string `json:"resource"`
	AlertType    string `json:"alert_type"`
	CurrentValue int    `json:"current_value"`
	LimitValue   int    `json:"limit_value"`
	Percentage   int    `json:"percentage"`
	SettingsLink string `json:"settings_link"`
}

type TenantInviteEmailData

type TenantInviteEmailData struct {
	InviteSenderName string `json:"invite_sender_name"`
	TenantName       string `json:"tenant_name"`
	ActionURL        string `json:"action_url"`
}

type WorkflowRunsFailedEmailData

type WorkflowRunsFailedEmailData struct {
	Items        []alerttypes.WorkflowRunFailedItem `json:"items"`
	Subject      string                             `json:"subject"`
	Summary      string                             `json:"summary"`
	TenantName   string                             `json:"tenant_name"`
	SettingsLink string                             `json:"settings_link"`
}