API Reference

Email

Email structure with metadata and attachments.

Fields

• from::Union{Nothing,Vector{String}}: Vector of the email sender(s) addresses.
• to::Union{Nothing,Vector{String}}: Vector of the email recipient(s) addresses.
• date::Union{Nothing,DateTime}: The date and time the email was sent.
• received_at::Union{Nothing,DateTime}: The date and time the email was received_at.
• text_body::Vector{UInt8}: Binary data of the email's text body.
• attachments::Vector{EmailAttachment}: Vector of the email attachments with metadata.

EmailAttachment

Fields

• name::Union{Nothing,String}: The attachment's file name.
• encoding::Union{Nothing,String}: The encoding type of the attachment.
• mime_type::Union{Nothing,String}: The attachment's MIME type.
• body::Vector{UInt8}: Binary data of the attachment.

parse_email(data::AbstractVector{UInt8}) -> Email
parse_email(data::AbstractString) -> Email

Parse a binary vector or string data into an Email.

Example

julia> email_string = """
       MIME-Version: 1.0
       Date: Fri, 7 Mar 1997 17:30:00 +0500
       Message-ID: <CAOU+8LMfxVaPMmigMQE2qTBLSbNdKQVps=Fi0S3X8LnfxT2xee@mail.email.com>
       Subject: Test Message
       From: Test User <username@example.com>
       To: Test User <username@example.com>
       Content-Type: multipart/alternative; boundary="000000000000dd23a50621ff39e8"

       --000000000000dd23a50621ff39e8
       Content-Type: text/plain; charset="UTF-8"

       Hello World!

       Best regards,
       Test User

       --000000000000dd23a50621ff39e8
       Content-Type: text/html; charset="UTF-8"

       <div dir="ltr">Hello World!<div><br></div><div>Best regards,</div><div>Test User</div></div>

       --000000000000dd23a50621ff39e8--
       """;

julia> email = parse_email(email_string)
📧 Email:
   📤 From: Test User <username@example.com>
   📥 To: Test User <username@example.com>
   🕒 Date: 1997-03-07T17:30:00
   📝 Text size: 39 bytes
   📨 No attachments.