Email Feed API Parameters

type

The feed type.

Required.

The following values are allowed: EMAIL - 11

name

The name of the feed.

Required.

description

The description of the email feed.

Optional.

email

Configuration information specific to email.

Required.

This parameter is specific to email feeds.

receive

Configuration information specific to receiving email.

Required.

This parameter is specific to email feeds.

-->host

The hostname or IP address of the IMAP server.

Required.

This parameter is specific to email feeds.

-->port

The port of the IMAP server.

Required.

The default value is 993.

This parameter is specific to email feeds.

-->folderName

The name of the folder from which to fetch the email.

Required.

The default value is Inbox.

This folder cannot be a shared or public folder.

This parameter is specific to email feeds.

In an Exchange mailbox, you can configure multiple folders. You can also configure folders within folders. For example, your email folders may be set up like the following:

Inbox
Important Mail
     Sales
     Service
Spam

In this example, if you want to configure an email feed to fetch mail from the Sales folder, you must include both the Important Mail folder and the Sales folder in the folderName parameter.

<folderName>Important Mail/Sales</folderName>

If the Sales folder includes two folders (Product A and Product B) and you want to configure an email feed to fetch mail from the Product A folder, set the folderName parameter as follows:

<folderName>Important Mail/Sales/Product A</folderName>

-->snapshotAge

The length of time (in minutes) that the email feed goes back to retrieve the initial set of email contacts.

Required.

The default value is 120 minutes (2 hours). That is, by default, an email feed goes back 2 hours on the initial fetch.

This parameter is specific to email feeds.

send

Configuration information specific to sending email.

Required.

This parameter is specific to email feeds.

-->host

The hostname or IP address of the SMTP server.

Required.

This parameter is specific to email feeds.

-->port

The port of the SMTP server.

Required.

The default value is 587.

This parameter is specific to email feeds.

username

The email address used to connect to the email host.

Required.

This parameter is specific to email feeds.

password

The password used to connect to the email host.

Required.

This parameter is specific to email feeds.

pollingInterval

The amount of time (in seconds) that the system waits between attempts to fetch email.

Required.

replyTemplateUrl

The URL of the reply template used to respond to email contacts obtained from this feed.

Optional.

tags

Contacts coming in from this feed are automatically tagged with these default tags.

A maximum of 10 tags are allowed.