Jump to: navigation, search

pop-client



  


address

Default Value:
Valid Values: Any valid e-mail address
Changes Take Effect: Immediately


Specifies both the mailbox address used to route outgoing reply messages and the e-mail address used to fill in the From field in an email-out that is created from an email-in received from this pop-client. If the email-out is an automated response or an acknowledgement, the default From address used will be the address specified in this option. However, if an agent creates a reply email-out, the agent can change the From address by choosing an address from the pop-client addresses defined in all E-mail Server components connected to the same Interaction Server as the desktop application. The value must comply with RFC2822, and therefore must be encoded according to RFC2047. Examples of valid values include the following:
  • legal@mycompany.com
  • "Legal Dpt" <legal@mycompany.com>
  • "=?Cp1252?Q?Dpt_=E9_Legal?=" <legal@mycompany.com> where "=?Cp1252?Q?Dpt_=E9_Legal?=" is the French equivalent of Legal Dept and includes French diacritics.

If you have multiple POP clients, you can create multiple pop-client xxx sections. For each section, you must include a name starting with pop-client; for example, section pop-client support containing option address with value support@genesyslab.com, section pop-client sales containing option address with value sales@genesyslab.com, and so on.

You must not use the same mailbox address for more than one POP client. Each POP client requires a unique mailbox address, which you define using the address option for that pop-client xxx section.

Note that in the E-mail Server log file, the mailbox output refers to this mailbox address option, not to the explicit mailbox option used to specify the login name for your corporate mail server.

For each POP client you also specify an endpoint queue, to which the client submits outgoing e-mails. A one-to-one relationship is built between the mailbox address and the endpoint queue, and E-mail Server uses the resulting map to route e-mails accordingly. Therefore, if multiple POP clients share the same address, outgoing messages from one POP client might get routed to another POP client's queue.

If you want to use the same outgoing email address for more than one POP client, do not use the address option; instead use the default-from-address option in the email-processing section of the application object.

allow-bad-msg-size

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Specifies how E-mail Server handles messages with a negative size. If set to FALSE, the message is left on the corporate server, if set to TRUE, the message is considered a normal message.

connect-timeout

Default Value: 00:05:00
Valid Values: Any time period in the hh:mm:ss format
Changes Take Effect: At the next pop cycle


For the pop-client and smtp-client sections, specifies the timeout value for the socket connection. The timeout is raised if the connection to the server (corporate e-mail server for the pop-client section or SMTP server for the smtp-client section) cannot be established within the time specified for this option.

delete-bad-formatted-msg

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Specifies whether a message should be deleted from the corporate e-mail server if it cannot be retrieved from that server.

Note that leaving messages on a corporate email server works only when using IMAP protocol; it does not work when using POP3 protocol.

delete-big-msg

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Specifies whether an e-mail should be deleted from a corporate server if the E-mail’s message size exceeds the value set in the option maximum-msg-size.
Leaving messages on a corporate e-mail server works only when using IMAP protocol; it does not work when using POP3 protocol. When you are using IMAP, these messages are flagged as read and are not selected any more. When you are using POP3, these messages are considered each time.

enable-big-msg-stripping

Default Value: true
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Specifies whether E-mail Server must create a stripped version of messages whose size exceeds the configured maximum-msg-size. The stripped version contains only the headers of the original message, plus specific attached data to identify it.

enable-client

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Enables monitoring of this account. All other options in this pop-client section apply only if you set enable-client to true.

enable-debug

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Enables or disables protocol POP3/IMAP logging to the server’s standard output. If this option is set to true, full protocol logs are displayed in the E-mail Server logs. And if the JavaMail properties mail.debug and mail.debug.auth are both also set to true, the logs might display login negotiations that contain clear passwords.

Warning
Enabling this option slows down the server.

endpoint

Default Value: default
Valid Values: A string that matches the name of an endpoint defined in the endpoints:<tenant_dbid> section
Changes Take Effect: At the next pop cycle
Related Options: endpoints-*tenant_dbid*

Specifies the endpoint name by which E-mail Server identifies the queue to which it will submit an e-mail from this pop client. This endpoint name should be defined in the endpoints:<tenant_dbid> section. If this endpoint name is not defined in that section, then E-mail Server uses the default endpoint from the endpoints:<tenant_dbid> section. If no default endpoint is configured in the endpoints:<tenant_dbid> section, or if the endpoints:<tenant_dbid> section does not exist, then E-mail Server works in 7.1 compatibility mode, and uses the email-processing section's default-inbound-queue option.

exchange-version

Default Value:
Valid Values: A valid exchange server version, such as Exchange2010, Exchange2010_SP1, Exchange2010_SP2, Exchange2010_SP3, Exchange2013, Office365
Changes Take Effect: At the next pop cycle


Specifies the version of Exchange corporate server.

failed-items-folder-name

Default Value: failedItems
Valid Values: Any valid string to a folder on corporate e-mail server
Changes Take Effect: At the next pop cycle


Specifies the folder where failed items from Exchange server are moved. Effective only if move-failed-ews-item is set to "true" and type is set to "Exchange Web Services

(EWS)".

The value must be the name of a valid folder on the corporate server. If a folder with that name does not exist in the corporate server, E-mail Server tries to create it. If folder creation fails for some reason, a log message similar to the following is sent: 15:01:02.115 Std 25118 [MsgIn-11] Unable to create in corporate server folder 'failed_stuff' for failed item.

folder-path

Default Value: INBOX
Valid Values: Any valid path to an existing folder in corporate e-mail server
Changes Take Effect: At the next pop cycle


Specifies the folder to be checked for incoming e-mails.

folder-separator

Default Value: /
Valid Values: Any valid char
Changes Take Effect: At the next pop cycle


Specifies the folder separator used in folder-path.

leave-msg-on-server

Default Value: false
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Specifies whether retrieved incoming messages should be deleted from a corporate e-mail server after being successfully downloaded.

Leaving messages on a corporate e-mail server works only when you are using IMAP protocol; it does not work when you are using POP3 protocol.

mail.javamail-property

Default Value: No default value
Valid Values: Depends on the specific property; see reference below.
Changes Take Effect: At the next POP cycle


You can set certain JavaMail properties by simply adding them as option names to the E-mail Server's pop-client or smtp-client section. One example would be mail.pop3.disabletop, with value true. For a list of the JavaMail properties that you are allowed to set in this manner, and for further explanation, see the e-Services Adminstrator's Guide.

mailbox

Default Value:
Valid Values: Any valid login name associated with a POP/IMAP account
Changes Take Effect: At the next pop cycle
Related Options: address

Specifies the login name associated with the POP/IMAP account. You set this value during the E-mail Server setup.

In the E-mail Server log file, mailbox does not refer to this login option, but instead refers to the address option also found in this pop-client xxx section. You use the address option both to specify the mailbox address and to fill in the From field in outgoing reply e-mails.

maximum-msg-number

Default Value: 500
Valid Values: Any integer greater than 0
Changes Take Effect: At the next pop cycle


Specifies the maximum number of messages that E-mail Server can retrieve during an incoming cycle for this account.

maximum-msg-size

Default Value: 5
Valid Values: Any integer greater than 0
Changes Take Effect: At the next pop cycle


Specifies the maximum size (in MB) of an incoming message. Also see the option delete-big-msg.

move-failed-ews-item

Default Value: true
Valid Values: true, false
Changes Take Effect: At the next pop cycle


Enable or disable moving failed item to another folder (only supported by EWS connector).

password

Default Value:
Valid Values: Any string or none
Changes Take Effect: At the next pop cycle


In the pop-client section, specifies the password associated with this account. You set this value during E-mail Server setup. In the smtp-client section, specifies the password used to authenticate the user with respect to the corporate e-mail server when sending out messages. This applies only when you have set enable-authentication to TRUE.

pop-connection-security

Default Value: none
Valid Values: 'none', 'start-tls', 'start-tls-required', 'ssl-tls'
Changes Take Effect: At restart


In the pop-client, sets the level of security used.

For values other than none:
  • start-tls—Enables the use of the STARTTLS command (if supported by the server) to switch to a TLS-protected connection before issuing any login commands. If a TLS connection is not available, a plain-text connection is used.
  • start-tls-required—Enables the use of the STARTTLS command (if supported by the server) to switch to a TLS-protected connection before issuing any login commands. If a TLS connection is not available, the connection is aborted.
  • ssl-tls—Enables and enforces the use of Secure Sockets Layer (SSL) encryption when connecting to the corporate e-mail server.

port

Default Value: 110
Valid Values: Any valid port number
Changes Take Effect: At the next pop cycle


Specifies the port number for connecting to the corporate e-mail server. Allows the port to be changed for access through a firewall.

protocol-timeout

Default Value: 00:05:00
Valid Values: Any time period in the hh:mm:ss format
Changes Take Effect: At the next pop cycle


Whether in the pop-client or smtp-client section, specifies the message timeout value. The timeout is raised if the corporate e-mail server does not reply to protocol messages sent to it within the time specified for this option. You may want to adjust the timeout value to handle large messages. If the timeout expires before a message has finished processing, the following may occur:
  • A large incoming message may be repeatedly resubmitted, blocking processing of all following messages. Prevent this by increasing the value for this option in the pop-client section.
  • A large outgoing message may result in a Send service failure. Prevent this by configuring this option in the smtp-client section.

server

Default Value: No default value
Valid Values: Any valid host name or IP address
Changes Take Effect: At the next pop cycle


In the pop-client section, specifies the host name or IP address of the corporate e-mail server on which the account resides. In the smtp-client section, specifies the name of the corporate SMTP server. You set the value during E-mail Server setup.

Note: If connecting to Exchange Server with EWS, the value must be the EWS URL, not the host name or IP address.

type

Default Value: POP3
Valid Values: POP3, IMAP, EWS
Changes Take Effect: At the next pop cycle


Specifies the protocol used to retrieve incoming messages from a corporate e-mail server.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 14 May 2015, at 13:41.