Bookshelf v7.5: Driver Parameters for Internet SMTP/POP3 Server

Table 76 lists the supported parameters for the Internet SMTP/POP3 Server communications driver. Some parameters are applicable only to inbound email processing of messages retrieved from a POP3 server (for Siebel eMail Response), and some are applicable only to outbound email sent using an SMTP server. The channel type for this driver is Email.

Table 76. Internet SMTP/POP3 Server Driver Parameters
Name	Required	Default Value	Description
Create Plain Text From HTML	No	FALSE	If this parameter is TRUE, and an outbound message being sent contains text tagged with HTML but no plain text, synthesize (extract) the plain text from the HTML and send it as an alternate to the HTML. This situation may apply in these cases: User sends email using Send Email command, when Send Email: Default Message Format is set to HTML in the Outbound Communications tab of the User Preferences screen. User sends reply email using Siebel eMail Response, when Email Response: Default Message Format is set to HTML in the Outbound Communications tab of the User Preferences screen. User sends outbound communication request for the email channel, for which a template contains either or both of the following: HTML template text or at least one HTML template item. Sending separate plain-text and HTML versions of the same message body is called MIME multipart/alternative support. To increase performance when sending HTML messages to recipients known to use email clients that can read or convert HTML messages, set this parameter to FALSE. Note: The results of setting this option to TRUE may not be compatible with all major email clients. This factor must be considered before you set this parameter to TRUE. For more information about HTML email, see Using HTML Email. For more information about setting outbound communications user preferences, see Preference Settings in the Outbound Communications Tab.
Delete Processed Messages	No	TRUE	TRUE or FALSE Specifies whether processed messages are deleted. If TRUE, then messages are deleted from the "incoming" email directory after they are processed. If FALSE, then messages are moved to the "processed" email directory after they are processed. See also the descriptions for the Incoming Email Directory and Processed Email Directory parameters.
Failed Email Directory	No		The directory where failed incoming email messages retrieved from the POP3 server should be stored. An incoming message is considered to be a failed message if any error or exception occurs while the message is parsed. By default, failed email messages are saved to the bin/failed subdirectory of the Siebel Server installation directory.
From Address	Yes		The sender's email address for outbound communications. Should be in one of the following two forms: sendername@companyname.com sender_display_name <sendername@companyname.com> Use the second form above if you want the recipient to see a display name for the sender, in addition to the email address. The specified address is passed to the SMTP server in the "MAIL" command, and is used as the "From:" address in the message header. Note: End users who create email/fax profiles for personal use can specify their own email address, as appropriate, for the From Address parameter, as a profile parameter override. For more information, see Creating Communications Profiles for Personal Use. If no parameter value is provided, the driver tries to use the "SenderAddress" that is passed to the driver when it is asked to compose and send an email. Note: For a profile used for inbound communications, which is specified for a response group, the From Address parameter represents the recipient's email address.
Incoming Email Directory	No		The directory where email messages retrieved from the POP3 server are stored. By default, incoming email messages are saved to the bin/incoming subdirectory of the Siebel Server installation directory. Messages may be moved to another directory after processing. See also the descriptions for the Delete Processed Messages and Processed Email Directory parameters. Note: As inbound email messages are processed, they are saved in a series of formats and filenames in the incoming directory and related directories. Corresponding attachment files to the Email - Inbound activity record are saved to the Siebel File System. For more information, see Activity Attachments Stored for Inbound Email. For more information about inbound message processing, refer to Siebel eMail Response Administration Guide.
LogDebug	No	FALSE	TRUE or FALSE If TRUE, data output to the log file is more detailed. The additional detail in the log file can help you to troubleshoot. Log files are created in the log subdirectory of the Siebel Server installation directory. Log files for the Internet SMTP/POP3 Server driver have the name POP3SMTP_xxxxxxxxxxxxxxxx.log, where xxxxxxxxxxxxxxxx is a unique string of numerals.
Loopback Detection Interval	No	90	An integer value that specifies the number of seconds to flag any inbound messages as loopback messages that were received from a sender from which another message was just received. A message is determined to be a loopback message if the following are true: The value for Loopback Detection Interval is greater than 0 (zero), and The message is received no later than the specified number of seconds after a previous message was received from the same email address. This parameter is based on the premise that a message received within a short period of time has a high likelihood of being an auto-response. For example, if your system receives a message and sends out an auto-acknowledgement, that auto-acknowledgement message could, when processed by the recipient, generate a return auto-response. Setting this parameter can prevent message looping that may otherwise occur in this instance. If you set this value too high, you risk rejecting valid follow-up messages. If you set it too low, the driver may not correctly detect an inbound message that is actually just an auto-response. Loopback messages are not auto-acknowledged or auto-responded. They may either be moved to a "loopback" email directory, or processed as are other messages. See also the descriptions for the Loopback Email Directory and Process If Loopback Detected parameters.
Loopback Email Directory	No		The directory where email messages determined to be loopback messages should be stored, if they are not to be processed. By default, email messages determined to be loopback messages are saved to the bin/loopback subdirectory of the Siebel Server installation directory. See also the description for the Loopback Detection Interval and Process If Loopback Detected parameters.
Max Sends Per Session	No	0	Integer. Forces the driver to log off of the SMTP server after sending the number of messages specified using this parameter. The driver will then re-logon for the next send request. (Some SMTP servers may have problems sending a large number (1000 or more) of messages in one session.) A value of "0" (zero) means that the driver never logs off of the SMTP server.
POP3 Account Name	Yes		The account name for the POP3 mailbox from which to retrieve inbound communications.
POP3 Account Password	Yes		The password for the POP3 mailbox account.
POP3 Batch Size	No	15	The number of messages that will be retrieved before the driver is forced to log off from the POP3 server. If there is a failure during the POP3 session, messages previously retrieved show up again the next time the driver logs into the POP3 server. If the driver logs off periodically, you minimize the number of such duplicated messages in the event of a failure.
POP3 Reconnection Delay	No	400	Minimum amount of time to wait, in milliseconds, before logging onto a POP3 server you just logged off of. Specifying a delay interval may help avoid problems associated with email servers that may duplicate messages if a POP3 logon occurs very quickly after a logoff.
POP3 Server	Yes		The host name or IP address of the machine on which the Internet POP3 server is running, as appropriate for your network configuration. Note: If you specify a host name rather than an IP address for this parameter value, a corresponding entry must be included in your DNS server or the local hosts file. If an IP address parameter value works correctly, but a problem occurs when you have specified a host name parameter value, consult your network system administrator to verify that host name lookup is correctly configured.
POP3 Server Port	No	110	The port used by the Internet POP3 server to listen for new socket connections.
POP3 Timeout	No	60	Number of seconds to wait for a response from the POP3 server before timing out.
PollingInterval	No	30	Number of seconds between checks for new inbound mail arriving on the POP3 server.
Processed Email Directory	No		The directory where email messages retrieved from the POP3 server should be moved, after they have been processed—unless they are to be deleted instead. The Delete Processed Messages parameter is used to determine whether processed messages are deleted or moved to this directory. By default, if Delete Processed Messages is FALSE, the "processed" Email Directory is the bin/processed subdirectory of the Siebel Server installation directory. See also the description for the Delete Processed Messages parameter.
Process If Loopback Detected	No	TRUE	TRUE or FALSE Specifies how to handle an incoming message that is determined to be a loopback message. If TRUE, then a loopback message is processed by Communications Inbound Manager and associated workflows, as are any other messages. If FALSE, then a loopback message is saved to the "loopback" directory. Loopback messages are not auto-acknowledged or auto-responded. The Loopback Detection Interval parameter is used to determine whether a message is flagged as a loopback. See also the descriptions for the Loopback Detection Interval and Loopback Email Directory parameters.
Reply-To Address	No		An optional reply-to email address for the message, if it is different than that specified with the From Address parameter. Multiple email addresses can be specified, separated by semicolons. If a reply-to address is specified, then outgoing messages will have a "Reply-To:" header field added to the message envelope with the specified value. Should be in one of the following two forms: sendername@companyname.com sender_display_name <sendername@companyname.com> Use the second form above if you want the recipient to see a display name for the sender, in addition to the email address.
Return Attachments	No	TRUE	TRUE or FALSE Specifies whether to accept or discard attachments. If TRUE, any attachments parsed from the incoming message are passed into the Siebel application. If FALSE, the attachments are simply discarded.
Save Sent Messages	No	FALSE	TRUE or FALSE Specifies whether to save sent messages. If TRUE, sent messages are saved into the "sent" email directory. If FALSE, sent messages are not saved. Each message is saved as a separate, MIME-encoded file, in the exact format in which it was sent to the SMTP server. See also the description of the Sent Email Directory parameter.
Sent Email Directory	No		The directory where sent messages should be saved, if Save Sent Messages is TRUE. By default, if Save Sent Messages is TRUE, messages are saved into the bin/sent subdirectory of the Siebel Server installation directory. See also the description of the Save Sent Messages parameter.
Siebel Server	No		The name of the Siebel Server that is to handle the delivery of the communications. For more information, see Administering Communications Outbound Manager.
SMTP Backup Server	Yes		The host name or IP address of the machine on which the backup Internet SMTP server is running, as appropriate for your network configuration. You use this parameter when you have implemented a failover strategy for your SMTP server handling outbound email or fax communications. If the primary SMTP server goes down, outbound communications using profiles in which these parameters are defined will be sent to the backup SMTP server instead, until the primary SMTP server has come back up. If you have implemented failover support for your SMTP server, then you must use both the SMTP Server and SMTP Backup Server parameters. If you have not implemented failover support for your SMTP server, use the SMTP Server parameter only. Do not define the SMTP Backup Server parameter. Note: If a message cannot be sent to an SMTP server because it is down, the driver returns a message to the Communications Outbound Manager, which will lead to another attempt to send the message at a later time. (This behavior is not specific to a failover configuration.) For more information, see the description of the SMTP Server parameter.
SMTP Server	Yes		The host name or IP address of the machine on which the Internet SMTP server is running, as appropriate for your network configuration. Note: If a message cannot be sent to an SMTP server because it is down, the driver returns a message to the Communications Outbound Manager, which will lead to another attempt to send the message at a later time. Note: If you specify a host name rather than an IP address for this parameter value, a corresponding entry must be included in your DNS server or the local hosts file. If an IP address parameter value works correctly, but a problem occurs when you have specified a host name parameter value, consult your network system administrator to verify that host name lookup is correctly configured. See also the description of the SMTP Backup Server parameter.
SMTP Server Port	No	25	The port used by the Internet SMTP server to listen for new socket connections.
SMTP Timeout	No	60	Number of seconds to wait for a response from the SMTP server before timing out.
Try POP3 Logon	No	FALSE	TRUE or FALSE If TRUE, the driver tries to log on to the POP3 server during its initialization process. If the driver cannot log on to the POP3 server, it will fail to load. By failing to load, the driver prevents unnecessary error messages from being generated at the interval specified with the PollingInterval parameter (the interval for checking for new messages). See also the description of the PollingInterval parameter.
Use EHLO	No	TRUE	TRUE or FALSE Set to TRUE if SMTP extension (ESMTP) commands should be used on a particular email server. Causes the first command sent to the server to be "EHLO", which enables the extension commands to be available. Set to FALSE if you are using an SMTP server that cannot handle the EHLO command.