Struct SendOptions 

#[non_exhaustive]
pub struct SendOptions {
    pub envelope: Option<Envelope>,
    pub transport_options: TransportOptions,
    pub timeout: Option<Duration>,
    pub idempotency_key: Option<IdempotencyKey>,
    pub correlation_id: Option<CorrelationId>,
}

Per-send controls shared by structured and raw transport sends.

With the serde feature enabled, this serializes as a sparse object: absent options are omitted, TransportOptions uses its provider-keyed representation, and timeout is encoded as { "secs": u64, "nanos": u32 }. Deserialization is intentionally registry-driven and not implemented on this type because provider-specific options need a TransportOptionRegistry; use TransportOptionRegistry::send_options_seed (or the convenience TransportOptionRegistry::deserialize_send_options wrapper) instead.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

envelope: Option<Envelope>

Optional custom SMTP envelope for structured crate::Transport sends.

This is only meaningful for structured transports that advertise crate::Capabilities::custom_envelope. Other structured transports may ignore it. crate::RawTransport methods take an explicit Envelope argument, and that argument is authoritative; raw transports ignore this field.

transport_options: TransportOptions

Typed, in-process provider-specific controls.

With the serde feature enabled, TransportOptions serializes as a provider-keyed JSON object and can be hydrated through TransportOptionRegistry.

timeout: Option<Duration>

Upper bound on provider-call duration for this send attempt. Transports advertising Capabilities::timeout must honor it; others should ignore it.

idempotency_key: Option<IdempotencyKey>

Provider-level idempotency token for this attempt. Transports advertising Capabilities::idempotency_key must forward it; others should ignore it.

Validated at construction (rejects empty, NUL, CR/LF, non-tab control characters, and values longer than 1 KiB), see IdempotencyKey.

correlation_id: Option<CorrelationId>

Opaque correlation identifier carried end-to-end from queue to transport. Built-in transports do not automatically expose it to providers; it is available to adapter-specific typed options when a provider has a natural slot for it.

Validated at construction with the same rules as IdempotencyKey, see CorrelationId.

Implementations

impl SendOptions

pub fn new() -> SendOptions

Create send options with no overrides.

pub fn with_envelope(self, envelope: Envelope) -> SendOptions

Set the structured-send envelope override.

pub fn with_transport_options( self, transport_options: TransportOptions, ) -> SendOptions

Replace the provider-specific typed option map.

pub fn with_transport_option<T>(self, value: T) -> SendOptions

where T: TransportOption + Serialize,

Insert or replace the provider option value of type T.

Slots are keyed by type, exactly like TransportOptions::insert. Unlike Self::with_transport_options, this keeps options of other types already present, so calls chain across providers.

pub const fn with_timeout(self, timeout: Duration) -> SendOptions

Set the provider-call timeout for this attempt.

pub fn with_idempotency_key( self, idempotency_key: IdempotencyKey, ) -> SendOptions

Set the provider idempotency key for this attempt.

pub fn with_correlation_id(self, correlation_id: CorrelationId) -> SendOptions

Set the end-to-end tracing correlation identifier.

pub fn serializable_without_idempotency_key(&self) -> impl Serialize

Return a serializable view that omits the provider idempotency key.

Queue adapters can use this when the idempotency key belongs to the queue invocation rather than the eventual provider request.

Trait Implementations

impl Debug for SendOptions

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

Formats the value using the given formatter.

impl Default for SendOptions

fn default() -> SendOptions

Returns the “default value” for a type.

impl JsonSchema for SendOptions

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SendOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.