chaas/imc-vibe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add comments to virtual_* database files

Browse source 
Add human-readable comments explaining each function's purpose,
parameters, and return values for better documentation.
This commit is contained in:
Christoph Haas 2026-03-28 14:58:11 +01:00
parent 0e6fad65e2
commit 19ce2224b8
3 changed files with 95 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

31
backend/internal/db/virtual_aliases.go
View file

@ -1,5 +1,15 @@
// Package db provides database access for the IMC application.
// It uses GORM (Go ORM) for database operations.
package db
// =============================================================================
// VirtualAlias - Mail alias operations
// These functions interact with the ISPmail virtual_aliases table.
// =============================================================================
// GetAllAliases retrieves all email aliases with their domain names.
// Returns a slice of AliasWithDomain (includes domain name) or an error.
func (d *DB) GetAllAliases() ([]AliasWithDomain, error) {
var aliases []VirtualAlias
if err := d.Preload("Domain").Find(&aliases).Error; err != nil {
@ -23,6 +33,9 @@ func (d *DB) GetAllAliases() ([]AliasWithDomain, error) {
return result, nil
}
// GetAliasesByDomain retrieves all aliases belonging to a specific domain.
// domainID: the ID of the domain.
// Returns a slice of VirtualAlias or an error.
func (d *DB) GetAliasesByDomain(domainID uint) ([]VirtualAlias, error) {
var aliases []VirtualAlias
if err := d.Where("domain_id = ?", domainID).Find(&aliases).Error; err != nil {
@ -34,6 +47,9 @@ func (d *DB) GetAliasesByDomain(domainID uint) ([]VirtualAlias, error) {
return aliases, nil
}
// GetAliasByID retrieves a single alias by its ID.
// id: the alias's ID.
// Returns the VirtualAlias or an error (including "record not found").
func (d *DB) GetAliasByID(id uint) (*VirtualAlias, error) {
var alias VirtualAlias
if err := d.Preload("Domain").First(&alias, id).Error; err != nil {
@ -42,6 +58,9 @@ func (d *DB) GetAliasByID(id uint) (*VirtualAlias, error) {
return &alias, nil
}
// GetAliasBySource looks up an alias by its source address.
// source: the source email address (the alias).
// Returns the VirtualAlias or an error (including "record not found").
func (d *DB) GetAliasBySource(source string) (*VirtualAlias, error) {
var alias VirtualAlias
if err := d.Where("source = ?", source).First(&alias).Error; err != nil {
@ -50,6 +69,10 @@ func (d *DB) GetAliasBySource(source string) (*VirtualAlias, error) {
return &alias, nil
}
// CreateAlias creates a new email alias without a domain association.
// source: the source email address (the alias).
// destination: the destination email address (where mail is forwarded to).
// Returns the created VirtualAlias or an error.
func (d *DB) CreateAlias(source, destination string) (*VirtualAlias, error) {
alias := VirtualAlias{
Source: source,
@ -61,6 +84,11 @@ func (d *DB) CreateAlias(source, destination string) (*VirtualAlias, error) {
return &alias, nil
}
// CreateAliasInDomain creates a new email alias in a specific domain.
// source: the source email address (the alias).
// destination: the destination email address (where mail is forwarded to).
// domainID: the ID of the domain this alias belongs to.
// Returns the created VirtualAlias or an error.
func (d *DB) CreateAliasInDomain(source, destination string, domainID uint) (*VirtualAlias, error) {
alias := VirtualAlias{
DomainID: domainID,
@ -73,6 +101,9 @@ func (d *DB) CreateAliasInDomain(source, destination string, domainID uint) (*Vi
return &alias, nil
}
// DeleteAlias permanently removes an alias from the database.
// id: the alias's ID to delete.
// Returns an error if the deletion fails.
func (d *DB) DeleteAlias(id uint) error {
return d.Delete(&VirtualAlias{}, id).Error
}