use crate::Result;
use crate::core::config::ExtractionConfig;
use crate::extractors::SyncExtractor;
use crate::extractors::security::SecurityBudget;
use crate::plugins::{InternalDocumentExtractor, Plugin};
use crate::types::internal::InternalDocument;
use crate::types::internal_builder::InternalDocumentBuilder;
use crate::types::metadata::Metadata;
use crate::types::{ArchiveEntry, EmailMetadata, ProcessingWarning};
use ahash::AHashMap;
use async_trait::async_trait;
use std::borrow::Cow;
#[cfg(feature = "tokio-runtime")]
use std::path::Path;
#[cfg_attr(alef, alef(skip))]
pub struct EmailExtractor;
impl Default for EmailExtractor {
fn default() -> Self {
Self::new()
}
}
impl EmailExtractor {
pub(crate) fn new() -> Self {
Self
}
}
impl EmailExtractor {
fn build_internal_document(email_result: &crate::types::EmailExtractionResult) -> InternalDocument {
let mut builder = InternalDocumentBuilder::new("email");
let mut header_entries = Vec::new();
if let Some(ref subject) = email_result.subject {
header_entries.push(("Subject".to_string(), subject.clone()));
}
if let Some(ref from) = email_result.from_email {
header_entries.push(("From".to_string(), from.clone()));
}
if !email_result.to_emails.is_empty() {
header_entries.push(("To".to_string(), email_result.to_emails.join(", ")));
}
if !email_result.cc_emails.is_empty() {
header_entries.push(("CC".to_string(), email_result.cc_emails.join(", ")));
}
if let Some(ref date) = email_result.date {
header_entries.push(("Date".to_string(), date.clone()));
}
if !header_entries.is_empty() {
builder.push_metadata_block(&header_entries, None);
}
if let Some(ref html) = email_result.html_content {
let html_doc = crate::extraction::html::structure::build_document_structure(html);
for (idx, node) in html_doc.nodes.iter().enumerate() {
if node.parent.is_none() {
process_node(&html_doc, idx, &mut builder);
}
}
} else {
for paragraph in email_result.content.split("\n\n") {
let trimmed = paragraph.trim();
if !trimmed.is_empty() {
builder.push_paragraph(trimmed, vec![], None, None);
}
}
}
if !email_result.attachments.is_empty() {
builder.push_paragraph("Attachments:", vec![], None, None);
for att in &email_result.attachments {
let name = att.filename.as_deref().or(att.name.as_deref()).unwrap_or("unnamed");
let size = att.size.unwrap_or(0);
let att_text = format!(" {} ({}B)", name, size);
builder.push_paragraph(&att_text, vec![], None, None);
}
}
builder.build()
}
}
fn process_node(
doc: &crate::types::document_structure::DocumentStructure,
node_idx: usize,
builder: &mut InternalDocumentBuilder,
) {
if let Some(node) = doc.nodes.get(node_idx) {
match &node.content {
crate::types::NodeContent::Paragraph { text } => {
let trimmed = text.trim();
if !trimmed.is_empty() {
builder.push_paragraph(trimmed, node.annotations.clone(), None, None);
}
}
crate::types::NodeContent::Heading { level, text } => {
builder.push_heading(*level, text.as_str(), None, None);
}
crate::types::NodeContent::Title { text } => {
builder.push_title(text.as_str(), None, None);
}
crate::types::NodeContent::List { ordered } => {
builder.push_list(*ordered);
for &child_idx in &node.children {
process_node(doc, child_idx.0 as usize, builder);
}
builder.end_list();
}
crate::types::NodeContent::ListItem { text } => {
let ordered = if let Some(parent_idx) = node.parent
&& let Some(parent) = doc.nodes.get(parent_idx.0 as usize)
&& let crate::types::NodeContent::List { ordered } = parent.content
{
ordered
} else {
false
};
builder.push_list_item(text.as_str(), ordered, node.annotations.clone(), None, None);
for &child_idx in &node.children {
process_node(doc, child_idx.0 as usize, builder);
}
}
crate::types::NodeContent::Table { grid } => {
let rows = crate::extraction::grid_flatten::flatten_positioned_cells(
grid.rows as usize,
grid.cells
.iter()
.map(|c| (c.row, c.row_span, c.col_span, c.content.clone())),
);
builder.push_table_from_cells(&rows, None, None);
}
crate::types::NodeContent::Code { text, language } => {
builder.push_code(text.as_str(), language.as_deref(), None, None);
}
crate::types::NodeContent::Formula { text } => {
builder.push_formula(text.as_str(), None, None);
}
crate::types::NodeContent::MetadataBlock { entries } => {
builder.push_metadata_block(entries, None);
}
crate::types::NodeContent::Quote => {
builder.push_quote_start();
for &child_idx in &node.children {
process_node(doc, child_idx.0 as usize, builder);
}
builder.push_quote_end();
}
crate::types::NodeContent::Group { label, .. } => {
builder.push_group_start(label.as_deref(), None);
for &child_idx in &node.children {
process_node(doc, child_idx.0 as usize, builder);
}
builder.push_group_end();
}
crate::types::NodeContent::Admonition { kind, title } => {
builder.push_admonition(kind, title.as_deref(), None);
for &child_idx in &node.children {
process_node(doc, child_idx.0 as usize, builder);
}
}
crate::types::NodeContent::Image { description, .. } => {
let text = description.as_deref().unwrap_or("[Image]");
builder.push_paragraph(text, vec![], None, None);
}
_ => {
if let Some(text) = node.content.text() {
let trimmed = text.trim();
if !trimmed.is_empty() {
builder.push_paragraph(trimmed, node.annotations.clone(), None, None);
}
}
}
}
}
}
impl Plugin for EmailExtractor {
fn name(&self) -> &str {
"email-extractor"
}
fn version(&self) -> String {
env!("CARGO_PKG_VERSION").to_string()
}
fn initialize(&self) -> Result<()> {
Ok(())
}
fn shutdown(&self) -> Result<()> {
Ok(())
}
}
impl SyncExtractor for EmailExtractor {
fn extract_sync(&self, content: &[u8], mime_type: &str, config: &ExtractionConfig) -> Result<InternalDocument> {
let fallback_codepage = config.email.as_ref().and_then(|e| e.msg_fallback_codepage);
let email_result = crate::extraction::email::extract_email_content(content, mime_type, fallback_codepage)?;
let attachment_names: Vec<String> = email_result
.attachments
.iter()
.filter_map(|att| att.filename.clone().or_else(|| att.name.clone()))
.collect();
const EMAIL_STRUCT_KEYS: &[&str] = &[
"from_email",
"from_name",
"to_emails",
"cc_emails",
"bcc_emails",
"message_id",
"attachments",
"subject",
"date",
"email_from",
"email_to",
"email_cc",
"email_bcc",
];
let mut additional = AHashMap::new();
for (key, value) in &email_result.metadata {
if !EMAIL_STRUCT_KEYS.contains(&key.as_str()) {
additional.insert(Cow::Owned(key.clone()), serde_json::json!(value));
}
}
let mut doc = Self::build_internal_document(&email_result);
doc.mime_type = mime_type.to_string();
let subject = email_result.subject;
let created_at = email_result.date;
let from_name = email_result.metadata.get("from_name").cloned();
let email_metadata = EmailMetadata {
from_email: email_result.from_email,
from_name: from_name.clone(),
to_emails: email_result.to_emails,
cc_emails: email_result.cc_emails,
bcc_emails: email_result.bcc_emails,
message_id: email_result.message_id,
attachments: attachment_names,
};
let authors = from_name.filter(|n| !n.is_empty()).map(|n| vec![n]);
doc.metadata = Metadata {
format: Some(crate::types::FormatMetadata::Email(email_metadata)),
subject,
authors,
created_at,
additional,
..Default::default()
};
let mut budget = SecurityBudget::from_config(config);
for elem in &doc.elements {
budget.account_text(elem.text.len())?;
}
Ok(doc)
}
}
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
impl InternalDocumentExtractor for EmailExtractor {
async fn extract_content(
&self,
content: &[u8],
mime_type: &str,
config: &ExtractionConfig,
) -> Result<InternalDocument> {
tracing::debug!(format = "email", size_bytes = content.len(), "extraction starting");
let mut doc = self.extract_sync(content, mime_type, config)?;
if config.max_archive_depth > 0 {
let fallback_codepage = config.email.as_ref().and_then(|e| e.msg_fallback_codepage);
if let Ok(email_result) =
crate::extraction::email::extract_email_content(content, mime_type, fallback_codepage)
{
let (mut children, warnings) = extract_attachment_children(&email_result.attachments, config).await;
if mime_type == "message/rfc822" {
let (nested_children, nested_warnings) = extract_nested_message_children(content, config).await;
children.extend(nested_children);
doc.processing_warnings.extend(nested_warnings);
}
if !children.is_empty() {
doc.children = Some(children);
}
doc.processing_warnings.extend(warnings);
}
}
tracing::debug!(
element_count = doc.elements.len(),
format = "email",
"extraction complete"
);
Ok(doc)
}
#[cfg(feature = "tokio-runtime")]
#[cfg_attr(feature = "otel", tracing::instrument(
skip(self, path, config),
fields(
extractor.name = self.name(),
)
))]
async fn extract_path(&self, path: &Path, mime_type: &str, config: &ExtractionConfig) -> Result<InternalDocument> {
let bytes = crate::core::io::read_file_async(path).await?;
self.extract_content(&bytes, mime_type, config).await
}
fn supported_mime_types(&self) -> &[&str] {
&["message/rfc822", "application/vnd.ms-outlook"]
}
fn priority(&self) -> i32 {
50
}
}
pub(crate) async fn extract_attachment_children(
attachments: &[crate::types::EmailAttachment],
config: &ExtractionConfig,
) -> (Vec<ArchiveEntry>, Vec<ProcessingWarning>) {
let mut children = Vec::new();
let mut warnings = Vec::new();
for (idx, attachment) in attachments.iter().enumerate() {
let bytes = match &attachment.data {
Some(data) if !data.is_empty() => data,
_ => continue,
};
let filename = attachment
.filename
.clone()
.or_else(|| attachment.name.clone())
.unwrap_or_else(|| format!("attachment_{}", idx));
let detected_mime = crate::core::mime::detect_mime_type_from_bytes(bytes)
.ok()
.or_else(|| {
std::path::Path::new(&filename)
.extension()
.and_then(|ext| ext.to_str())
.and_then(|ext| mime_guess::from_ext(ext).first())
.map(|m| m.to_string())
})
.or_else(|| attachment.mime_type.clone().filter(|m| m != "application/octet-stream"));
let file_mime = match detected_mime {
Some(m) if m != "application/octet-stream" => m,
_ => continue,
};
if config
.max_embedded_file_bytes
.is_some_and(|cap| bytes.len() as u64 > cap)
{
let cap = config.max_embedded_file_bytes.unwrap_or(0);
warnings.push(ProcessingWarning {
source: Cow::Borrowed("email_attachment_extraction"),
message: Cow::Owned(format!(
"Skipped attachment '{}': size {} bytes exceeds cap {} bytes",
filename,
bytes.len(),
cap
)),
});
continue;
}
let mut child_config = config.clone();
child_config.max_archive_depth = config.max_archive_depth.saturating_sub(1);
match crate::core::extractor::extract_bytes(bytes, &file_mime, &child_config).await {
Ok(result) => {
children.push(ArchiveEntry {
path: filename,
mime_type: file_mime,
result: Box::new(result),
});
}
Err(e) => {
warnings.push(ProcessingWarning {
source: Cow::Borrowed("email_attachment_extraction"),
message: Cow::Owned(format!("Failed to extract '{}': {}", filename, e)),
});
}
}
}
(children, warnings)
}
async fn extract_nested_message_children(
content: &[u8],
config: &ExtractionConfig,
) -> (Vec<ArchiveEntry>, Vec<ProcessingWarning>) {
use mail_parser::PartType;
let mut children = Vec::new();
let mut warnings = Vec::new();
let message = match mail_parser::MessageParser::default().parse(content) {
Some(msg) => msg,
None => return (children, warnings),
};
let mut nested_idx: usize = 0;
for part in &message.parts {
if let PartType::Message(sub_msg) = &part.body {
let raw_bytes = sub_msg.raw_message();
if raw_bytes.is_empty() {
continue;
}
let filename = format!("nested_message_{nested_idx}.eml");
nested_idx += 1;
let mut child_config = config.clone();
child_config.max_archive_depth = config.max_archive_depth.saturating_sub(1);
match crate::core::extractor::extract_bytes(raw_bytes, "message/rfc822", &child_config).await {
Ok(result) => {
children.push(ArchiveEntry {
path: filename,
mime_type: "message/rfc822".to_string(),
result: Box::new(result),
});
}
Err(e) => {
warnings.push(ProcessingWarning {
source: Cow::Borrowed("nested_message_extraction"),
message: Cow::Owned(format!("Failed to extract '{}': {}", filename, e)),
});
}
}
}
}
(children, warnings)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_email_extractor_plugin_interface() {
let extractor = EmailExtractor::new();
assert_eq!(extractor.name(), "email-extractor");
assert!(extractor.initialize().is_ok());
assert!(extractor.shutdown().is_ok());
}
#[test]
fn test_email_extractor_supported_mime_types() {
let extractor = EmailExtractor::new();
let mime_types = extractor.supported_mime_types();
assert_eq!(mime_types.len(), 2);
assert!(mime_types.contains(&"message/rfc822"));
assert!(mime_types.contains(&"application/vnd.ms-outlook"));
}
#[test]
fn test_email_extractor_uses_config() {
use crate::core::config::EmailConfig;
let config = ExtractionConfig {
email: Some(EmailConfig {
msg_fallback_codepage: Some(1251),
}),
..Default::default()
};
let extractor = EmailExtractor::new();
let result = extractor.extract_sync(b"", "application/vnd.ms-outlook", &config);
assert!(result.is_err());
}
#[test]
fn test_email_with_table_and_list_preservation() {
let eml = r#"From: Alice <alice@example.com>
To: Bob <bob@example.com>
Subject: Table and List Repro
Content-Type: multipart/alternative; boundary="boundary"
--boundary
Content-Type: text/plain; charset=utf-8
Plain text fallback.
--boundary
Content-Type: text/html; charset=utf-8
<html>
<body>
<p>Introduction.</p>
<table>
<tr><th>Name</th><th>Value</th></tr>
<tr><td>Key</td><td>123</td></tr>
</table>
<ol>
<li>First item</li>
<li>Second item</li>
</ol>
<p>Conclusion.</p>
</body>
</html>
--boundary--
"#;
let extractor = EmailExtractor::new();
let config = ExtractionConfig::default();
let doc = extractor
.extract_sync(eml.as_bytes(), "message/rfc822", &config)
.unwrap();
let has_table = doc
.elements
.iter()
.any(|e| matches!(e.kind, crate::types::internal::ElementKind::Table { .. }));
let list_item_count = doc
.elements
.iter()
.filter(|e| matches!(e.kind, crate::types::internal::ElementKind::ListItem { .. }))
.count();
let paragraph_count = doc
.elements
.iter()
.filter(|e| matches!(e.kind, crate::types::internal::ElementKind::Paragraph))
.count();
assert!(has_table, "Table element should be present");
assert_eq!(list_item_count, 2, "Should have 2 list items");
assert_eq!(
paragraph_count, 2,
"Should have exactly 2 body paragraphs (no duplicates)"
);
}
#[test]
fn test_content_size_guard_fires_when_limit_exceeded() {
use crate::extractors::security::SecurityLimits;
let long_body = "x".repeat(1000);
let eml = format!("From: sender@example.com\r\nSubject: Big\r\n\r\n{}", long_body);
let config = ExtractionConfig {
security_limits: Some(SecurityLimits {
max_content_size: 10,
..SecurityLimits::default()
}),
..Default::default()
};
let extractor = EmailExtractor::new();
let result = extractor.extract_sync(eml.as_bytes(), "message/rfc822", &config);
assert!(
result.is_err(),
"extraction must fail when content exceeds max_content_size"
);
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.to_lowercase().contains("security") || err_msg.to_lowercase().contains("content"),
"error must mention security or content: {}",
err_msg
);
}
#[test]
fn test_content_size_guard_passes_for_normal_email() {
let eml = "From: sender@example.com\r\nSubject: Hi\r\n\r\nHello world.";
let config = ExtractionConfig::default();
let extractor = EmailExtractor::new();
let result = extractor.extract_sync(eml.as_bytes(), "message/rfc822", &config);
assert!(result.is_ok(), "normal email must not be rejected: {:?}", result.err());
}
}