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) -> Result<()> {
67                if let Some(idx) = self
68                    .headers
69                    .iter()
70                    .position(|header| header.get_name().eq_ignore_ascii_case($header_name))
71                {
72                    if let Some(hdr) = v.as_header(self.headers[idx].get_name()) {
73                        hdr.$parser()?;
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                        hdr.$parser()?;
81                        self.headers.push(hdr);
82                    } else {
83                        self.headers
84                            .push(Header::with_name_value($header_name, v.encode_value()));
85                    }
86                }
87                Ok(())
88            }
89        }
90    };
91}
92
93impl<'a> HeaderMap<'a> {
94    pub fn new(headers: Vec<Header<'a>>) -> Self {
95        Self { headers }
96    }
97
98    pub fn to_owned(&'a self) -> HeaderMap<'static> {
99        HeaderMap {
100            headers: self.headers.iter().map(|h: &Header| h.to_owned()).collect(),
101        }
102    }
103
104    pub fn remove_all_named(&mut self, name: &str) {
105        self.headers
106            .retain(|hdr| !hdr.get_name().eq_ignore_ascii_case(name));
107    }
108
109    pub fn prepend<V: Into<SharedString<'a>>>(&mut self, name: &str, v: V) {
110        self.headers
111            .insert(0, Header::new_unstructured(name.to_string(), v));
112    }
113
114    pub fn get_first(&'a self, name: &str) -> Option<&'a Header<'a>> {
115        self.iter_named(name).next()
116    }
117
118    pub fn get_first_mut(&'a mut self, name: &str) -> Option<&'a mut Header<'a>> {
119        self.iter_named_mut(name).next()
120    }
121
122    pub fn get_last(&'a self, name: &str) -> Option<&'a Header<'a>> {
123        self.iter_named(name).next_back()
124    }
125
126    pub fn get_last_mut(&'a mut self, name: &str) -> Option<&'a mut Header<'a>> {
127        self.iter_named_mut(name).next_back()
128    }
129
130    pub fn iter_named<'name>(
131        &'a self,
132        name: &'name str,
133    ) -> impl DoubleEndedIterator<Item = &'a Header<'a>> + 'name
134    where
135        'a: 'name,
136    {
137        self.headers
138            .iter()
139            .filter(|header| header.get_name().eq_ignore_ascii_case(name))
140    }
141
142    pub fn iter_named_mut<'name>(
143        &'a mut self,
144        name: &'name str,
145    ) -> impl DoubleEndedIterator<Item = &'a mut Header<'a>> + 'name
146    where
147        'a: 'name,
148    {
149        self.headers
150            .iter_mut()
151            .filter(|header| header.get_name().eq_ignore_ascii_case(name))
152    }
153
154    accessor!(from, "From", MailboxList, as_mailbox_list);
155    accessor!(resent_from, "Resent-From", MailboxList, as_mailbox_list);
156
157    accessor!(to, "To", AddressList, as_address_list);
158    accessor!(reply_to, "Reply-To", AddressList, as_address_list);
159    accessor!(cc, "Cc", AddressList, as_address_list);
160    accessor!(bcc, "Bcc", AddressList, as_address_list);
161    accessor!(resent_to, "Resent-To", AddressList, as_address_list);
162    accessor!(resent_cc, "Resent-Cc", AddressList, as_address_list);
163    accessor!(resent_bcc, "Resent-Bcc", AddressList, as_address_list);
164
165    accessor!(date, "Date", DateTime<FixedOffset>, as_date);
166
167    accessor!(sender, "Sender", Mailbox, as_mailbox);
168    accessor!(resent_sender, "Resent-Sender", Mailbox, as_mailbox);
169
170    accessor!(message_id, "Message-ID", MessageID, as_message_id);
171    accessor!(content_id, "Content-ID", MessageID, as_content_id);
172    accessor!(references, "References", Vec<MessageID>, as_message_id_list);
173
174    accessor!(subject, "Subject", String, as_unstructured);
175    accessor!(comments, "Comments", String, as_unstructured);
176    accessor!(
177        content_transfer_encoding,
178        "Content-Transfer-Encoding",
179        MimeParameters,
180        as_content_transfer_encoding
181    );
182    accessor!(mime_version, "Mime-Version", String, as_unstructured);
183    accessor!(
184        content_disposition,
185        "Content-Disposition",
186        MimeParameters,
187        as_content_disposition
188    );
189
190    accessor!(
191        content_type,
192        "Content-Type",
193        MimeParameters,
194        as_content_type
195    );
196
197    accessor!(
198        authentication_results,
199        "Authentication-Results",
200        AuthenticationResults,
201        as_authentication_results
202    );
203}
mailparsing/headermap.rs

mailparsing/
headermap.rs
