Understanding Lexmark Email Watcher configuration data

Learn about the Lexmark Email Watcher configuration data.

Lexmark Email Watcher is installed in the base Lexmark Solutions folder that is selected when installing the load balancer. By default, the location is %ProgramFiles%\Lexmark\Solutions\EmailWatcher. The configuration file is config_EmailWatcher.properties and is located in the conf subfolder. A file that contains sample properties is installed. Some of the properties are commented out, and some are not in the file yet. Add the necessary properties for your email server.

Notes:
  • Lexmark Email Watcher must be restarted if any changes are made to the configuration file. The changes do not take effect until the service is restarted.
  • When troubleshooting, the log files are located in the .\EmailWatcher\logs folder. If the configuration file enables debugging, then the emailwatcher.log file contains extra logging. To enable more logging, open the .\EmailWatcher\conf\l4j_EmailWatcher.xml file. From the bottom of the file, change the level value for com.lexmark.tis.tools.emailwatcher and javax.mail to debug. Make sure that the properties are changed to info after the issue is resolved.
  • To change the username or password, using a text editor, edit the property file, and then replace the encrypted entries with the new credentials. Restart Lexmark Email Watcher to read and re-encrypt the password.

Setting

Valid values

Notes

ldd.server

http://IPaddress:9780

Where IPaddress is the IP address or host name of the load balancer.

A sample URL is http://my-lpm-server:9780.

ldd.profile

mobileprint

The name of the profile when the job is submitted to LPM. Do not change this setting.

mail.type

  • imap

  • pop3

  • ews

The type of email server on which the email account is located. We recommend using IMAP.

mail.server

N/A

For IMAP or POP3, this setting is the IP address or host name of the mail server.

mail.port

  • 143 (IMAP)

  • 993 (IMAP over SSL)

  • 110 (POP3)

  • 995 (POP3 over SSL)

For IMAP or POP3, the common ports are listed. If necessary, use another value.

mail.tls

  • 0 (no TLS)

  • 1 (use TLS)

For IMAP or POP3, this setting determines whether TLS must be used when communicating with the mail server.

Only TLS or SSL can be used, not both. If TLS is enabled, then the SSL setting is ignored.

mail.ssl

  • 0 (no TLS)

  • 1 (use TLS)

For IMAP or POP3, this setting determines whether SSL must be used when communicating with the mail server.

Only TLS or SSL can be used, not both. If TLS is enabled, then the SSL setting is ignored.

mail.folder

INBOX

For IMAP or POP3, this setting specifies the folder where new mail appears. We recommend not changing this setting.

mail.allowNTLM

  • 0 (Do not allow)

  • 1 (Allow)

For IMAP or POP3, this setting determines whether the user can authenticate using NTLM. We recommend not changing this setting.

mail.domain

N/A

For IMAP or POP3, this setting is the domain of the user account.

mail.user

N/A

For IMAP or POP3, this setting is the username of the monitored account.

mail.pw

N/A

For IMAP or POP3, this setting is the password of the monitored account.

mail.allowIdle

  • 0 (Do not allow)

  • 1 (Allow)

If the mail server supports automatic notification of new emails, then this setting specifies whether to enable automatic notification. If disabled, then set the poll value of the mail.poll setting.

Note: Typically, only IMAP servers support automatic notification of new emails.

mail.poll

60

The time in seconds before new email is checked. The default is 60 seconds.

Note: If your server supports automatic notification on new emails, then polling is not necessary.

Debug

  • 0 (Off)

  • 1 (On)

Determines whether extra logging must be written to the log file. We recommend enabling this setting only when troubleshooting an issue because the amount of data being logged can slow down the processing.

Sample Lexmark Email Watcher config_emailwatcher.properties configurations

For IMAP 

# Mandatory Properties
ldd.server=http://[ldd-lb-addr]:9780
ldd.profile=mobileprint
mail.server=imap.gmail.com
mail.user=test@company.com
mail.pw=notTheRealPassword

# Optional Properties.
mail.type=imap
mail.ssl=1
mail.tls=0
mail.port=993
mail.folder=INBOX
mail.allowIdle=1

debug=1

For Microsoft Exchange 

# Mandatory Properties
ldd.server=http://[ldd-lb-addr]:9780
ldd.profile=mobileprint
mail.server=ews.mail.com
mail.domain=test_domain
mail.user=test_ews@company.com
mail.pw=notTheRealPassword

# Optional Properties.
mail.type=ews
mail.ssl=1
mail.folder=INBOX
mail.ignoreSSLCert=1

debug=1

Sample config_emailwatcher.properties file for Microsoft Exchange Online modern authentication in <LDD-install-path>\EmailWatcher\conf

Modern authentication authenticates the user through a single browser-based application, tenant ID, user ID, and the required details. The following is a sample batch file for Microsoft Exchange Online modern authentication.

# GENERAL CONFIGURATION
ldd.server=http://<Put LDD Server/LB IP>:9780

# STANDARD PRINT CONFIGURATION.
# This is the existing email watcher feature and is enabled by default.
# Do not use the same email account with guest print.
# Do not change the value of "ldd.profile".debug=1
#
standard.print.enable=1
ldd.profile=mobileprint

### Required only if not using Exchange Online.
### "mail.user" and "mail.pw" values will be replaced with encrypted text
### when EmailWatcher service is started. To change either of the values,
### simply replace the encrypted value with the new value. Please make sure
### that the values do not start with "ENC(" and end with ")".
mail.user=
mail.pw=

# GUEST PRINT CONFIGURATION
# Using the email service account specified below, EmailWatcher can monitor
# incoming print jobs from guest users. This feature is disabled by default.
# To enable, set "guest.print.enable" to 1.
#
# Do not use the same email account with standard print.
# Do not change the value of "ldd.profile.guest".
#
guest.print.enable=1
ldd.profile.guest=guestrelease

### Required only if not using Exchange Online.
### Specify the values for "mail.user.guest" and "mail.pwd.guest". Values will
### be replaced with encrypted text when EmailWatcher service is started.
### Make sure that the values do not start with "ENC(" and end with ")".
mail.user.guest=
mail.pw.guest=

# MAIL SERVER CONFIGURATION
# Uncomment then provide values for the applicable properties.
# If not applicable, keep it being commented out.
#
### Specify mail server address for IMAP, POP3, Exchange Premise mail types
### For Exchange Online, value is not required.
mail.server= 

mail.type=ews
#mail.domain=<mail domain>
#mail.ssl=< 0 or 1>
#mail.port=<mail server port>
mail.folder=INBOX
#mail.ignoreSSLCert=< 0 or 1 >
mail.poll=60
#mail.allowIdle=1  #If  Mail Server supports IMAP IDLE
mail.hideUserAndJobInfo=1

# ADDITIONAL SERVER CONFIGURATION FOR MS EXCHANGE
# Uncomment then provide values for the applicable properties.
# If not applicable, keep it being commented out.

### Authentication types:
###   basic     - For username/password authentication
###   oauth2    - Modern authentication (OAuth 2.0)
ews.auth.type=oauth2

### Authorization flows:
###   auth-code-with-client-id-secret     - OAuth 2.0 authorization code grant type, or auth code flow
ews.auth.grantType=auth-code-with-client-id-secret

### The generated application (client) ID of your registered
### app in Azure Active Directory.
ews.aad.clientId=076c7620-10e8-4418-9592-1f7a1a80868b

### The generated application (client) secret of your registered
### app in Azure Active Directory.
ews.aad.clientSecret=KeX8Q~Xd~wo.49fFqE_a6S.lMn~Pu6tQHhmE-a2c

### Identity platform endpoint to acquire security tokens
### For <tenant>, valid values are common, organizations, consumers, and tenant identifiers.
ews.aad.authority=https://login.microsoftonline.com/12709065-6e6c-41c9-9e4d-fb0a436969ce

### The redirect URI of your app, where authentication responses
### can be sent and received by your app. It must exactly match one
### of the redirect URIs you registered in the portal.
### You must specify a port in the URI. For example: https://localhost:5000/
ews.aad.redirectUri=http://localhost:9991/

### A space-separated list of scopes that you want the user to consent to.
### This value allows your app to get consent for multiple web APIs you want to call.
ews.aad.scopes=openid offline_access https://graph.microsoft.com/Mail.ReadWrite

### Indicates the type of user interaction that is required
### when authenticating the user.
### Valid values: login, consent, select_account
ews.aad.prompt=select_account

### The timeout (milliseconds) to wait for the user to input and validate their
### credentials for authentication.
ews.socket.timeout=300000

### Messages that will be printed in the oauth2 login tab of browser after acquiring the auth code.
ews.afterLoginMessage.standard=Authorization code for Email Watcher Standard Print service account has been successfully acquired. You can now close this tab.
ews.afterLoginMessage.guest=Authorization code for Email Watcher Guest Print service account has been successfully acquired. You can now close this tab.

### The delay (milliseconds) between authentication prompts
### when both standard and guest print features are enabled.
ews.auth.prompt.delay=5000