Skip to main content

SendingPace

\Benecaster\Email\Warmup\SendingPace

Class Free

A backed string enum. How urgently a bulk job group wants to go out: standard (the whole day’s allowance), gentle (half) or slowest (a quarter). A pace is a fraction of the day’s allowance, so it rides the warm-up. It can only ever send less. There is no faster pace, and the warm-up stays in charge. The string values are stable and safe to store.

Methods

Method Visibility Since Description
fraction(): float Public — The share of a day's allowance this pace may use: 1.0, 0.5 or 0.25.
label(): string Public — Translated label for a picker.
apply( int $allowance ): int Public — Applies the pace to an allowance. Never returns 0 for a positive allowance, so a paced job can't stall.
from_slug( ?string $slug ): self Public — Static. Resolves a stored value; anything unrecognised is Standard.
options(): array Public — Static. Every pace as { value, label }, for a picker.