Parseur main feature is to extract custom data from emails content. However, sometimes you want to extract email metadata as well and include them in your parsed data. Let’s see how to include metadata in your parsed data and what metadata is available in Parseur.
What are email metadata?
Email metadata is all the information that surrounds the content of the email itself.
- Subject, Sender (From), recipient (To), carbon copy (CC) and blind carbon copy (BCC) information
- Email reception date and time
- Information regarding the mail servers and network routing
In addition to extracting custom data from the content of emails and documents, you can also extract email metadata using Parseur.
How to extract email metadata in Parseur?
In Parseur, metadata fields are called “Extra fields“. This is as opposed to the “Custom fields” that you make when creating templates.
To add Extra fields in Parseur:
- Open the Parseur App
- Make sure you have created a mailbox or create a new one (if you’re new to Parseur, head over to our getting started article)
- Open your Parseur mailbox
- Click on the Fields section on the left hand side menu
- This section will list all available metadata extra fields below your custom fields
- Click on the extra fields you need. You can also mouse over them to get more information about the extra field.
Note: extra fields will only appear in new parsed documents. To add those fields to existing parsed documents, just reprocess the documents. To do so, head over to the document queue and use one of the reprocess buttons to re-run the parsing. You can either reprocess a single document or all documents at once.
What email metadata fields are available in Parseur?
Parseur can extract different type of document metadata.
Date and Time metadata
There are 3 Datetime metadata fields available:
- Received: date and time when Parseur received the document
- ReceivedDate: date when Parseur received the document
- ReceivedTime: time of the day when Parseur received the document
These fields are formatted according to your Date and Time formatting preferences. Head over to your User Preferences to change them.
Email address metadata
There are 3 email metadata fields available:
- Sender: the email address that sent the email to Parseur. This will usually be the same address as the OriginalRecipient address, unless your mailbox receives emails from different aliases (or is a catch-all)
- Recipient: the email address that received the email. It is your Parseur mailbox address (in the form <your-mailbox-name>@in.parseur.com)
- RecipientSuffix: the recipient suffix (or alias suffix) that you used. Say you have created a mailbox named [email protected] You can also send emails to [email protected] or [email protected] and all emails we land in the same mailbox. When you use such aliases, the RecipientSuffix field will contain what is after the + (for example test123 and id456 in the examples given before). This can be particularly useful if you forward emails from different sources and want to know which source sent what email.
- OriginalRecipient: the email address that received the email before forwarding it to Parseur. Note: this will only work after you set up automatic forwarding of your emails (it will be equal to the Recipient otherwise)
Document Content metadata
There are 3 content related metadata fields available:
- Subject: the title of the document. Depending on the type of document, this is either:
- the subject of the email,
- the filename of the attachment
- the url of the linked web page
- HtmlDocument: the full content of the document including HTML formatting
- TextDocument: the full content of the document in Text (excluding any HTML formatting)
- LastReply: the content of the last reply in the email chain (in plain text)
These fields are particularly useful if you set-up a trigger for when a document cannot be parsed. This way, not only can you get a real time notification when an document parsing fails, but you can also check the title and content of the document without having to log onto Parseur.
Non only can you extract email metadata in Parseur, but we also have 3 metadata fields specific to Parseur:
- DocumentURL: a link to the document in Parseur App. Useful if you have an integration where you want to be able to quickly open the app and check the document. This link will redirect to Parseur App and hence requires you to be authenticated with Parseur to access it.
- PublicDocumentURL: a public link to the Document. You need to be very careful when sharing this link as anyone with the link can access your document without any authentication.
- Template: the name of the Parseur template that was used to parse the document.