v1

latestOpenAPI 3.0.12026-07-2631331.4 KB
Email

Parse an email for contacts from the signatures or remove signatures from an email. Can handle parsing contacts from a reply chain. Can also indicate if this email is likely a spam (non-human) type contact.

post/api/Email

Request body

subjectstring nullable

Email subject. Not required but should be provided in order to have the "subject" field populated in the response for the "emails" collection.

from_addressstring required

The sender of the email. Required for us to match the contact data we find in the root email's signature with an email address.

from_namestring nullable

The sender of the email. Important to provide as it helps to identify where the signature starts although sometimes we can find the signature without it.

htmlbodystring nullable

Either provide this or the PlainBody or both. This will be used for the email content over the plain body as the HTML is how we can get LinkedIn URLs and Twitter URLs for example.

plainbodystring nullable

If there isn't an HTML body we'll fallback to this value. If all you can provide is a text body then we can still find phone numbers, titles and addresses but features like LinkedIn URLs and Twitter URLs embedded in HTML won't be discoverable.

datestring nullable

A Date string. For example: 2017-01-01T00:00:00 OR Mon, 28 May 2018 23:33:40 +0000 (UTC) If either of the two above formats don't match what you're providing, we fallback to using the standard .NET parsing to parse this date so you can test that your date works with DotNetFiddle. https://dotnetfiddle.net/sJyTJW

Response

Returns JSON for the contact data.

errorstring nullable
isSpammyLookingEmailMessageboolean

Does this message looks like it was likely some sort of automated email. For example, does it have an "unsubscribe" link in it?

isSpammyLookingSenderboolean

Does the "From" email address look like it is a non-human type sender.

isSpamboolean

Are either IsSpammyLookingSender or IsSpammyLookingEmailMessage true.

from_LastNamestring nullable

Last name of the sender.

from_FirstNamestring nullable

First name of the sender.

from_Faxstring nullable
from_Phonestring nullable
from_Addressstring nullable

Whatever address SigParser found for the contact.

from_Titlestring nullable
from_MobilePhonestring nullable
from_OfficePhonestring nullable
from_LinkedInUrlstring nullable
from_TwitterUrlstring nullable
from_TwitterHandlestring nullable
from_EmailAddressstring nullable
from_EmailAddressDomainstring nullable

The domain part of the email address. For example, for the email address "john@example.com" then this would be set to "example.com".

from_EmailAddressDomainWithoutTLDstring nullable

The email address domain without the TLD. Sometimes this is okay to use as the name of an organization or account in a CRM. If the emailAddress is "john@example.co.uk" then this will be "example". If the emailAddress is "john@mail.example.com" then this will be "mail.example".

from_LinkedInHandlestring nullable
from_CompanyNamestring nullable

Company name found in either the signature or looked up from a database of companies based on the domain name. Most of the time we get this from the signature.

from_Websitestring nullable

The website from the email signature's text. This does not include the URLs in the HTML links because those are often link tracked and so they don't point to the correct domain. The values in this field often formatted with captialization but there is no formatting guarantee. For example, you could get "https://www.example.com" or "Example.com" or "WWW.EXAMPLE.COM" are all possible.

durationnumber double

Duration of email processing in milliseconds.

cleanedemailbodystring nullable

The body text of the root email without the email signature or any of the email chains that might have been in the original email body. Useful for cleaning up an email for display in application UIs.

cleanedemailbody_ishtmlboolean

Is the cleanedemailbody HTML or Text only.

cleanedemailbody_plainstring nullable

The email body as plain text. Will always be populated. If the original HTML was email then this is that email converted to plain text with all HTML removed.

emailTypesstring[] nullable

We can add new types of emails at any time. So be prepared to handle that. NormalEmail - A normal email. MeetingNotification - A meeting invite type email. Generally auto generatee by Google. We don't parse these. BouncedNotification - Response from an email server indicating the email was bounced. ZenDeskSupportChain - Discovered a ZenDesk support email chain. SigParser can't parse these because their headers aren't well formed.