Dovetail Email Agent Configuration Parameters Reference

Parameter Name	Required	Default	Description

Pop Parameters
pop3Host	Yes	(blank)	IP or hostname of the POP3 server
pop3User	Yes	(blank)	POP3 mailbox user name
pop3Pass	Yes	(blank)	POP3 mailbox user password
pop3PollInterval	No	30	The number of seconds to wait between attempts to retrieve mail from the POP3 mailbox.
pop3FailureRetryTime	No	600	If there is a problem connecting to the POP3 server, this value controls how long in seconds Dovetail Email Agent will wait before trying again.
pop3FailureRetryCount	No	6	If there is a problem connecting to the POP3 server, this value controls how many consecutive times Dovetail Email Agent will attempt to re-connect before giving up and shutting down. NOTE: if a valid connection is established, the counter is reset.
pop3Port	No	110	The TCP/IP port to use when connecting to the POP3 server.
pop3ReceiveBufferSize	No	8192	The size of the receive buffer in bytes for the underlying client socket. Default is 8192 bytes.
pop3SendBufferSize	No	128	The size of send buffer in bytes for the underlying client socket. Default is 128 bytes.
pop3ReceiveTimeout	No	60000	The amount of time the underlying TcpClient socket will wait to receive data once initiated. Default is 60,000 milliseconds (1 minute).
pop3SendTimeout	No	10000	The amount of time the underlying Client socket will wait to receive confirmation after you initiate a send. Default is 10,000 milliseconds (10 seconds).
pop3AuthType	No	UserPass	Specifies the type of POP3 authentication Dovetail Email Agent should use when logging into the POP3 server. Valid values are: APOP, CRAM_MD5, Digest_MD5, GSSAPI, Login, None, NTLM, UserPass, UseStrongest
pop3SecurityType	No	None	Specifies the type of transport security Dovetail Email Agent should use when connecting to the POP3 server. Valid values are: None, SslSocket, TransportLayer
SMTP Parameters
smtpHost	Yes	(blank)	IP or hostname of the SMTP server
fromAddress	Yes	(blank)	The email address that Dovetail Email Agent should use in the FROM: field when sending out emails This can be in the format: Display Name <email@address.com> or simply: email@address.com Take care to escape any < and > characters with the XML escape sequences < and > respectively
smtpPort	No	25	The TCP/IP port to use when connecting to the SMTP server.
smtpReceiveBufferSize	No	128	The size of the receive buffer in bytes for the internal communication socket. Default is 128 bytes.
smtpSendBufferSize	No	4096	The size of send buffer in bytes for the internal communication socket. Default is 4096 bytes.
smtpReceiveTimeout	No	60000	The amount of time the underlying TcpClient socket will wait to receive data once initiated. Default is 60,000 milliseconds (1 minute).
smtpSendTimeout	No	10000	The amount of time the underlying Client socket will wait to receive confirmation after you initiate a send. Default is 10,000 milliseconds (10 seconds).
smtpUser	No	(blank)	The username to use when connecting to the SMTP server. Some SMTP Servers require authentication.
smtpPass	No	(blank)	The password to use when connecting to the SMTP server. Some SMTP Servers require authentication.
smtpAuthType	No	None	Specifies the type of SMTP authentication Dovetail Email Agent should use when connecting to the SMTP server. Valid values are: CRAM_MD5, Digest_MD5, GSSAPI, Login, None, NTLM, UseStrongest
smtpSecurityType	No	None	Specifies the type of transport security Dovetail Email Agent should use when connecting to the SMTP server. Valid values are: None, SslSocket, TransportLayer
Application Parameters
parseMode	Yes	(blank)	Parsing mode: apiinvoke, freeform, or eeoredirect (NOTE: 'eeoredirect' mode requires a separate license)
attachPath	Yes	(blank)	Local or UNC path in which to store email attachments.
failNotifyEmail	No	(same as service admin email address)	The address which will receive failure notifications (blank for none)
successNotifyEmail	No	blank for none	The address which will receive success notifications (blank for none)
useHtmlEmailFormat	No	true	Controls which type of emails Dovetail Email Agent sends out to users. Valid values are "false" for plaintext, non-formatted emails or "true" for HTML formatted emails. NOTE: If you're switching from HTML to plaintext, you must reformat your XSLT templates accordingly, otherwise users will see the raw HTML tags. Going from plaintext to HTML will not be a problem as the users will be sent the plaintext as normal.
attachFolderMode	No	ModeA	Specifies which sub-folder mode Dovetail Email Agent should use when saving attachments. NOTE: The value is NOT case-sensitive (i.e. 'modea' works as well as 'MODEA'). Valid values are: ModeA: Put all files directly into the path specified by attachPath. ModeB: Put attachments in subfolders using the CASE ID as a folder prefix. For example, if the attachPath is set to "c:\attachments", attachments from Case 1792 will be stored in the path: C:\attachments\001xxx\001792\ This mode groups up to a 1,000 cases in a grouping folder to help organize the attachments. ModeC: Similar to ModeB but the folder names are slightly different. For example, if the attachPath is set to "c:\attachments", attachments from Case 1792 will be stored in the path: C:\attachments\1700\1792\ This mode groups up to 100 cases in a group folder to help organize the attachments.
defaultLocale	No	en-US	This controls what template will be used to send emails to users when their locale is unknown (can't be found in Clarify or discovered from their email). NOTE: Dovetail Email Agent does not currently check contacts or emails for locale information, it only uses the defaultLocale. Future versions may support multiple locales, in which case this setting takes on new meaning.
helpEnabled	No	true	Specifies whether the Dovetail Email Agent help system is enabled for API invoke mode. If someone requests help or submits an invalid request, should help messages be sent in reply.
createContact	No	true	Should Dovetail Email Agent create a contact in the Clarify system if one cannot be found with the given email address from a freeform email. If set to true, a new contact will be created whose first name, last name, phone number, and email address will all be set to the from address of the incoming email. The contact role will be set to the default, and it will be related to the site whose site_id is defined in the newContactDefaultSite parameter.
newContactDefaultSite	Required if createContact=true	INT1	If createContact is enabled, this tells Dovetail Email Agent the site id to relate the new contact to.
allowInactiveContact	No	false	(Only applies to freeform mode) Determines whether Dovetail Email Agent will allow emails from an inactive contact to be processed. If false, the user gets a generic error email and an email is sent to the failure notification address. If true, the contact is treated like normal.
reopenCaseToLogEmailIn	No	false	(Only applies to freeform mode) Determines whether Dovetail Email Agent will re-open a closed case (or subcase) before logging notes to it. If false, notes are logged to the closed case.
sendSuccessReply	No	true	Should Dovetail Email Agent send an affirmative reply to a user after it completes the requested action. Occurs in both in freeform and in API invoke modes. NOTE: This value trumps the `sendLogEmailInInSuccessReply` parameter.
sendLogEmailInSuccessReply	No	true	Should Dovetail Email Agent send an affirmative reply to a user after it successfully logs notes to a case/subcase from an incoming email. This value applies only to freeform mode. NOTE: `sendSuccessReply` trumps this value. If `sendSuccessReply` is false, then this value is ignored.
sendFailureReply	No	true	Should Dovetail Email Agent send a failure reply after it encounters an error performing the requested action. Occurs in both in freeform and in API invoke modes.
sendParseErrorReply	No	true	Should Dovetail Email Agent send an error reply to a user after it encounters an error parsing an email request. Occurs in both in freeform and in API invoke modes.
numberDashesInCaseId	No	0	If the case ID number scheme contains dashes, this tells Dovetail Email Agent how many dashes it contains so it can process subcases correctly. More information on this topic is available in the Special Case ID Numbering Schemes section.
freeFormNoteFormat	Required if parsemode=freeform	About\s+case\s+	The message format Dovetail Email Agent will look for when in freeform parse mode. It will look for "About case xxxx " where "About case " is your freeFormNoteFormat and xxxx is the case ID. The format of this string can contain .NET Regular Expression tokens. For more information, see the .NET Framework SDK documentation on Regular Expressions
freeFormNoteFormatLocation	No	subject	Determines where Dovetail Email Agent will look for the freeFormNoteFormat when in freeform parse mode. Valid values are subject, body, or both.
freeFormReplySubjectSuffix	Required if parsemode=freeform	- About case	When in freeform mode, and replying to a freeform note that has caused a case to be created, Dovetail Email Agent will append this text to the original subject. This is useful when the user replies to an email as it will preserve the workflow of case notes. This text will be appended immediately after the subject and followed by a space and then the actual case ID.
freeFormTextAfterID	No	true	This tells Dovetail Email Agent whether or not there will be additional text after the case ID. If you have spaces in your ID number scheme, this MUST be set to false. Additional text is NOT allowed after the CASE ID if your case number format has spaces. More information on this topic is available in the Special Case ID Numbering Schemes section.
removeOriginalMessage	No	true	When processing free-form emails, sometimes the emails are replies or forwards and contain the original message that's being forwarded or replied-to. This controls whether or not Dovetail Email Agent will remove the original message, or leave it. Dovetail Email Agent will used the delimiters defined in the delimeters.dat file to determine the start of the original message.
useEmailTimeForCaseCreate	No	false	This controls what time Dovetail Email Agent should specify for the case creation time when processing freeform emails. By default, it uses the current date and time on the database server, but it can, instead, use the time the user sent their email.
extraNoteInfo	No	true	This tells Dovetail Email Agent whether or not to prepend "extra note info" when logging case notes to a case in freeform mode. "Extra note info" consists of a typical email-type header with the FROM:, the TO:, the subject, the time the email was sent, etc
sessionLocalTimezone	No	(blank)	The full name of the TimeZone you wish the Dovetail Email Agent ClarifySession to run as. It is important to set this value when Dovetail Email Agent and the Clarify Database are located in different timezones. The default value will be the LocalCache's DefaultTimeZone.
freeFormContactValidatorType	No	(blank)	Specifies the fully-qualified .NET name of a type that will perform custom contact validation. See the Custom Contact Validation topic for more details.
allowFreeformCaseCreate	Yes	true	(Only applies to freeform mode) Should Dovetail Email Agent allow case creation. If this value is set to "false", and an incoming email attempts to create a new case, then the sender will receive a reply using the FreeformWontCreateCase.xslt template.
allowFreeformLogEmailIn	Yes	true	(Only applies to freeform mode) Should Dovetail Email Agent allow notes to be logged to a case/subcase. If this value is set to "false", and an incoming email attempts to log notes to an existing case or subcase, then the sender will receive a reply using the FreeformWontLogNote.xslt template.
allowLogEmailInToClosedCases	Yes	true	(Only applies to freeform mode) Should Dovetail Email Agent allow notes to be logged to a closed case. If this value is set to "false", and an incoming email attempts to log notes to a closed case, then the sender will receive a reply using the FreeformClosedCaseNotesFailure.xslt template.
allowLogEmailInToClosedSubcases	Yes	true	(Only applies to freeform mode) Should Dovetail Email Agent allow notes to be logged to a closed subcase. If this value is set to "false", and an incoming email attempts to log notes to a closed subcase, then the sender will receive a reply using the FreeformClosedCaseNotesFailure.xslt template.
processDSNMessages	Yes	false	Should Dovetail Email Agent process DSN (Delivery Status Notification) messages. Examples of DSN Messages: The recipient address is misspelled or doesn't exist Full disk or full mailbox Rejection of the message due to spam filtering, etc. Delay in delivering the message etc. If this value is set to "false", and an incoming DSN email is received, then the email will be forwarded to the Dovetail Email Agent admin. If this value is set to "true", and an incoming DSN email is received, then the email will be processed as a normal email.
sendReplyToDSNMessages	Yes	false	Should Dovetail Email Agent send a reply to DSN (Delivery Status Notification) messages. It is recommended that this value be left to "false" to prevent an infinite email loop.
Application Settings
enableEmailTracking	No	false	This tells Dovetail Email Agent to save all incoming and outgoing emails to files in a specified folder (see the emailTrackingPath param). This should only be enabled for debugging purposes or for high-security/auditing situations. More information on this topic is available in the Email Tracking section.
saveWholeEmailAsDovetailAttachment.Enabled	No	false	When in freeform mode this tells Dovetail Email Agent to attach the entire email as an attachment to the case or subcase being processed. This feature is useful for preserving the original email with its formatting, images, and embedded attachments.
saveWholeEmailAsDovetailAttachment.FileExtension	No	mht	When saveWholeEmailAsDovetailAttachment is enabled this setting controls the file extension used when saving the email as an attachment to case or subcase being processed. The default mht (mime html) extension can be viewed using Internet Explorer. An alternative is eml which can be viewed using Outlook Express.
saveWholeEmailAsDovetailAttachment.HistoryAppenderTemplate	No		When this setting is empty it has no effect. When saveWholeEmailAsDovetailAttachment is enabled. This value when populated will be appended to the case or subcase history. The template can contain tokens: {caseId} {attachmentFileName} {attachmentDirectory} {attachmentSubDirectory} An example would be if you wished to append a hyperlink pointing to an attachment service: http://server/attachments/{attachmentSubDirectory}\{attachmentFileName} This example will resolve to: http://server/attachments/00\59\IncomingEmail-20080619-143737990.mht
emailTrackingPath	No	EmailTracking	This tells Dovetail Email Agent where to save all incoming and outgoing emails when enableEmailTracking is set to True (see enableEmailTracking). This must be a full path (no relative paths) or a path that is relative from the Dovetail Email Agent working dir (see the EmailAgentService.exe.config file). Proper permissions must be set for the Dovetail Email Agent service user ('NETWORK SERVICE' by default on Windows XP and 2003 Server) to write to this folder. More information on this topic is available in the Email Tracking section.
secServiceUniqueIdentifer	Yes	Dovetail-SEC-Service-Instance-001	A unique identifier for the SEC Instance. This value is added to email headers to assist in detecting email loops that can occur when two instances of Dovetail Email Agent send email to each other.

Dovetail Email Agent Configuration Parameters Reference

See Also

Next