Skip to main content

EmailGetParams

Struct EmailGetParams 

Source
pub struct EmailGetParams {
    pub body_properties: Option<Vec<String>>,
    pub fetch_text_body_values: Option<bool>,
    pub fetch_html_body_values: Option<bool>,
    pub fetch_all_body_values: Option<bool>,
    pub max_body_value_bytes: Option<u64>,
    pub extra: Map<String, Value>,
}
Expand description

Extra args for Email/get (RFC 8621 §4.1.8).

Controls which body properties to fetch and whether to inline body values.

Fields§

§body_properties: Option<Vec<String>>

Override the set of body part properties returned (RFC 8621 §4.1.8).

§fetch_text_body_values: Option<bool>

If true, inline values for text/plain body parts (RFC 8621 §4.1.8).

§fetch_html_body_values: Option<bool>

If true, inline values for text/html body parts (RFC 8621 §4.1.8).

Wire name is fetchHTMLBodyValues (HTML uppercase) per RFC 8621 §4.2 line 2327 and the §4.2 example at line 2438. The default camelCase serde rename would produce fetchHtmlBodyValues, which a strict server treats as an unknown invocation argument and silently drops, causing HTML body values to never be inlined.

§fetch_all_body_values: Option<bool>

If true, inline values for all body parts (RFC 8621 §4.1.8).

§max_body_value_bytes: Option<u64>

Truncate body values to at most this many octets (RFC 8621 §4.1.8).

When set, each returned EmailBodyValue whose UTF-8 byte length exceeds this limit is truncated; the truncation point is rounded down to a UTF-8 character boundary so the returned string is always valid UTF-8 (trailing bytes that would result in an incomplete code point are dropped). Consequently the actual returned length may be a few octets short of this limit when the cut would fall inside a multi-byte UTF-8 sequence.

Truncated EmailBodyValue objects have their isTruncated property set to true. Callers that need the full body of a truncated value should download the raw blob via JmapClient::download_blob.

Spec magic-value: Some(0) is equivalent to omitting the field — RFC 8621 §4.1.8 says “If positive, …” which means the truncation only applies for strictly-positive values. Pass None to omit the wire field entirely (server uses its default policy), or Some(n) with n > 0 for an explicit truncation cap. Passing Some(0) is wire-legal but semantically identical to omission — prefer None for clarity.

§extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Constraint: keys in extra MUST NOT collide with the typed-field wire names above (the camelCase spelling — e.g. "accountId", "ids", "properties", "blobIds", "fromAccountId", etc.). On collision the typed-field value wins on the wire and the extra value is silently dropped at serialization. Place vendor extensions under vendor-prefixed keys (e.g. "acmeCorpFoo") to avoid the collision class.

Trait Implementations§

Source§

impl Clone for EmailGetParams

Source§

fn clone(&self) -> EmailGetParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EmailGetParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EmailGetParams

Source§

fn default() -> EmailGetParams

Returns the “default value” for a type. Read more
Source§

impl Serialize for EmailGetParams

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more