Structure of an Email

In order to fully utilize Port87's search feature, it's helpful to understand the structure of an email inside Port87. The search bar searches for "Mail" objects, which represent an email message. You can use the properties of the mail objects to narrow your search.

Mail Object

The mail object has the following properties:

• guid: A globally unique identifier. Every object has one.
• cdate: A timestamp of when the object was created.
• mdate: A timestamp of when the object was last modified.
• tags: A list of tags. These can include "system", "auto", "autoreply", "bare", "read", "draft", and "sent".
• labels: A list of labels applied to the email.
• receivedFrom: The "return path" address the email was received from.
• receivedTo: The "mail to" address the email was received to.
• headers: A headers object holding additional headers for the email.
• body: A body object holding the contents of the email.
• size: The message's size, in bytes.
• attachments: The number of attachments the email has.
• delivered: A boolean (true or false), representing whether the email was delivered. This will be false if an email is waiting for screening. This will also be false for draft emails.
• rejected: If a sent email was rejected, this contains the reason given by the destination server.
• trash: A timestamp of when the email was placed in the trash.
• threadId: A thread ID, which is shared by other emails a message relates to, like replies.

The following properties come from the email's headers:

• date: A timestamp of the "Date" header.
• subject: The "Subject" header.
• from: The "From" header, containing the author's name and address.
• sender: The "Sender" header. When an email is sent by another person than the From address, it can use the sender to specify who actually sent the email.
• replyTo: An address that replies should be directed to.
• to: The address or list of addresses the email was sent to.
• cc: The address or list of addresses the email was copied to.
• bcc: The address or list of addresses the email was blind copied to. This will only exist on your sent mail.
• messageId: A unique message identifier assigned by the sending server.
• inReplyTo: The message ID of the message this one is a reply to.
• references: The message IDs of all of the emails this one references (often includes older messages in a thread).

Headers Object

In addition to these standard headers, an email contains other headers. These are stored on the object referenced in the headers property. This object uses the class name "Headers", and has the following properties:

• guid: A globally unique identifier. Every object has one.
• cdate: A timestamp of when the object was created.
• mdate: A timestamp of when the object was last modified.
• Arbitrary-Header-Name: A string or list of strings containing the content or contents of the named header. If the header only appears once, this will be a string. If the header appears multiple times, this will be an array of strings. The header name comes from the email, and can be anything. Common header names are "Content-Type", "Content-Size", "Authentication-Results", and "Received", but an email can contain basically anything as a header.

Body Object

The object referenced in the body property of the mail object stores an email message's content. This object uses the class name "Body", and has the following properties:

• guid: A globally unique identifier. Every object has one.
• cdate: A timestamp of when the object was created.
• mdate: A timestamp of when the object was last modified.
• html: The HTML (formatted) content of the email.
• text: The plain text (unformatted) content of the email.
• attachments: A list of attachments on the email.

Label Object

The object(s) referenced in the labels property of the mail object are the labels assigned to the message. These objects use the class name "Label", and have the following properties:

• guid: A globally unique identifier. Every object has one.
• cdate: A timestamp of when the object was created.
• mdate: A timestamp of when the object was last modified.
• name: The name of the label.
• id: The ID of the label. This creates the label's email address.
• domain: A reference to the Domain object of this label, if there is one.
• bare: If this label is for a domain, this is a boolean representing whether this label is used for messages addressed to the bare address on this domain.
• parent: A label object. This is the label this label is filed underneath.
• unread: The total unread email count.
• pending: A boolean representing if this label is pending.
• blocked: A boolean representing if this label is blocked.
• notifications: A boolean representing if this label sends notifications.
• aggbox: A boolean representing if this label is shown in the aggbox.
• markNewAsRead: A boolean representing if this label marks new messages as read.
• screening: A boolean representing if this label screens senders.
• screeningContacts: A boolean representing if this label even screens contacts.
• public: A boolean representing if this label is public.
• publicDescription: The public description of this label.