eCopy Connector for SMTP via LDAP

The eCopy Connector for SMTP using LDAP enables users to send scanned documents from an eCopy-enabled device as email attachments using an SMTP server on the network. When a user sends email from a personal SMTP account (including a Gmail account), the system prompts users to log on to validate their identity. The Global Address List is provided by an LDAP server.

To be able to use this connector with the Email and folder watching service, you need to create a profile in such a way that it does not require user interaction (express). Complete the following steps:

  1. Go to the Logon/SMTP tab (in the Properties window), the Logon options group and select either option for Authentication: None: Send from generic email or None: Send from generic email address specified by Data Publishing.
  2. Go to the SMTP Server group in the same tab and as the Authentication method, either choose None or Login as (and supply the proper credentials).
  3. In the Sending options tab choose either as the Display option: Express to Default recipients or Hide form and send to self.
  4. Ensure that the Encryption connector setting has the User Modify parameter set to 'No' (clear the Yes check box).
  5. Ensure that the Document Name connector setting is configured as follows:
    • It is set to the Default File Name value, or
    • Its value is Specify name... with the User Modify option off (clear the Yes check box), or
    • Used Advanced File Naming..., where all fields have the User Modify option off (in the Field Editor dialog).

For the generic connector configuration options, see Configure connector profile.

Connector properties

The Properties window enables administrators who are more familiar with LDAP to fine-tune the settings, without relying on the Wizard.

  • Logon /SMTP settings
  • LDAP settings
  • Address book settings
  • Sending options settings

Logon / SMTP settings

Select the protocol combination to be used via this tab.

Field Name

Description

Authentication

Select the authentication type from the list:

  • Runtime: LDAP
  • None: Send from generic
  • None: Send from generic email address specified by Data Publishing
  • Use Runtime user's LDAP e-mail address

For a practical example of configuring the Data Publishing with a connector, see Data Publishing Mapper tool.

Allow user to modify

If checked, the user is able to customize the email field on each scan.

Default generic email

Allows the administrator to provide a default generic email address to specify as the sender.

Server

IP or DNS name of the SMTP server.

Port

Port address of the SMTP server. Default is 25, when an unencrypted communication channel is used. For encrypted SMTP communication, port 587 is selected.

Test

Clicking the Test button tests the connector with the current settings.

Server requires SSL

Specifies if SSL is used for the SMTP communication. Must be set to on (checked) when using Gmail.

Reset

Click this button to set the default values for setting Gmail or generic SMTP servers.

For Gmail, the defaults are as follows:

  • Hostname: SMTP.GMAIL.COM
  • Service port: 587
  • Server requires SSL: ON (checked)
  • Authentication: Use sender’s LDAP UserID attribute and runtime password as Authentication

Searching your Gmail contacts is also enabled. The Search while typing feature can be configured on the Address book tab.

Authentication

Define the type of authentication behavior for the SMTP server:

  • Runtime: Prompt sender for a username and password: the SMTP Authentication form is displayed to the user at runtime after the Send form.
  • None: When selected, the user is not prompted for a username and password. In addition the connector does not attempt any authentication with the SMTP server. The email send process may fail if the server requires authentication.
  • Login as: When selected the fields Username and Password will display below the Authentication combo in admin. Here the administrator can specify a set of credentials that will always be used when sending an email from the connector.
  • Use senders LDAP userID attribute and runtime password: When this option is selected and if the LDAP address book is enabled, the connector utilizes the LDAP userID attribute and password provided at the User Logon form to authenticate them against the SMTP server. If the LDAP address book is not enabled at the time of closing the properties dialog, an error is displayed to the user informing them that LDAP must be enabled or a different SMTP authentication type must be chosen.

Use specified domain if secure SMTP is enabled

If checked, the domain box is enabled and the user can input a domain. During the send process, the connector provides this domain along with username and password to the SMTP server.

LDAP settings

Controls the various LDAP settings of the connector.

Field Name

Description

Enable LDAP address book

Click the Find button to locate the LDAP server during runtime.

Connection type

Specifies how to connect to the LDAP server:

  • Use credentials: The connector connects to the LDAP server with a user specified in UserDN and Password.
  • Anonymous: the connector connects to the LDAP server anonymously. Not all LDAP servers allow anonymous connections.
  • Use ShareScan Manager service credentials: The connector always connects to the LDAP server with the actual ShareScan Manager service user credentials. User ID and Password are required only for testing the LDAP server configuration.

Server

IP or DNS name of the LDAP server.

Port

Port number of the LDAP server for communication purposes. The default is 389.

Server requires SSL

Check if the server requires SSL connection.

User DN

User DN of the logged in user.

Password

Password of the logged in user.

Advanced LDAP settings

Allows you to define what the actual attribute is called on the LDAP server itself and allows customization of LDAP attributes to return during your searches.

The available settings are:

  • Person: Allows defining the actual ObjectClass to represent the “person” class during a recipient and sender search.
  • Group: Allows defining a second ObjectClass to represent the “Group” class during a recipient search only.
  • First name: Allows defining the actual attribute name to search for.
  • Last name: Allows defining the actual attribute name to search for.
  • Common name: Allows defining the actual attribute name to search for.
  • User ID: Allows defining the actual attribute name to search for.
  • Email: Allows defining the actual attribute name to search for.
  • Fax number: Allows defining the actual attribute name to search for.

Custom LDAP attributes:

  • Sender: Allows defining the actual attribute name to search for.
  • Recipient: Allows defining the actual attribute name to search for.

LDAP search

Allows you to specify the attributes of the LDAP searches.

The available settings are:

  • Base DN: Determines the LDAP search starts when typing in the LDAP authentication form or the Send form. Empty base DN prompts an error.
  • Search scope: Can be set to All levels below starting point or One level below starting point.
  • Search on: Allows defining the attributes to be searched on.
  • Search while typing
  • Max results: Sets the amount of results returned. The default value is 200.

Test

Clicking the Test button tests the connector with the current settings.

Address book

Section/Field Name

Description

Enable eCopy Address Book

Enables the eCopy Address Book.

Database

Enables you to Select or Create a database.

To create a database, you must provide the following data:

  • SQL server name: a valid SQL server name and instance.
  • Database: the database name for the eCopy Address Book.
  • User ID: the identification of the user.
  • Password: the password required to access the database.

Search on

Set the search parameters you want to use.

Address book

Shows the name of the selected address book.

User

Displays the name of the selected user.

Manage

Use the Add, Delete, Import, and Export buttons to manage the address data list.

Gmail

Check the Enable using Gmail Contacts check box to access the user's contacts list via the Gmail Contact API; this way, when the user enters recipients on the Send form of the connector, the Gmail contacts are visible and selectable along with, for example, the eCopy address book contacts. Use the Search on list to specify the search criterion.

The Google address book can be accessed via Token Vault. Without using Token Vault, accessing the Google address book is not possible due to security reasons. Should you have any questions, contact support.

Sending options

You can set up the Express mode using the Sending options tab.

Section/Field Name

Description

Display options

Allows you to set the send form options:

  • Display form
  • Display form without CC
  • Express to Default recipients
  • Hide form and send to self

Default message

Allows you to set the default message.

Default recipients

Allows you to specify default email recipients for a connector. Use the Add button to populate the list. Click the Remove button to delete the selected entry.

Also allows you to specify settings to retrieve recipient names from data publishing.

Data publishing

Allows you to set the data publishing action:

  • Ignore Data Publishing values
  • Recipients are taken from Data Publishing only
  • Combine values with default recipients

For a practical example of configuring the Data Publishing with a connector, see Data Publishing Mapper tool.

Send copy to sender

Sends you a copy of each message sent.

Manage content

Allows you to add /remove or reorder notes and subjects from the list. Also allows you to create bylines, which appear below the note in the email. You can also define notes and subjects to be received from data publishing by using $$NOTE$$ and $$SUBJECT$$ in the Note and Subject fields.

Connector Wizard settings

The Wizard enables administrators to initially configure the connector. Many windows contain a Test button that enables you to validate the logon information or test the server connection.

Wizard window

Field

Description

LDAP server type

Server type

The available server types:

  • None (disable LDAP address book)
  • Generic LDAP server
  • Windows Active Directory
  • Windows Active Directory (Untrusted)
  • Novell eDirectory
  • Netscape LDAP server
  • Open LDAP server
  • IBM Domino server

If your server type is not on the list, select the Generic LDAP server option.

 

LDAP attributes

Enables you to set the attributes for the LDAP classes used by your server or to accept the defaults shown here.

Windows Active Directory server account

Account settings

Active Directory Server Account settings:

  • User name
  • Password
  • Domain

The Wizard uses this information to set the user DN and server name.

Available only if you select Active Directory as the server type.

The account used for test and notification is a domain user and that domain user must be linked to the Gmail account in Token Vault. The domain, the username and the password information must be provided by the ShareScan administrator.

LDAP server settings

LDAP server

This wizard window is not available if you select Active Directory as the server type on the LDAP server type wizard window.
  • Connection type: Specifies how to connect to the LDAP server:
    • Choose Use credentials to connect to the LDAP Server with a user specified in UserDN and Password.
    • Anonymous allows to anonymous connection to the LDAP server, if the server supports anonymous authentication.
    • Choose Use ShareScan Manager service credentials to connect to the LDAP server with the actual ShareScan Manager service user credentials. This case User DN and Password are required only for testing the LDAP server configuration.
  • Server: IP or DNS name of the LDAP server.
  • Port: Port number of the LDAP server for communication purposes. The Wizard assumes that the server is using the default port number (389).
  • Server requires SSL: Check if the server requires SSL connection.
  • User DN: User DN of the logged in user. You must provide the full user DN if the server requires it.
  • Password: Password of the logged in user.
  • Test: Click this button to check your settings.

Search settings

Defines how the LDAP server searches the address book. Enables you to select a user from the LDAP tree in the Select LDAP User window.

Not available if you select Active Directory as the server type.

Base DN

The node on the LDAP tree from which all searches should begin. If you do not know the node, click the Browse button and select the node from the tree structure in the selection window.

 

Search scope

Select a search level:

  • All levels below search starting point: Allows expanded searching.
  • One level below search starting point: Optimizes LDAP queries and improves performance.

Sender search

The search criterion that the server uses to find the sender:

  • First Name
  • Last Name
  • Common Name
  • User ID (default)

The setting defines the information that the user sees on the Logon screen at the device.

Recipient search

The search criterion that the server uses to find the recipient:

  • Common Name (default)
  • First Name
  • Last Name
  • User ID

The setting defines the information that the user sees on the Send screen at the device.

Tip: If you are using an Active Directory server and want the list of recipients to display groups as well as individuals, eCopy recommends that you retain the default setting, Common Name. If you select any other search criterion, users who want to send documents to a group must enter the complete e-mail address of the group at the device.

Search while typing

Enables or disables the Search while typing functionality for the related field at the device.

Max results

The limit on the number of results to be returned by the LDAPsearch. The default value is 200.

SMTP settings

Select your SMTP server and the type of authentication that will be required of the user at the device.

Server

The SMTP server name.

Port

The SMTP port number.

Authentication

The type of authentication to use on the SMTP server. Available only if SMTP Basic Authentication is enabled on the server.

User login settings

Generic email

A generic email address that is used as the sender account for all email.

User Modify

The user at the device can modify the sender’s email address.

Runtime: LDAP

Requires the user at the device to enter the user name and password specified for the LDAP server.

Runtime: Windows

Enables users at the device to use their Windows logon information, via the SAMAccountName attribute, to log on.

The Domain field specifies the Windows domain name, populated from the Account Settings window. This is required if you select the Windows option.

Available only if you select Active Directory as the server type.

Runtime: Novell

The Novell tree. This is required if you select the Novell option. Available only if you select eDirectory as the server type.

Settings summary

Enables you to review your settings. Use the Back button if you need to change any settings. Use the Finish button to apply your settings to the connector profile.

SMTP settings

Section

Field

Description

SMTP server

Server

The IP address or DNS name of the SMTP server to use for outgoing messages. If the server supports anonymous access, it must be disabled if you want to use SMTP authentication.

Port

The SMTP port number (default is 25).

Server requires SSL

Enables Secure Socket Layer (SSL) to be used for SMTP communication. If you select this option, you must install a valid SSL certificate on the same device as the connector.

Authentication

Runtime: Prompt Sender for a user name and password

Prompts the user at the device to enter a user name and password when the user presses the Send button on the Send screen.

Available only if SMTP Basic Authentication is enabled on the server.

If Session Logon is enabled, and SSL is not enabled, eCopy recommends that you select “None” or “Login as”.

 

None

Use if the SMTP server does not require authentication.

The user at the device is not required to supply any credentials.

If the server requires authentication, the email send process can fail.

 

Login as

Enables the user at the device to connect to the SMTP server without being prompted for authentication information. The connector uses the user name and password set by the administrator.

 

Use Sender’s User ID, LDAP attribute, and runtime password

Uses the sender’s LDAP authentication information to connect to the SMTP server.

To use this option, you must enable the LDAP address book on the LDAP settings tab.