state

type AllStateFilter struct{}

type AnyMessageIDStateFilter struct {
	MessageIDs []imap.InternalMessageID
}

type AppendOnlyMailbox interface {
	Append(ctx context.Context, literal []byte, flags imap.FlagSet, date time.Time) (imap.UID, error)
	Flush(ctx context.Context, permitExpunge bool) ([]response.Response, error)
	UIDValidity() imap.UID
	IsDrafts(ctx context.Context) (bool, error)
}

type Connector interface {
	// SetConnMetadataValue sets a metadata value associated with the current connector.
	SetConnMetadataValue(key string, value any)

	// ClearConnMetadataValue clears a metadata value associated with the current connector.
	ClearConnMetadataValue(key string)

	// ClearAllConnMetadata clears all metadata values associated with the current connector.
	ClearAllConnMetadata()

	// CreateMailbox creates a new mailbox with the given name.
	CreateMailbox(ctx context.Context, name []string) (imap.Mailbox, error)

	// UpdateMailbox sets the name of the mailbox with the given ID to the given new name.
	UpdateMailbox(ctx context.Context, mboxID imap.MailboxID, newName []string) error

	// DeleteMailbox deletes the mailbox with the given ID and name.
	DeleteMailbox(ctx context.Context, mboxID imap.MailboxID) error

	// CreateMessage appends a message literal to the mailbox with the given ID.
	CreateMessage(
		ctx context.Context,
		mboxID imap.MailboxID,
		literal []byte,
		flags imap.FlagSet,
		date time.Time,
	) (imap.InternalMessageID, imap.Message, []byte, error)

	// GetMessageLiteral retrieves the message literal from the connector.
	// Note: this can get called from different go routines.
	GetMessageLiteral(ctx context.Context, id imap.MessageID) ([]byte, error)

	// AddMessagesToMailbox adds the message with the given ID to the mailbox with the given ID.
	AddMessagesToMailbox(
		ctx context.Context,
		messageIDs []imap.MessageID,
		mboxID imap.MailboxID,
	) error

	// RemoveMessagesFromMailbox removes the message with the given ID from the mailbox with the given ID.
	RemoveMessagesFromMailbox(
		ctx context.Context,
		messageIDs []imap.MessageID,
		mboxID imap.MailboxID,
	) error

	// MoveMessagesFromMailbox removes the message with the given ID from the mailbox with the given ID.
	MoveMessagesFromMailbox(
		ctx context.Context,
		messageIDs []imap.MessageID,
		mboxFromID imap.MailboxID,
		mboxToID imap.MailboxID,
	) (bool, error)

	// SetMessagesSeen marks the message with the given ID as seen or unseen.
	SetMessagesSeen(ctx context.Context, messageIDs []imap.MessageID, seen bool) error

	// SetMessagesFlagged marks the message with the given ID as seen or unseen.
	SetMessagesFlagged(ctx context.Context, messageIDs []imap.MessageID, flagged bool) error

	// GetMailboxVisibility retrieves the visibility status of a mailbox for a client.
	GetMailboxVisibility(ctx context.Context, id imap.MailboxID) imap.MailboxVisibility
}

type ExistsStateUpdate struct {
	MBoxIDStateFilter
	// contains filtered or unexported fields
}

type MBoxIDStateFilter struct {
	MboxID imap.InternalMailboxID
}

type Mailbox struct {
	// contains filtered or unexported fields
}

type Match struct {
	Name      string
	Delimiter string
	Atts      imap.FlagSet
}

type MessageAndMBoxIDStateFilter struct {
	MessageID imap.InternalMessageID
	MBoxID    imap.InternalMailboxID
}

type MessageIDStateFilter struct {
	MessageID imap.InternalMessageID
}

type RemoteAddMessageFlagsStateUpdate struct {
	MessageIDStateFilter
	// contains filtered or unexported fields
}

type RemoteMessageDeletedStateUpdate struct {
	MessageIDStateFilter
	// contains filtered or unexported fields
}

type RemoteRemoveMessageFlagsStateUpdate struct {
	MessageIDStateFilter
	// contains filtered or unexported fields
}

type Responder interface {
	String() string
	// contains filtered or unexported methods
}

type SeqInterval struct {
	// contains filtered or unexported fields
}

type SnapFilter interface {
	Filter(s *State) bool
	String() string
}

type State struct {
	StateID StateID
	// contains filtered or unexported fields
}

type StateID int64

type UIDInterval struct {
	// contains filtered or unexported fields
}

type Update interface {
	// Filter returns true when the state can be passed into A.
	Filter(s *State) bool
	// Apply the update to a given state.
	Apply(cxt context.Context, tx db.Transaction, s *State) error

	String() string
}

type UserInterface interface {
	GetUserID() string

	GetDelimiter() string

	GetDB() db.Client

	GetRemote() Connector

	GetStore() *store.WriteControlledStore

	QueueOrApplyStateUpdate(ctx context.Context, tx db.Transaction, update ...Update) error

	ReleaseState(ctx context.Context, st *State) error

	GetRecoveryMailboxID() db.MailboxIDPair

	GenerateUIDValidity() (imap.UID, error)

	GetRecoveredMessageHashesMap() *utils.MessageHashesMap
}