Administration Table of Contents
- ndMail Administration Setup and Configuration
- ndMail Setup Requirements
- ndMail Administration Installation
- Configuring Exchange Web Services for ndMail
- Configuring Impersonation for ndMail
- Configuring Exchange Connection on the Repository
- ndMail Folder Mapping Registry Keys
- ndMail Collapse or Expand Registry Keys
- ndMail Settings Registry Keys
- ndMail Troubleshooting
- ndMail User Help
ndMail Administration Setup and Configuration
To set up and install ndMail, follow these steps:
- Ensure you have met all ndMail Setup Requirements.
- Before ndMail installation, follow the steps to Configuring Exchange Web Services for ndMail and Configuring Impersonation for ndMail.
- Configure the Exchange Connection on the Repository.
- Follow best practices for downloading and installation; for this, see ndMail Administration Installation. Your users can install it on a client with Administrator Rights.
Before installing the ndMail add-in, you must have Visual Studio Tools for Office Runtime (VSTO), Microsoft .NET Framework 4.5.2+, ndOffice application, and all available Windows updates installed on a computer.
WARNING: Before installing, repairing, or uninstalling the ndMail application, you need to close Microsoft Outlook.
Use the following setup prerequisites to install the ndMail application successfully.
Supported Operating System
Windows 7, 10 (64-bit)
Microsoft Office Outlook
2013, 2016 (32- or 64-bit), including Microsoft Office 365 subscriptions
Visual Studio Tools for Office
Requires Version 10.0.50903+ for installation
Requires Version 4.5.2+ for installation
2010 SP2, 2013, 2016, Online (Office 365)
Before installing the ndMail add-in, you must have Visual Studio Tools for Office Runtime (VSTO), Microsoft .NET Framework 4.5.2+, ndOffice application (version 188.8.131.5219+), and all available Windows updates installed on a computer.
To install ndMail on the individual client:
- Ensure the account has administrative rights before installation.
- If there is no account, create a new NetDocuments user called "ndMail Administrator" and grant this account a repository and cabinet administrative rights.
- Download ndMail Installer, and then follow the steps below to begin the installation.
- Double-click the ndMailSetup.exe, then select Next.
- In the Completed the NetDocuments ndMail Setup Wizard dialog box, select Finish.
To install ndMail from the command line:
- Open a command prompt as an administrator.
- In the command prompt, navigate to the installation folder.
- To install from the command prompt, enter the following command:
msiexec /i ndMailSetup-1.0.0.X.msi.
- To install ndMail silently, type msiexec /i ndMailSetup-1.0.0.X.msi /qn.
- To perform the all-user installation, add ALLUSERS=""'.
The ndMail install within the registry HKEY_LOCAL_MACHINE\Software\NetVoyage\NetDocuments hive either adds or changes the following values to False: ShowExtOutlookFeatures and PromptFileEmails. Thus, the install suppresses the following ndOffice features in Outlook:
- The ND Send group (contains Send & File).
- The Suggested Locations and Private Access button on the ND Save group. The ND Save button and Suggested Locations still exists in the dialog box.
- ND COLUMN – If this value appears from an earlier version, you must remove it manually.
ndMail uses Exchange Web Services (EWS) to interact with user email messages and folders.
Note: For more information, see https://msdn.microsoft.com/en-us/library/office/jj900168(v=exchg.150).aspx.
Enable Exchange Web Services
Exchange Web Services (EWS) is a foundational access method in the Exchange architecture. Microsoft builds both the Outlook client and the Outlook Web App (OWA) on EWS. To view how EWS fits into the Exchange environment, see the architectural diagram at https://msdn.microsoft.com/en-us/library/office/dn595100(v=exchg.150).aspx.
ndMail is a cloud-based service. EWS is enabled on the Exchange Server by default. If Exchange is running on-premise, then port 443 is required to allow ndMail to access it.
For more information, see https://technet.microsoft.com/en-us/library/bb331973(v=exchg.160).aspx.
Service Application Access
Exchange integration for ndMail is built and deployed as a service application. To access the service application, you need to do the following:
- Create a service account. ndMail uses the basic authentication when creating the service account to EWS with an impersonation role assigned, allowing it to impersonate Exchange users to read folders and emails.
- Grant the service account a user impersonation role. For information on how to add impersonation role for a service account, see Configuring Impersonation for ndMail.
Administrators can manage EWS access controls using Exchange Management Shell and the following cmdlets:
Note: For more information, see https://msdn.microsoft.com/en-us/library/office/jj900165(v=exchg.150).aspx#Anchor_3.
To retrieve and file email documents for subscribed users, ndMail requires the ability to impersonate users in the Exchange domain. Use RBAC (role-based access control) on the Exchange Server to enable impersonation for a service account.
To configure impersonation on Exchange Server 2013, 2016
- Open the web-based Exchange Admin Center (EAC) of the Exchange Server.
- Click the Permissions tab.
- To create a new administrative role, click the icon.
- In the new role group dialog box:
a. Enter a name for the new administrative role.
b. Under Roles, click the icon, and then select ApplicationImpersonation.
c. Under Users, click the icon.
d. To collect the mailbox data from Exchange Server (SyncUser), select the account, and then click OK.
e. Click Save.
NOTE: Configure Exchange 2013 and 2016 using the Exchange Management Shell cmdlets to control access management for EWS applications and the RBAC for impersonation. For more information, see the following table, which includes steps and links on how to use Exchange Management Shell - a PowerShell-enabled command-line processor with command handlers for Exchange.
|Exchange Server version||Link|
NOTE: Do not install the New-ManagementRoleAssignment cmdlet in your Exchange Management Shell. To add the cmdlet, type Add-PSSnapin Microsoft.Exchange.Management.PowerShell.E2010 in the Exchange Management Shell, and then press Enter.
Complete post-configuration at the following:
- ndOffice settings to identify Host.
- NetDocuments ndMail Configuration page to identify the host, email, username, and password.
Ensure to install ndOffice before configuring ndMail because ndMail shares the network and user-related settings with ndOffice. Log in using the corresponding credentials, and then select a host.
To configure ndOffice Settings to use ndMail:
- After installing ndOffice, log in using your credentials.
- On the taskbar, click the icon.
- In the ndOffice Activity dialog box, click , and then click Settings.
- In the ndOffice Settings dialog box, click the Network tab.
- From the Host drop-down menu, select one of the following hosts:
- vault.netvoyage.com – For the US data center.
- eu.netdocuments.com – For the European data center.
- au.netdocuments.com – For the Australian data center.
- preview.netdocuments.com – For previewing the new functionality before the beta release of NetDocuments.
- ducot.netdocuments.com – For testing purposes (restricted access to the DUCOT system).
- Under Proxy, select one of the following:
- No proxy
- System proxy
- HTTP proxy
To set up ndMail Configuration on NetDocuments:
- Log in to NetDocuments Web interface, and on the Home page, click the <your name>.
- Hover over the Admin, and then click the needed repository.
- Under Repository, select ndMail Configuration.
- On the ndMail Configuration page, under Exchange Configuration, fill in the following fields:
- Exchange Host – Provide DNS name or the IP address of your Exchange host. For example, outlook.office365.com or em-exchange2016.netdocuments.com.
- Verification Email Address – Provide SMTP address <[email protected]> for a user on your Exchange system. This user's email address is required for a one-time verification to confirm the successful configuration of the Exchange service account with the necessary permissions to impersonate Exchange users.
- Exchange Admin Email Address – Provide SMTP address <[email protected]> of an Exchange account with granted impersonation rights to all the users on the target Exchange domain.
- For Exchange 2010 ONLY: Enter username only, without <@domain.com>.
Note: Create this account specifically for the ndMail Exchange service account. When properly configured with impersonation rights, this Exchange user account can read emails to ANY user in the Exchange domain. Optionally, you can give this user rights to impersonate only those mailboxes in a specific group. Refer to Exchange documentation for additional details. Keeping this account’s credentials secure is imperative.
- Exchange Admin Password – Provide a password for the Exchange service account.
- To validate if these settings are properly configured, first, click Save, then select Validate existing configuration.
- On the ndMail Configuration page, under OAuth, select a cabinet from the drop-down list to generate an OAuth token. You must generate a token for each cabinet to fill emails.
Note: The logged in repository or cabinet administrative account must have cabinet administrative rights to the selected cabinet.
- Select Close.