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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
#[cfg(feature = "arbitrary")]
use arbitrary::Arbitrary;
#[cfg(feature = "bounded-static")]
use bounded_static::ToStatic;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use crate::{
core::{IString, NString, NonEmptyVec},
envelope::Envelope,
};
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Body<'a> {
/// Basic fields
pub basic: BasicFields<'a>,
/// Type-specific fields
pub specific: SpecificFields<'a>,
}
/// The basic fields of a non-multipart body part.
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct BasicFields<'a> {
/// List of attribute/value pairs ([MIME-IMB].)
pub parameter_list: Vec<(IString<'a>, IString<'a>)>,
/// Content id ([MIME-IMB].)
pub id: NString<'a>,
/// Content description ([MIME-IMB].)
pub description: NString<'a>,
/// Content transfer encoding ([MIME-IMB].)
pub content_transfer_encoding: IString<'a>,
/// Size of the body in octets.
///
/// Note that this size is the size in its transfer encoding
/// and not the resulting size after any decoding.
pub size: u32,
}
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SpecificFields<'a> {
/// # Example (not in RFC)
///
/// Single application/{voodoo, unknown, whatever, meh} is represented as "basic"
///
/// ```text
/// (
/// "application" "voodoo" NIL NIL NIL "7bit" 20
/// ^^^ ^^^ ^^^ ^^^^^^ ^^
/// | | | | | size
/// | | | | content transfer encoding
/// | | | description
/// | | id
/// | parameter list
///
/// NIL NIL NIL NIL
/// ^^^ ^^^ ^^^ ^^^
/// | | | | location
/// | | | language
/// | | disposition
/// | md5
/// )
/// ```
Basic {
/// A string giving the content media type name as defined in [MIME-IMB].
r#type: IString<'a>,
/// A string giving the content subtype name as defined in [MIME-IMB].
subtype: IString<'a>,
},
/// # Example (not in RFC)
///
/// Single message/rfc822 is represented as "message"
///
/// ```text
/// (
/// "message" "rfc822" NIL NIL NIL "7bit" 123
/// ^^^ ^^^ ^^^ ^^^^^^ ^^^
/// | | | | | size
/// | | | | content transfer encoding
/// | | | description
/// | | id
/// | parameter list
///
/// # envelope
/// (
/// NIL "message.inner.subject.ljcwooqy" ((NIL NIL "extern" "company.com")) ((NIL NIL "extern" "company.com")) ((NIL NIL "extern" "company.com")) ((NIL NIL "admin" "seurity.com")) NIL NIL NIL NIL
/// )
///
/// # body structure
/// (
/// "text" "plain" ("charset" "us-ascii") NIL NIL "7bit" 31
/// 2
/// NIL NIL NIL NIL
/// )
///
/// 6
/// ^
/// | number of lines
///
/// NIL NIL NIL NIL
/// ^^^ ^^^ ^^^ ^^^
/// | | | | location
/// | | | language
/// | | disposition
/// | md5
/// )
/// ```
///
/// A body type of type MESSAGE and subtype RFC822 contains, immediately after the basic fields,
Message {
/// the envelope structure,
envelope: Box<Envelope<'a>>,
/// body structure,
body_structure: Box<BodyStructure<'a>>,
/// and size in text lines of the encapsulated message.
number_of_lines: u32,
},
/// # Example (not in RFC)
///
/// Single text/plain is represented as "text"
///
/// ```text
/// (
/// "text" "plain" ("charset" "us-ascii") NIL NIL "7bit" 25
/// ^^^^^^^^^^^^^^^^^^^^^^ ^^^ ^^^ ^^^^^^ ^^
/// | | | | | size
/// | | | | content transfer encoding
/// | | | description
/// | | id
/// | parameter list
///
/// 1
/// ^
/// | number of lines
///
/// NIL NIL NIL NIL
/// ^^^ ^^^ ^^^ ^^^
/// | | | | location
/// | | | language
/// | | disposition
/// | md5
/// )
/// ```
///
/// A body type of type TEXT contains, immediately after the basic fields,
Text {
subtype: IString<'a>,
/// the size of the body in text lines.
number_of_lines: u32,
},
}
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum BodyStructure<'a> {
/// For example, a simple text message of 48 lines and 2279 octets
/// can have a body structure of:
///
/// ```text
/// ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 2279 48)
/// ```
Single {
body: Body<'a>,
/// Extension data
///
/// Extension data is never returned with the BODY fetch,
/// but can be returned with a BODYSTRUCTURE fetch.
/// Extension data, if present, MUST be in the defined order.
///
/// Any following extension data are not yet defined in this
/// version of the protocol, and would be as described above under
/// multipart extension data.
extension_data: Option<SinglePartExtensionData<'a>>,
},
/// Multiple parts are indicated by parenthesis nesting. Instead
/// of a body type as the first element of the parenthesized list,
/// there is a sequence of one or more nested body structures. The
/// second (last?!) element of the parenthesized list is the multipart
/// subtype (mixed, digest, parallel, alternative, etc.).
///
/// For example, a two part message consisting of a text and a
/// BASE64-encoded text attachment can have a body structure of:
///
/// ```text
/// (
/// ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 1152 23)
/// ("TEXT" "PLAIN" ("CHARSET" "US-ASCII" "NAME" "cc.diff") "<960723163407.20117h@cac.washington.edu>" "Compiler diff" "BASE64" 4554 73)
/// "MIXED"
/// )
/// ```
///
/// Extension data follows the multipart subtype. Extension data
/// is never returned with the BODY fetch, but can be returned with
/// a BODYSTRUCTURE fetch. Extension data, if present, MUST be in
/// the defined order.
///
/// See [ExtensionMultiPartData](struct.ExtensionMultiPartData.html).
///
/// Any following extension data are not yet defined in this
/// version of the protocol. Such extension data can consist of
/// zero or more NILs, strings, numbers, or potentially nested
/// parenthesized lists of such data. Client implementations that
/// do a BODYSTRUCTURE fetch MUST be prepared to accept such
/// extension data. Server implementations MUST NOT send such
/// extension data until it has been defined by a revision of this
/// protocol.
///
/// # Example (not in RFC)
///
/// Multipart/mixed is represented as follows...
///
/// ```text
/// (
/// ("text" "html" ("charset" "us-ascii") NIL NIL "7bit" 28 0 NIL NIL NIL NIL)
/// ("text" "plain" ("charset" "us-ascii") NIL NIL "7bit" 11 0 NIL NIL NIL NIL)
/// "mixed" ("boundary" "xxx") NIL NIL NIL
/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// |
/// | extension data
/// )
/// ```
Multi {
bodies: NonEmptyVec<BodyStructure<'a>>,
subtype: IString<'a>,
extension_data: Option<MultiPartExtensionData<'a>>,
},
}
/// The extension data of a non-multipart body part.
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SinglePartExtensionData<'a> {
/// A string giving the body MD5 value as defined in \[MD5\].
pub md5: NString<'a>,
/// (Optional) additional data.
pub tail: Option<Disposition<'a>>,
}
/// The extension data of a multipart body part.
///
/// # Trace (not in RFC)
///
/// ```text
/// (
/// ("text" "html" ("charset" "us-ascii") NIL NIL "7bit" 28 0 NIL NIL NIL NIL)
/// ("text" "plain" ("charset" "us-ascii") NIL NIL "7bit" 11 0 NIL NIL NIL NIL)
/// "mixed" ("boundary" "xxx") NIL NIL NIL
/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// |
/// | extension multipart data
/// )
/// ```
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct MultiPartExtensionData<'a> {
/// A parenthesized list of attribute/value pairs [e.g., ("foo"
/// "bar" "baz" "rag") where "bar" is the value of "foo", and
/// "rag" is the value of "baz"] as defined in [MIME-IMB].
pub parameter_list: Vec<(IString<'a>, IString<'a>)>,
/// (Optional) additional data.
pub tail: Option<Disposition<'a>>,
}
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Disposition<'a> {
/// A parenthesized list, consisting of a disposition type
/// string, followed by a parenthesized list of disposition
/// attribute/value pairs as defined in \[DISPOSITION\].
pub disposition: Option<(IString<'a>, Vec<(IString<'a>, IString<'a>)>)>,
/// (Optional) additional data.
pub tail: Option<Language<'a>>,
}
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Language<'a> {
/// A string or parenthesized list giving the body language
/// value as defined in [LANGUAGE-TAGS].
pub language: Vec<IString<'a>>,
/// (Optional) additional data.
pub tail: Option<Location<'a>>,
}
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Location<'a> {
/// A string list giving the body content URI as defined in \[LOCATION\].
pub location: NString<'a>,
/// Extension data.
pub extensions: Vec<BodyExtension<'a>>,
}
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum BodyExtension<'a> {
NString(NString<'a>),
Number(u32),
List(NonEmptyVec<BodyExtension<'a>>),
}