Siebel Email Response Administration Guide > Siebel Email Response Reference Information > How the Internet SMTP/POP3 Server Driver Processes Email Messages >

Output Parameter Values for Internet SMTP/POP3 Server Driver


During email processing, the Internet SMTP/POP3 Server driver passes output parameter values to the Communications Inbound Receiver and Communications Inbound Processor server components. From the Communications Inbound Receiver and Communications Inbound Processor server components, these values are passed to the Siebel Email Response workflows in the form properties of the EventFields property set. Table 17 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 17. Output Parameters for the Internet SMTP/POP3 Server Driver
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.

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 file %d (where %d is 0-based).

FileIsInline%d

If an incoming attachment does not have an associated name, the attachment is considered inline. The user interface displays the attachment in the rich edit control and not in the attachment pane (where %d is 0-based).

FileIsSupplemental%d

If the incoming attachment is a supplemental file that the driver creates, such as the original message.txt file, 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 based on the type and subtype of the attachment.

FilePath%d

The physical location of the file on the local hard disk. If the response group that loads the driver does not process email in real time, this parameter is the location of the file on the Siebel File System.

FileSubtype%d

The MIME subtype of the attachment.

FileType%d

The MIME type of the attachment.

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, 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

For a description of this parameter, see About Moving Generated Local Files to the Siebel File System.

Loopback Candidate

For a description of this parameter, see About Moving Generated Local Files to the Siebel File System.

Message-ID

The value of the Message-ID: header field. This value is also used as the SCAPI DriverTrackingID. 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, 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 server.

ReceiverAddress

The email address that is extracted from the From Address communications profile input parameter. For example, the ReceiverAddress for John Smith <John@Smith.net> is john@smith.net.

ReceiverName

The proper name that is extracted from the From Address communications profile input parameter. If there is no proper name, this parameter is set to the ReceiverAddress parameter. For example, the ReceiverName for John Smith <John@Smith.net> is john@smith.net.

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, this parameter is set to the SenderAddress parameter. For example, the SenderName for John Smith <John@Smith.net> is john@smith.net.

SenderReplyNames

If the Reply-To: header field has a value, this parameter is that value delimited by semicolons rather than commas. If Reply-To: has no value, 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, the callee 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.

About Moving Generated Local Files to the Siebel File System

This topic describes how to direct the 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.

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

LocalFileToGlobalXXX=tag|toReplace

where:

XXX must start at 0 and increase contiguously.

toReplace is the file that is moved to the Siebel File System.

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

For example, the driver generates the following EventFields:

LocalFileToGlobal0=OriginalMsgFile|C:\OriginalMsgFile.txt

OriginalMsgFile=C:\OriginalMsgFile.txt

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, the EventFields is modified as follows before submitted to the workflow for processing:

OriginalMsgFile=ABCDEFG

Siebel Email Response Administration Guide Copyright © 2008, Oracle. All rights reserved.