Goto: Documentation Home | Technical Structure

This bucket returns individual emails and their contents from the email store, which is designed as a high volume storage and retrieval system, optimised towards long term storage of email, such as a CRM system.

This bucket will often be subjected to server side security controls

Bucket Usage

Input Predicates

Field Id	Description
f100	Mailbox to read. This predicate is required

Output Fields

Field	Present	Predicates	Description
110	Yes	No	Subject, from email header
111	Yes	No	Messagetype. A Gds derived value indicating the what type of message this appears to be such as General email, delivery status, SPAM etc. This field contents a coded number
112	Yes	No	Description of f111 in human readable form
113	Yes/No	No	Message-Id, from email header
114	No	No	Size. Indicator of number of bytes of storage required for this email. May not be exact, but will be close, differences are due to various storage and encyyption schemes that may be in use.
115	No	No	From, from email header
116	No	No	To, from email header. This field contains one address only, but will be repeated for each address listed.
117	No	No	CC, from email header. This field contains one address and is repeated for each address listed
118	No	No	Bcc. Reserved for BCC field, not yet implemented
119	No	No	Reply-To, from email header. This field contains one address only, but will be repeated for each address listed.
120	No	No	Bounce address, where available. For message delivery failures, this field holds the email address that was attempted to be sent too. Out-of-office style replies do not typically set this field.
121	No	No	Bounce Action
122	No	No	Bounce Supplementary Information
130	No	No	Importance, from email header
131	No	No	Sensitivity, from email header
132	No	No	Date, from email header. This date is from the email, it can be set by email clients to any value and may not be the date the email was actually received and processed.
	No	No
	No	No
Derived/Calculated Information
f1000	No	No	Language. The apparent language of the main message contents (not quoted text or replied-to)
f1001	No	No	Profanity level indicator. Ranges from 1 (low/none) to 100 (extreme). 0 indicates not rated
f1002	No	No	Derived Contents. Type of message we believe this to be
f1003	No	No	Derived Contents data. See f1002 for details.
f1004	No	No	Derived Contents data. See f1002 for details.
f1005	No	No	Derived Contents confidence level. How certain we are about f1002. Values range from 1(low) to 100(high), with zero indicating unknown.

Dervied Contents

Each email can be sent through the GDS NLQ subsystem to attempt to decode its contents. The outcome of this is an expected type, as in what we believe this message appears to contain.

Code	Description
1	Message delivery failure
2	No contents reply. Caused if a user presses "reply" and "send" without entering information.
10	Minor positive user confirmation. Caused by responses such as "Thanks", "ok"
11	Minor negative user confirmation. Caused by responses such as "no Thanks", "exit", "unsubscribe". See also code 12, negative response
12	Negative user confirmation. Caused by anything that appears to be negative and stronger than minor classisification. This might be due to longer text passages being present (eg. "No thanks, I've already told you this too", or "#@%$# off")
20	Out of office style automated reply. Will load f1003 with the number of days out of office from now, 0 if cannot be determined. Will also load f1004 with the actual return date. f1003 (days) is relative to now, so will change and can be negative if message is recalled later
21	Gone forever automated reply. Appears to be a permanent "I have left my job" style response
22	Other automated reply that is not handled
30	Un-Solicited, probable SPAM. Caused when a random message arrives with text that appears to be non-useful, (eg Human body part enlargement)
31	Un-Solicited general message from a known contact. This might be caused if a user randomly sends us an email about something.

Example