Bookshelf v8.1/8.2: Output Parameter Values for Communications Drivers

During email processing, the Internet SMTP/POP3 Server driver or Internet SMTP/IMAP Server driver passes output parameter values to the Communications Inbound Receiver and Communications Inbound Processor server components. From these server components, these values are passed to the Siebel Email Response workflows in the form of properties for the EventFields property set. Table 7 provides a list of the output parameter values and a description of how you can modify email handling behavior by accessing these values in the EventFields property set.

Table 7. Output Parameters for Communications Drivers
Parameter Name	Description
Attachments	The number of nonsupplemental attachments that are found. The default value is 0.
CcList	The value of the CC: header field. This parameter must be semicolon delimited if it includes multiple recipients.
DsnAction	This parameter uses the RFC1894 protocol. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
DsnContent	This parameter uses the RFC1894 protocol. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
DsnFinalRecipient	This parameter uses the RFC1894 protocol. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
DsnOriginalEnvelopeId	This parameter uses the RFC1894 protocol. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
DsnStatus	This parameter uses the RFC1894 protocol. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
FileCharset%d	The character set of the attachment file.
FileIsInline%d	If an incoming attachment file does not have an associated name, then the attachment file is considered inline. The user interface displays the attachment in the rich edit control and not in the attachment pane.
FileIsSupplemental%d	If the incoming attachment file is a supplemental file that the driver creates, such as the original message.txt file, then this parameter is True. Otherwise this parameter is False.
FileName%d	The name of the attachment file. You can specify this parameter in the MIME type or as synthesized by using the type and subtype of the attachment.
FilePath%d	The physical location of the attachment file on the local hard disk. If the response group that loads the driver does not process email in real time, then this parameter is the location of the file on the Siebel File System.
FileSubtype%d	The MIME subtype of the attachment file.
FileType%d	The MIME type of the attachment file.
HasAttach	This parameter is True if the number of attachments is greater than or equal to 1.
HTMLBody	This parameter is set if the incoming email text is HTML only or is multipart or alternative with HTML.
In-Reply-To	The value of the In-Reply-To: header field. This parameter uses the RFC2822 protocol. For more information, see: http://www.faqs.org/rfcs/rfc2822.html.
IsDeliveryStatusNotification	If the incoming email is a delivery status notification as specified by the RFC1894 protocol, then this parameter is True. Otherwise, this parameter is False. For more information, see: http://www.faqs.org/rfcs/rfc1894.html.
Keywords	The value of the Keywords: header field. This parameter uses the RFC2822 protocol. For more information, see: http://www.faqs.org/rfcs/rfc2822.html.
LocalFileToGlobal%d	This parameter facilitates moving generated local files to the Siebel File System. For more information, see About Moving Generated Local Files to Siebel File System.
LoopbackCandidate	This parameter facilitates moving generated local files to the Siebel File System. For more information, see About Moving Generated Local Files to Siebel File System.
Message-ID	The value of the Message-ID: header field. This value is also used as the DriverTrackingID for the Siebel Communications API. For more information, see: http://www.faqs.org/rfcs/rfc2822.html.
MsgClass	This parameter is obsolete.
OrigMsgFile	If the response group that loads the driver does not process email in real time, then this parameter is the location on file on the Siebel File System. The incoming MIME type is saved in this local file.
Prefix	For a forwarded message, this parameter is Fwd or Fw. For a message that is in reply to another message, this parameter is Re. Otherwise, this parameter is empty.
Priority	This parameter is a number from 1 to 5 with 1 designating the highest priority and 5 designating the lowest priority. The default value is 3. This parameter is extracted from the X-Priority or the X-MSMail-Priority if available.
Received	The date that the email is retrieved from the POP3 or IMAP server.
ReceiverAddress	The email address that is extracted from the From Address communications profile input parameter. For example, the ReceiverAddress for Example Support <support@example.com> is support@example.com.
ReceiverName	The proper name that is extracted from the From Address communications profile input parameter. If there is no proper name, then this parameter is set to the ReceiverAddress parameter. For example, the ReceiverName for Example Support <support@example.com> is Example Support.
References	The value of the References: header field. This parameter uses the RFC2822 protocol. For more information, see: http://www.faqs.org/rfcs/rfc2822.html.
SenderAddress	The email address that is extracted from the From: header field. For example, the SenderAddress for John Smith <John@Smith.net> is john@smith.net.
SenderAddrType	This parameter is always empty. The workflows do not use this parameter.
SenderName	The proper name that is extracted from the From: header field. If there is no proper name, then this parameter is set to the SenderAddress parameter. For example, the SenderName for John Smith <John@Smith.net> is John Smith.
SenderReplyNames	If the Reply-To: header field has a value, then this parameter is that value delimited by semicolons rather than commas. If Reply-To: has no value, then this parameter is the same value as the SenderAddress parameter.
Sent	The date from the Date: header field.
SiebelChannelProfile	Media Manager generates this parameter.
SiebelChannelType	Media Manager generates this parameter.
SiebelChannelTypeString	Media Manager generates this parameter.
SiebelDriverNotifyWhenDone	Media Manager generates this parameter.
SiebelWorkItemID	Media Manager generates this parameter.
Subject	The value of the Subject: header field.
Temp%d	If this parameter is True, then the person who accesses the file must assume ownership of the disk-based file, and in most cases the workflow that processes the incoming message must delete the file after it is stored in the Siebel File System.
text/html charset	The IANA character set of the HTMLBody parameter. This parameter is the value of the charset parameter of the Content-Type: header field.
text/plain charset	The IANA character set of the TextNote parameter. This parameter is the value of the charset parameter of the Content-Type: header field.
TextNote	The text/plain message body text of the incoming message.
ToList	The value of the To: header field. This parameter must be semicolon delimited if it includes multiple recipients.

About Moving Generated Local Files to Siebel File System

This topic describes how to direct Communications Inbound Receiver to move driver-generated local files to the Siebel File System. The processing of driver events can occur on a remote Communications Inbound Processor server only if you set the RealTime input parameter for the response group to False and nonreal-time processing applies.

To enable workflows executing on a remote Communications Inbound Processor server to access driver-generated local files, Communications Inbound Receiver monitors EventFields with the following code:

This code is the key to a tag-value pair with FiletoReplace replaced with the actual Siebel File System file name that is generated when the file is moved to the Siebel File System.

In this example, the local file C:\OriginalMsgFile.txt is moved to the Siebel File System. If this file receives the name ABCDEFG on the Siebel File System, then the EventFields is modified as follows before submitted to the workflow for processing:

Siebel Email Administration Guide		Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.