imsg-map 0.3.1

MAP protocol logic — commands, folder navigation, MNS server, and iOS quirks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Message listing, retrieval, push, and status operations (`GetMessage`, `PushMessage`, `SetMessageStatus`).

use crate::{params, MapError};
use bytes::Bytes;

/// Read/unread state filter for `ListMessages`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ReadStatus {
    /// Wire value `0x01`; excludes read messages from results.
    Unread,
    /// Wire value `0x02`; excludes unread messages from results.
    Read,
}

impl ReadStatus {
    pub(crate) const fn to_wire(self) -> u8 {
        match self {
            Self::Unread => 0x01,
            Self::Read => 0x02,
        }
    }
}

/// Default fetches up to 1024 messages with no filters applied.
#[derive(Debug, Clone)]
pub struct ListMessagesFilter {
    /// Maximum entries to return; capped by the device's own limit.
    pub max_count: u16,
    /// Zero-based index of the first entry to return.
    pub offset: u16,
    /// Omit to return all messages regardless of read state.
    pub read_status: Option<ReadStatus>,
    /// Filter by sender/originator address. Null bytes prohibited.
    pub originating_address: Option<String>,
    /// Earliest message timestamp, format `YYYYMMDDTHHMMSS[±HHMM]`. Null bytes prohibited.
    pub period_begin: Option<String>,
    /// Latest message timestamp, format `YYYYMMDDTHHMMSS[±HHMM]`. Null bytes prohibited.
    pub period_end: Option<String>,
}

impl Default for ListMessagesFilter {
    fn default() -> Self {
        Self {
            max_count: 1024,
            offset: 0,
            read_status: None,
            originating_address: None,
            period_begin: None,
            period_end: None,
        }
    }
}

impl ListMessagesFilter {
    pub(crate) fn to_app_params(&self) -> Result<Bytes, MapError> {
        Ok(Bytes::from(params::list_messages_params(
            self.max_count,
            self.offset,
            self.read_status.map(ReadStatus::to_wire),
            self.originating_address.as_deref(),
            self.period_begin.as_deref(),
            self.period_end.as_deref(),
        )?))
    }
}

/// One `<msg>` entry in a `MAP-msg-listing` response; absent attributes default to zero/false/empty.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MessageEntry {
    /// Opaque device-assigned message handle (hex string).
    pub handle: String,
    /// Message subject or first line of body text.
    pub subject: String,
    /// Timestamp in MAP format (`YYYYMMDDTHHMMSS[±HHMM]`).
    pub datetime: String,
    /// Sender display name; empty if unavailable.
    pub sender_name: String,
    /// Sender address (phone number or email).
    pub sender_addressing: String,
    /// Recipient display name; empty for received messages.
    pub recipient_name: String,
    /// Recipient address; empty for received messages.
    pub recipient_addressing: String,
    /// Message type string (`SMS_GSM`, `SMS_CDMA`, `EMAIL`, `MMS`).
    pub msg_type: String,
    /// Body size in bytes as reported by the device.
    pub size: u32,
    /// Device-reported read state.
    pub read: bool,
    /// `true` for outbound messages from this device; `false` for received.
    pub sent: bool,
}