Configure message fields

Message fields are metadata related to a document such as message subject. You can map these values to Tungsten Capture batch/folder/document fields.

If a message field is mapped to a Tungsten Capture field, it is automatically populated with the proper value during import to Tungsten Capture.

You can configure the message field mappings in Capture Plug-In for each destination. See Manage destinations.

Message field	Description	Applicable to
KfxMessageAttachmentList	Includes the file names of the converted documents or attachments. For Folder import, this returns the file names of all the converted documents in the folder delimited by ';'. For email import, this returns the file names of the converted attachments of a message delimited by ';'. When file types are specified in the Allow importing files with formats or Skip importing files fields, the names of all the imported file types are listed in the KfxMessageAttachmentList message field.	Email, Folder
KfxMessageCorrelation	Includes the correlation information of the message (for internal use).	Email, Folder, Fax
KfxMessageDeliveryPriority	Includes the priority of the message. Reserved for future use. Currently static value 1.	Email, Folder, Fax
KfxMessageDeliverySuspectedDupli	Reserved for future use. Currently static value 0.	Email, Folder, Fax
KfxMessageDeliveryType	Includes the message delivery type. Reserved for future use. Currently static string TO.	Email, Folder, Fax
KfxMessageFileName	Includes the file name of the document. For fax server import, this returns the server's internal file name of the fax message. This does not return anything for EMAIL and Folder import.	Fax
KfxMessageID	Includes the unique ID of the message provided by the Message Connector on message arrival.	Email, Folder, Fax
KfxMessageOwnerReference	For email documents: mime-header/message-id For faxes: server-specific message ID For file: mime-header or message ID of EML or MSG files.	Email, Folder, Fax
KfxMessagePages	Includes the number of fax pages in the message.	Fax
KfxMessageReceptionCallerId	Includes the number of the sending fax machine.	Fax
KfxMessageReceptionErrorImporting	Includes the error if Tungsten Import Connector rejects the message.	Fax
KfxMessageReceptionErrorInfo	Includes an additional description if KfxMessageReceptionErrorLevel is non-zero. For messages from Tungsten Communication Server, this field contains the Tungsten Communication Server error code.	Fax
KfxMessageReceptionErrorLevel	Includes the error level of the received document using the following values: 0 = OK, 1 = partially OK or incomplete, 2 = failed	Fax
KfxMessageReceptionTimeCreated	For emails, this is the time when the Message Connector retrieved the message. For faxes, this is the time when the message was received by the fax server. For folder, the time when message was retrieved by the Message Connector.	Email, Folder, Fax
KfxMessageRemovedAttachmentList	Includes the list of all the filenames which are skipped from import. The filenames are delimited using a semicolon. You can use this field in the subject field or body of a notification email. When file types are specified in the Allow importing files with formats or Skip importing files fields, the names of all non-imported file types are listed in the KfxMessageRemovedAttachmentList message field.	Email, Folder
KfxMessageSubject	Includes the subject of the message. For faxes, this is "Fax from" + TSI. For files, this is the subject of an EML or MSG file.	Email, Folder, Fax
KfxMessageTimePosted	Includes the date and time when the message was sent. Only available for email messages.	Email
KfxOriginalRecipients	Includes a list of the original recipients as specified by the message originator. For Tungsten Communication Server, this field contains the original number before forwarding by event. For mailbox emails, this field contains the To/Cc recipients.	Email, Folder, Fax
KfxOriginatorName	Includes the full name of the message originator. For faxes, this is the TSI. For SMTP/POP3/EWS, it’s the originator display name (mime-header/from/mailbox/displayname). For folder For EML and MSG files, originator display name. For other file types, if trigger file is used, name of trigger file with full path. If trigger file is not used, this will remain blank.	Email, Folder, Fax
KfxOriginatorNumber	Includes the fax number of the originator (caller ID) or originator email (mime-header/from/mailbox/address) for POP3/SMTP/EWS mail.	Email, Folder, Fax
KfxOriginatorService	Includes the service name of the originator. FAX for fax EMAIL for email FOLDER for file	Email, Folder, Fax
KfxRecipientName	Includes the full name of the message recipient. For POP3, this is the mailbox display name For folder, this is the watch folder name configured in Tungsten Import Connector including the file name. If a trigger file is used, the file name is the trigger file name. When the trigger file option is not used, this field displays the imported file name.	Email, Folder, Fax
KfxRecipientNumber	Includes the recipient's fax number (called party number) or email address. For SMTP, the first active email recipient. For POP3 the mailbox user name. For folder, this is the watch folder name configured in Tungsten Import Connector including the file name. If the trigger file is also imported, file name is the trigger file name. If the trigger file is not imported, this may remain blank. When the trigger file option is not used, this field displays the imported file name.	Email, Folder, Fax
KfxRecipientsTo	Includes the comma-separated list of To recipients.	Email, Folder
KfxRecipientsCc	Includes the comma-separated list of Cc recipients.	Email, Folder
KfxRecipientsBcc	Includes the comma-separated list of Bcc recipients. For information about Bcc field mapping, see Bcc field mapping.	Email, Folder
KfxRecipientService	Includes the service name of the recipient. FAX for fax, EMAIL for email and FOLDER for Folder.	Email, Folder, Fax
KfxRoutingNumber	The meaning of this message field is different for various inputs FAX: Extension (called-party-number) SMTP: Active email recipient POP3/IMAP/EWS/MS Graph: Mailbox username FOLDER: Full path of the imported file WEBSERVICE: Empty string	Email, Folder, Fax
KfxMessageReceptionTimeReceived	Includes the reception time of the fax. Biscom/Right Fax: The start time of fax reception. Tungsten Communication Server: The time when the fax server finished receiving the message.	Fax
KfxImportFolderName	Includes the folder name of the subfolder from which messages are polled. For example, if the polling folder is "Inbox" and sub folder is "sub1", then the field will contain "Inbox/sub1".	Email
KfxInputSourceName	Includes the the display name of the passive input: For email: POP3, IMAP, SMTP, EWS, or MS Graph. For fax: BISCOM, RightFax, or Tungsten Communication Server. For file import: Folder	Email, Folder, Fax
KfxRecipientCorrel2	Includes the optional ID that may be used to open the message from its source (e.g. mail server). It starts with a source system specific prefix (e.g. "MsGraph." is used for Microsoft Graph).	MS Graph

The message extension fields are reserved for future versions.

Document metadata is also available in Tungsten Capture as custom storage strings (for documents and folders) with the prefix ED_CSS_. Custom storage strings can be read via the Tungsten Capture API and could be used for example in an export connector or in custom scripts. Refer to the Tungsten Import Connector Developers Guide for more information about custom storage strings.

Overview of message IDs'

Following are the common message ID's used in MS Graph.

ViewMessageResponse	MessageInStore	Description
MessageEntry/General/MessageID	Header/common/uuid	Unique message content ID provided by the message server. If a message has multiple recipients, the ID is shared with all the recipients. MC specific: GUID of the message is storage.
MessageEntry/General/OwnerReference	Header/general/OwnerReference	The correlation information provided by the message owner. It is usually defined by the email sender.
MessageEntry/General/ Extensions/TransferID	"MC-"+Header/common/uuid	Unique ID of the transferred message used to identify any duplicates received.
MessageEntry/General/ Extensions/TransferSourceID	Header/general/TransferSourceID	Optional, external unique ID used to prevent duplicate imports. The ID must start with a source system specific prefix. For example: "Rfx." is used for RightFax.
MessageEntry/Originator/Correlation1	header/general/InputDisplayName	Supported by MC since KIC 2.6.0.1. MC will store the passive input display name in this field. For active inputs this field is empty.
MessageEntry/Originator/Correlation2	Header/general/ExternalSourceID	Supported by MC since TIC 2025.1.2. Optional ID that may be used to open the message from its source (e.g. mail server). The ID must start with a source system specific prefix. For example: "MsGraph." is used for Microsoft Graph.

The following ID's are used in a typical email scenario in MS Graph:

The OwnerReference ID is defined by the email sender. It is transferred with the mime header.
The SourceID ID is defined by the email server that receives the message. It identifies the message in the mailbox. It can be used to open/change/delete the message in the MS Graph mailbox.
The MessageID is the ID of a message in Message Connector. It can be used to open/change/delete the message in Message Connector.