mailparsing/
headermap.rs

1use crate::{
2    AddressList, AuthenticationResults, Header, Mailbox, MailboxList, MessageID, MimeParameters,
3    Result, SharedString,
4};
5use chrono::{DateTime, FixedOffset, TimeZone};
6use paste::paste;
7
8/// Represents an ordered list of headers.
9/// Note that there may be multiple headers with the same name.
10/// Derefs to the underlying `Vec<Header>` for mutation,
11/// but provides some accessors for retrieving headers by name.
12#[derive(Debug, Clone, Default, PartialEq)]
13pub struct HeaderMap<'a> {
14    pub(crate) headers: Vec<Header<'a>>,
15}
16
17impl<'a> std::ops::Deref for HeaderMap<'a> {
18    type Target = Vec<Header<'a>>;
19    fn deref(&self) -> &Vec<Header<'a>> {
20        &self.headers
21    }
22}
23
24impl<'a> std::ops::DerefMut for HeaderMap<'a> {
25    fn deref_mut(&mut self) -> &mut Vec<Header<'a>> {
26        &mut self.headers
27    }
28}
29
30pub trait EncodeHeaderValue {
31    fn encode_value(&self) -> SharedString<'static>;
32    fn as_header(&self, _name: &str) -> Option<Header<'static>> {
33        None
34    }
35}
36
37impl EncodeHeaderValue for &str {
38    fn encode_value(&self) -> SharedString<'static> {
39        unimplemented!();
40    }
41
42    fn as_header(&self, name: &str) -> Option<Header<'static>> {
43        Some(Header::new_unstructured(name.to_string(), self.to_string()))
44    }
45}
46
47impl<T: TimeZone> EncodeHeaderValue for DateTime<T>
48where
49    <T as TimeZone>::Offset: std::fmt::Display,
50{
51    fn encode_value(&self) -> SharedString<'static> {
52        (*self).to_rfc2822().into()
53    }
54}
55
56macro_rules! accessor {
57    ($func_name:ident, $header_name:literal, $ty:path, $parser:ident) => {
58        pub fn $func_name(&self) -> Result<Option<$ty>> {
59            match self.get_first($header_name) {
60                None => Ok(None),
61                Some(header) => Ok(Some(header.$parser()?)),
62            }
63        }
64
65        paste! {
66            pub fn [<set_ $func_name>](&mut self, v: impl EncodeHeaderValue) {
67
68                if let Some(idx) = self
69                    .headers
70                    .iter()
71                    .position(|header| header.get_name().eq_ignore_ascii_case($header_name))
72                {
73                    if let Some(hdr) = v.as_header(self.headers[idx].get_name()) {
74                        self.headers[idx] = hdr;
75                    } else {
76                        self.headers[idx].assign(v);
77                    }
78                } else {
79                    if let Some(hdr) = v.as_header($header_name) {
80                        self.headers.push(hdr);
81                    } else {
82                    self.headers
83                        .push(Header::with_name_value($header_name, v.encode_value()));
84                    }
85                }
86            }
87        }
88    };
89}
90
91impl<'a> HeaderMap<'a> {
92    pub fn new(headers: Vec<Header<'a>>) -> Self {
93        Self { headers }
94    }
95
96    pub fn remove_all_named(&mut self, name: &str) {
97        self.headers
98            .retain(|hdr| !hdr.get_name().eq_ignore_ascii_case(name));
99    }
100
101    pub fn prepend<V: Into<SharedString<'a>>>(&mut self, name: &str, v: V) {
102        self.headers
103            .insert(0, Header::new_unstructured(name.to_string(), v));
104    }
105
106    pub fn get_first(&'a self, name: &str) -> Option<&'a Header<'a>> {
107        self.iter_named(name).next()
108    }
109
110    pub fn get_first_mut(&'a mut self, name: &str) -> Option<&'a mut Header<'a>> {
111        self.iter_named_mut(name).next()
112    }
113
114    pub fn get_last(&'a self, name: &str) -> Option<&'a Header<'a>> {
115        self.iter_named(name).next_back()
116    }
117
118    pub fn get_last_mut(&'a mut self, name: &str) -> Option<&'a mut Header<'a>> {
119        self.iter_named_mut(name).next_back()
120    }
121
122    pub fn iter_named<'name>(
123        &'a self,
124        name: &'name str,
125    ) -> impl DoubleEndedIterator<Item = &'a Header<'a>> + 'name
126    where
127        'a: 'name,
128    {
129        self.headers
130            .iter()
131            .filter(|header| header.get_name().eq_ignore_ascii_case(name))
132    }
133
134    pub fn iter_named_mut<'name>(
135        &'a mut self,
136        name: &'name str,
137    ) -> impl DoubleEndedIterator<Item = &'a mut Header<'a>> + 'name
138    where
139        'a: 'name,
140    {
141        self.headers
142            .iter_mut()
143            .filter(|header| header.get_name().eq_ignore_ascii_case(name))
144    }
145
146    accessor!(from, "From", MailboxList, as_mailbox_list);
147    accessor!(resent_from, "Resent-From", MailboxList, as_mailbox_list);
148
149    accessor!(to, "To", AddressList, as_address_list);
150    accessor!(reply_to, "Reply-To", AddressList, as_address_list);
151    accessor!(cc, "Cc", AddressList, as_address_list);
152    accessor!(bcc, "Bcc", AddressList, as_address_list);
153    accessor!(resent_to, "Resent-To", AddressList, as_address_list);
154    accessor!(resent_cc, "Resent-Cc", AddressList, as_address_list);
155    accessor!(resent_bcc, "Resent-Bcc", AddressList, as_address_list);
156
157    accessor!(date, "Date", DateTime<FixedOffset>, as_date);
158
159    accessor!(sender, "Sender", Mailbox, as_mailbox);
160    accessor!(resent_sender, "Resent-Sender", Mailbox, as_mailbox);
161
162    accessor!(message_id, "Message-ID", MessageID, as_message_id);
163    accessor!(content_id, "Content-ID", MessageID, as_content_id);
164    accessor!(references, "References", Vec<MessageID>, as_message_id_list);
165
166    accessor!(subject, "Subject", String, as_unstructured);
167    accessor!(comments, "Comments", String, as_unstructured);
168    accessor!(
169        content_transfer_encoding,
170        "Content-Transfer-Encoding",
171        MimeParameters,
172        as_content_transfer_encoding
173    );
174    accessor!(mime_version, "Mime-Version", String, as_unstructured);
175    accessor!(
176        content_disposition,
177        "Content-Disposition",
178        MimeParameters,
179        as_content_disposition
180    );
181
182    accessor!(
183        content_type,
184        "Content-Type",
185        MimeParameters,
186        as_content_type
187    );
188
189    accessor!(
190        authentication_results,
191        "Authentication-Results",
192        AuthenticationResults,
193        as_authentication_results
194    );
195}
mailparsing/headermap.rs

mailparsing/
headermap.rs
