Struct BounceV1Request

pub struct BounceV1Request {
    pub campaign: Option<String>,
    pub tenant: Option<String>,
    pub domain: Option<String>,
    pub routing_domain: Option<String>,
    pub reason: String,
    pub duration: Option<Duration>,
    pub suppress_logging: bool,
    pub expires: Option<DateTime<Utc>>,
}

Describes which messages should be bounced. The criteria apply to the scheduled queue associated with a given message.

Fields

campaign: Option<String>

The campaign name to match. If omitted, any campaign will match.

tenant: Option<String>

The tenant to match. If omitted, any tenant will match.

domain: Option<String>

The domain name to match. If omitted, any domain will match.

routing_domain: Option<String>

The routing_domain name to match. If omitted, any routing_domain will match.

reason: String

Reason to log in the delivery log. Each matching message will be bounced with an AdminBounce record unless you suppress logging. The reason will also be shown in the list of currently active admin bounces.

duration: Option<Duration>

Defaults to “5m”. Specifies how long this bounce directive remains active. While active, newly injected messages that match the bounce criteria will also be bounced.

suppress_logging: bool

If true, do not generate AdminBounce delivery logs for matching messages.

expires: Option<DateTime<Utc>>

instead of specifying the duration, you can set an explicit expiration timestamp

Implementations

impl BounceV1Request

pub fn duration(&self) -> Duration

Trait Implementations

impl Debug for BounceV1Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BounceV1Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BounceV1Request

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for BounceV1Request

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].