database

type AddressDao interface {
	// Insert inserts a new address.
	Insert(context.Context, Queryer, *models.AddressEntity) error
	// Delete deletes an existing address.
	Delete(context.Context, Queryer, *models.AddressEntity) error
	// FindAll returns all addresses including their domain name.
	FindAll(context.Context, Queryer) ([]AddressWithDomain, error)
	// FindByMailbox returns all addresses including their domain name by mailbox.
	FindByMailbox(context.Context, Queryer, *models.MailboxEntity) ([]AddressWithDomain, error)
}

type AddressWithDomain struct {
	models.AddressEntity
	DomainName string `db:"domain_name"`
}

type Conn interface {
	Queryer
	Begin(context.Context) (Tx, error)
	Close() error
}

type DomainDao interface {
	// Insert inserts a new domain.
	Insert(context.Context, Queryer, *models.DomainEntity) error
	// Update updates an existing domain.
	Update(context.Context, Queryer, *models.DomainEntity) error
	// Delete deletes an existing domain.
	Delete(context.Context, Queryer, *models.DomainEntity) error
	// FindAll returns all domains sorted by name.
	FindAll(context.Context, Queryer) ([]models.DomainEntity, error)
	// FindByName returns the domain matching the name.
	FindByName(context.Context, Queryer, string) (*models.DomainEntity, error)
}

type MailDao interface {
	// Insert inserts a new mail.
	Insert(context.Context, Queryer, *models.MailEntity) error
	// Update updates an existing mail.
	Update(context.Context, Queryer, *models.MailEntity) error
	// FindByMailbox returns all mails that are not deleted and are "inboxed" to the mailbox.
	FindByMailbox(context.Context, Queryer, *models.MailboxEntity) ([]models.MailEntity, error)
	// FindDeletable returns all mails which are not yet deleted and are delivered or failed to all
	// recipients.
	FindDeletable(context.Context, Queryer) ([]models.MailEntity, error)
	// FindNextPending returns the next mail with at least one pending recipient.
	FindNextPending(context.Context, Queryer) (*models.MailEntity, error)
}

type MailboxCredentialDao interface {
	// Upsert inserts new mailbox credentials. When there already is an entry for a mailbox, the
	// row will be updated instead.
	Upsert(context.Context, Queryer, *models.MailboxCredentialEntity) error
	// FindByMailbox returns the credentials associated with a mailbox.
	FindByMailbox(context.Context, Queryer, *models.MailboxEntity) (*models.MailboxCredentialEntity, error)
}

type MailboxDao interface {
	// Insert inserts a new mailbox.
	Insert(context.Context, Queryer, *models.MailboxEntity) error
	// Update updates an existing mailbox.
	Update(context.Context, Queryer, *models.MailboxEntity) error
	// DeleteMailbox deletes an existing mailbox.
	Delete(context.Context, Queryer, *models.MailboxEntity) error
	// FindAll returns all mailboxes.
	FindAll(context.Context, Queryer) ([]models.MailboxEntity, error)
	// FindByAddress returns the mailbox associated with an address.
	FindByAddress(context.Context, Queryer, models.Address) (*models.MailboxEntity, error)
}

type Queryer interface {
	sqlx.ExtContext
}

type RecipientDao interface {
	// Insert inserts a new recipient.
	Insert(context.Context, Queryer, *models.RecipientEntity) error
	// Update updates an existing recipient.
	Update(context.Context, Queryer, *models.RecipientEntity) error
	// UpdateDelivered updates the status of all recipients matching the mail and mailbox to
	// StatusDelivered.
	UpdateDelivered(context.Context, Queryer, *models.MailboxEntity, *models.MailEntity) error
	// FindPending returns all pending recipients of a mail.
	FindPending(context.Context, Queryer, *models.MailEntity) ([]models.RecipientEntity, error)
}

type Tx interface {
	Queryer
	Commit() error
	Rollback() error
	RollbackWith(func()) error
}