Method TestEmailSetting

backend/api/v1/setting_service.go:761–802

TestEmailSetting sends a test email using the provided config.

(ctx context.Context, req *connect.Request[v1pb.TestEmailSettingRequest])

// TestEmailSetting sends a test email using the provided config.
func (s *SettingService) TestEmailSetting(ctx context.Context, req *connect.Request[v1pb.TestEmailSettingRequest]) (*connect.Response[v1pb.TestEmailSettingResponse], error) {
	emailSetting := convertEmailSetting(req.Msg.EmailSetting)
	if emailSetting == nil {
		return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("email_setting is required"))
	}

	// Substitute stored password if not provided.
	if smtp := emailSetting.GetSmtp(); smtp != nil && smtp.Password == "" {
		workspaceID := common.GetWorkspaceIDFromContext(ctx)
		if existing, err := s.store.GetSetting(ctx, workspaceID, storepb.SettingName_EMAIL); err == nil && existing != nil {
			if oldEmail, ok := existing.Value.(*storepb.EmailSetting); ok {
				if oldSMTP := oldEmail.GetSmtp(); oldSMTP != nil {
					smtp.Password = oldSMTP.Password
				}
			}
		}
	}

	sender, err := mailer.NewSender(emailSetting)
	if err != nil {
		return connect.NewResponse(&v1pb.TestEmailSettingResponse{ //nolint:nilerr
			Success: false,
			Error:   err.Error(),
		}), nil
	}

	err = sender.Send(ctx, &mailer.SendRequest{
		To:       []string{req.Msg.To},
		Subject:  "Bytebase email config test",
		TextBody: "This is a test email from Bytebase to verify your email configuration.",
	})
	if err != nil {
		return connect.NewResponse(&v1pb.TestEmailSettingResponse{ //nolint:nilerr
			Success: false,
			Error:   err.Error(),
		}), nil
	}

	return connect.NewResponse(&v1pb.TestEmailSettingResponse{
		Success: true,
	}), nil
}

func (s *SettingService) checkSettingPermission(ctx context.Context, req connect.AnyRequest, perm permission.Permission) error {
	user, ok := GetUserFromContext(ctx)