Skip to content

chunklet.document_chunker.processors.eml_processor

Classes:

  • EmlProcessor –

    Processor class for extracting text and metadata from EML (RFC 822) email files.

EmlProcessor 

EmlProcessor(file_path: str)

Bases: BaseProcessor

Processor class for extracting text and metadata from EML (RFC 822) email files.

Text content is extracted from the decoded plain-text body of the email.

This processor focuses on extracting commonly used email header metadata together with the names of attached and inline files. The extracted metadata corresponds to fields available from the parsed mail object returned by the underlying email parser. Not all available message fields are extracted.

For more details on the parsed mail object and the available fields, refer to the MailParser documentation:

https://nodemailer.com/extras/mailparser/#returned-mail-object

Initializes the EmlProcessor with a path to the EML file and parses the email into memory.

Parameters:

  • file_path

    (str) –

    Path to the EML file.

Methods:

  • extract_metadata –

    Extracts commonly used email metadata from the parsed message.

  • extract_text –

    Yields the decoded plain-text body of the email.

Source code in src/chunklet/document_chunker/processors/eml_processor.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def __init__(self, file_path: str):
    """
    Initializes the EmlProcessor with a path to the EML file
    and parses the email into memory.

    Args:
        file_path: Path to the EML file.
    """
    super().__init__(file_path)
    try:
        from mailparse import EmailDecode
    except ImportError as e:  # pragma: no cover
        raise ImportError(
            "The 'mailparse' library is not installed. "
            "Please install it with 'pip install mailparse>=1.0.1'. or install the document processing extras "
            "with 'pip install 'chunklet-py[structured-document]'"
        ) from e
    self._parsed = EmailDecode.open(self.file_path)

extract_metadata 

extract_metadata() -> dict[str, Any]

Extracts commonly used email metadata from the parsed message.

Returns:

  • dict[str, Any] –

    A dictionary containing metadata fields. - source - subject - from - to - cc - date - message_id - in_reply_to - references - attachment_names - inline_names

Source code in src/chunklet/document_chunker/processors/eml_processor.py 
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
def extract_metadata(self) -> dict[str, Any]:
    """
    Extracts commonly used email metadata from the parsed message.

    Returns:
        A dictionary containing metadata fields.
            - source
            - subject
            - from
            - to
            - cc
            - date
            - message_id
            - in_reply_to
            - references
            - attachment_names
            - inline_names
    """
    metadata = {"source": str(self.file_path)}
    for field in self.METADATA_FIELDS:
        if field in {"attachment_names", "inline_names"}:
            field_prefix = field.split("_")[0]
            names = [
                attachment["name"]
                for attachment in self._parsed.get(field_prefix, [])
            ]
            if names:
                metadata[field] = names
        if val := self._parsed.get(field):
            metadata[field] = val

        return metadata

extract_text 

extract_text() -> Generator[str, None, None]

Yields the decoded plain-text body of the email.

Yields:

  • str –

    Plain-text content extracted from the email body.

Source code in src/chunklet/document_chunker/processors/eml_processor.py 
89
90
91
92
93
94
95
96
97
98
def extract_text(self) -> Generator[str, None, None]:
    """
    Yields the decoded plain-text body of the email.

    Yields:
        Plain-text content extracted from the email body.
    """
    text = self._parsed.get("text")
    if text:
        yield text