Difference between revisions of "External Email Tracking"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
Line 3: Line 3:
==About this Feature==
==About this Feature==
You can use this feature in one of two ways:
You can use this feature in one of two ways:
# Update Prospect or Contact records with activity information via email with '''External Email Tracking'''
# Update Prospect or Contact records with activity information via email
# Set up a '''Custom Listener Interface''' to process incoming emails in any manner you like.
# Set up a '''Custom Listener Interface''' to process incoming emails in any manner you like.


==Using External Email Tracking for Activity Updates==
===Tracking Activity Updates===


Use the standard '''External Email Tracking''' feature to automatically update Prospect or Contact records with activity information by sending messages from an email client (see [[#Compatible Email Clients|Compatible Email Clients]] below).  
Use the standard '''External Email Tracking''' feature to automatically update Prospect or Contact records with activity information by sending messages from an email client (see [[#Compatible Email Clients|Compatible Email Clients]] below).  
Line 14: Line 14:


:* Or Forward an email message to a unique "Email-To-{platform}" address, and the platform will search the body of the message and create a Completed Activity for the Prospect or Contact that matches the email address in the FROM: field.
:* Or Forward an email message to a unique "Email-To-{platform}" address, and the platform will search the body of the message and create a Completed Activity for the Prospect or Contact that matches the email address in the FROM: field.
===Setting up a Custom Listener===
A Java [[Class]] that implements the [{{DOCHOST}}/javadocs/com/platform/api/mail/EmailHandler.html <tt>EmailHandler</tt> interface] can be used to process emails programmatically, doing anything the platform is capable of. Such messages can contain attachments, and directives can be passed in the subject line or body of the message. 
''Learn more:''
:* [[Java_API_Cheatsheet#Email_Handler_APIs|Email Handler APIs]]
:* [[HowTo:Handle Incoming Emails Programmatically|Handle Incoming Emails Programmatically]]


==Administration Setup==
==Administration Setup==
Line 19: Line 26:
#Click '''Settings > Administration > External Email Tracking'''
#Click '''Settings > Administration > External Email Tracking'''
#In the Enable External Email Tracking section, click the '''Enable Email-to-{platform}''' checkbox
#In the Enable External Email Tracking section, click the '''Enable Email-to-{platform}''' checkbox
# For activity updates, select the default action to take when a matching Prospect/Contact is not found. Choose from:
# For activity updates, select the default action to take when a matching Prospect/Contact is not found:
#:*create an open task
#:* Create an open task
#:*create a task and mark it completed
#:* Create a task and mark it completed
#:'''-or-'''
#:'''-or-'''
# Select a Custom Listener created by your programmers for fully customized email handling.  
# Select a Custom Listener created by your programmers for fully customized email handling.  
#: ((Only those classes that implement the required interface are listed.)
#Click '''[Save]'''
#Click '''[Save]'''
===Custom Listener Interface===
In the '''Custom Listener Interface''' section, select a Java [[Class]] that implements the [{{DOCHOST}}/javadocs/com/platform/api/mail/EmailHandler.html <tt>EmailHandler</tt> interface]. (Only those classes that do are listed.)
''Learn more:''
:* [[Java_API_Cheatsheet#Email_Handler_APIs|Email Handler APIs]]
:* [[HowTo:Handle Incoming Emails Programmatically|Handle Incoming Emails Programmatically]]


==User Setup==
==User Setup==

Revision as of 03:13, 12 January 2012

Settings > Administration > External Email Tracking

About this Feature

You can use this feature in one of two ways:

  1. Update Prospect or Contact records with activity information via email
  2. Set up a Custom Listener Interface to process incoming emails in any manner you like.

Tracking Activity Updates

Use the standard External Email Tracking feature to automatically update Prospect or Contact records with activity information by sending messages from an email client (see Compatible Email Clients below).

To use the feature:

  • Use a unique "Email-To-{platform}" address in the BCC: field of an email message, and the platform will log that email message as a Completed Activity for any Prospect or Contact in your database that matches the TO: or CC: field.
  • Or Forward an email message to a unique "Email-To-{platform}" address, and the platform will search the body of the message and create a Completed Activity for the Prospect or Contact that matches the email address in the FROM: field.

Setting up a Custom Listener

A Java Class that implements the EmailHandler interface can be used to process emails programmatically, doing anything the platform is capable of. Such messages can contain attachments, and directives can be passed in the subject line or body of the message.

Learn more:

Administration Setup

  1. Click Settings > Administration > External Email Tracking
  2. In the Enable External Email Tracking section, click the Enable Email-to-{platform} checkbox
  3. For activity updates, select the default action to take when a matching Prospect/Contact is not found:
    • Create an open task
    • Create a task and mark it completed
    -or-
  4. Select a Custom Listener created by your programmers for fully customized email handling.
    ((Only those classes that implement the required interface are listed.)
  5. Click [Save]

User Setup

When External Email Tracking is enabled, the My Email-to-{domain} option appears in the Personal Setup list. Users then need to enable their personal My Email-to-{domain} addresses. Send them the following information to tell them how:

Complete this one-time setup to begin sending emails:

  1. Click Settings > Personal Setup > My Email-to-
  2. The "Email-To-{platform} Details" section gives you the address you will use to send messages; Copy it for future use.
  3. Specify the addresses that you will be sending from, separated by commas. (To ensure that only emails you send are processed, any messages coming from other addresses are ignored.) For example, <youraccountname>@gmail.com, <youraccountname>@yahoo.com, etc.

Compatible Email Clients

External Email Tracking is compatible with these email clients:

  • Web-based: Gmail, Yahoo, HotMail, etc.
  • Microsoft Outlook 2003 (11.6568.6568) and later