Knowledge Base

The VMware Knowledge Base provides support solutions, error messages and troubleshooting guides
 
Search the VMware Knowledge Base (KB)   View by Article ID
 

Setting up MAPI for incoming emails in VMware Service Manager (1023557)

Symptoms


service-manager-email

Purpose

This article provides the steps to configure MAPI for incoming emails in VMware Service Manager.

Resolution

VMware Service Manager supports MAPI for incoming emails on systems with Version 8 Rolling Patch 18 or later installed. (Version 9 does not require additional files from VMware to enable MAPI as it is included with the base install of VSM 9.0 and greater versions.) The mailbox polled is the user's inbox.
 
Instead of the original IN_MAIL DLL provided with Service Manager, sites that use MAPI use:
  • An updated IN_MAIL80 DLL file
  • A Redemption dll file for Incoming Email
  • A MailBee DLL file for Outgoing Email

These files are provided on request. To get these files, contact a VMware Support and quote this Knowledge Base article ID.

Summary of Steps

To configure MAPI for incoming emails:

  1. Ensure that you have MAPI installed on the VMware Service Manager Web server.
  2. Install the MAPI package provided by VMWare Customer Support. (Version 8 only, Version 9 has MAPI included as part of the base install)
  3. Configure any registry keys to use with the DLLs provided in the Service Manager MAPI package.
  4. Stop the polling service.
  5. Ensure that the Service Manager messaging service is using a log in account that has access to the MAPI Incoming Email account to be used within Service Manager.
  6. Create any MAPI profile(s)
  7. Use Service Manager to set up the MAPI Incoming Email account within the Email Settings window in System Administration.
  8. Restart the polling service.
  9. Run the email test application provided by VMWare Customer Support to perform a preliminary check on the configured settings to run MAPI.
  10. Perform an actual test using the Incoming Email account created in Service Manager.

Detailed steps

Obtaining MAPI for Incoming Email

MAPI is already available on the Service Manager Web server that has Outlook, Exchange Server, or Exchange Admin installed.

If you do not have any of these applications installed on , you need to download and configure the standalone version of MAPI from the Microsoft website. (Search for "Microsoft Exchange Server MAPI Client and Collaboration Data Objects 1.2.1" to obtain the executable)
 
When you have a version of MAPI on the Service Manager Web server, contact a VMware Support and quote this Knowledge Base article ID for the Service Manager MAPI package.

About the Service Manager MAPI Package (V8 ONLY)

You must install the following DLLs to set up MAPI for incoming emails:

  • Interop.Redemption.dll
  • MailBee.NET.dll
  • IN_MAIL80.dll
  • Redemption.dll
  • mailTest.exe
These are available within the Service Manager MAPI package. 

Applying the MAPI package on your system

To apply the MAPI package on your system:
  1. Stop the VMware Service Manager messaging service.
  2. Copy the mailTest.exe file to InstallDrive:\Program Files\Infra\infraEnterprise8.

    Note: This is a test tool that you may need to use and is not a part of the functionality.

  3. Back up the existing Redemption.dll, MailBee.Net.dll, Interop.Redemption.dll, IN_MAIL80.dll files located at InstallDrive:\Program Files\Infra\infraEnterprise8\ and InstallDrive:\Program Files\Infra\infraEnterprise8\<System Name>\Bin.
  4. Copy the new Redemption.dll, MailBee.Net.dll, Interop.Redemption.dll, and IN_MAIL80.dll files to InstallDrive:\Program Files\Infra\infraEnterprise8\ and InstallDrive:\Program Files\Infra\infraEnterprise8\<System Name>\Bin.
  5. Register Redemption.dll:
    1. Click Start > Run, type cmd and click OK.
    2. Navigate to InstallDrive:\Program Files\Infra\infraEnterprise8.
    3. Run this command:

      regsvr32 Redemption.dll

      A dialog appears indicating the dll has been successfully registered.

  6. Restart the Service Manager messaging service.

Configuring Registry Keys for Service Manager Mail

The MAPI package for Service Manager indicates that your system uses the supplied Redemption DLL for incoming email and MailBee DLL for outgoing email. These are provided in the MAPI package and must be copied into the Service Manager directory.

All registry entries for Service Manager mail are configured in the HKLM\SOFTWARE\Infra\IN_MAIL registry key. All registry entries are of String type. You can configure the following registry entries for MAPI:

  • UseMailBeeForPop3 - A value of 1 uses POP3 for Incoming Email (via MailBee) instead of MAPI, which uses Redemption. By default, this value is 0 and uses MAPI.
  • EmptyTrash - A value of 1 empties deleted mails as soon as a message is deleted. By default, this value is 0 and moves any deleted mail to the Deleted Items folder of the mail account.
  • SecureSMTP - Set this value to 0.

If you do not use authentication for outgoing emails, you must also create the registry string SMTPNoAuth and set its value to 1.

Stopping the polling service

Before continuing, you must stop the Service Manager polling services. To do this, stop the VMware Service Manager 8.00 administrative service. This prompts you to stop all other dependent polling services.

Configuring the Service Manager messaging service

To use MAPI for incoming emails, the Service Manager messaging service must run as an account that has access to the user assigned to the MAPI Incoming Email.

This is a normal Windows account that has access to the mailbox. Full access to the MAPI Incoming Email account is required.

To do this:

  1. Open the VMware Service Manager 8.0.0 messaging Service. You can do this via Control Panel > Administrative Tools > Services.
  2. Click the Log On tab.
  3. Enter the details of the mail account you want to use. Ensure that this account has full access to the MAPI user account you want to specify in Service Manager.

    Note: As the services run under one process, you need to set each polling service account to use the same log in account. This means that if you are using DB NT Auth with SQL Server, the MAPI account must have appropriate access to the Service Manager database.

  4. Click OK.

Note: If you have a MAPI Incoming Email account within Service Manager, you cannot have any other Incoming Email accounts using POP3 and vice versa. This is a technical limitation of the product. You can, however, have both MAPI and IMAP Incoming Email accounts configured within Service Manager.

Creating MAPI Profiles

If you have Outlook installed on the Web server, you can add MAPI profiles using Mail settings in the Control Panel.

Note: If you are using Exchange as a mail server, you need not create a MAPI profile for the Incoming Email account. In such a case, ignore the following steps.

To set up profiles:

  1. Open the mail settings. You can do this via Control Panel > Mail. This displays the Mail Setup dialog.
  2. Click Show Profiles.
  3. Add the MAPI profile.

If you do not have Outlook installed, follow the instructions to create profiles in the Microsoft Knowledge Base article 306962. The Profman2 example should provide you the ability to create profiles assuming that you have the MAPI client installed already on the app server.

Note: You may need to log in to the server as the user (the Profile you created) who is running the services. This is to create a Windows profile on the server. Also note that if the MAPI account has more than one mailbox, the default folder is used to retrieve email.

Setting up the MAPI Incoming Email account in Service Manager

In the Email Settings window in System Administration, create a new Incoming Email account.

Note: If you have a MAPI Incoming Email account within Service Manager, you cannot have any other Incoming Email accounts using POP3 and vice versa. This is a technical limitation of the product. You can, however, have both MAPI and IMAP Incoming Email accounts configured within Service Manager.

Note: If using MAPI for incoming emails, you can no longer use the Test button on the Email Settings window.

If you are using Exchange as a mail server, ensure that the Incoming Email account has the following (to avoid the need to create a MAPI profile for this user):

  • Under Protocol you must specify POP3. This is because, the MAPI module replaces the POP3 functionality with MAPI functionality.
  • The User ID field should specify the name of the user who must log in to the account (this is the same as the user specified on the Service Manager messaging service).
  • The Server field should specify the location of the mailserver.
  • No value is required in the Password field.

If you are using another mail server, ensure that the Incoming Email account has the following (a MAPI profile is required):

  • The User ID field should specify the MAPI Profile name on the machine where the Service Manager messaging service runs.
  • No value is required in the Server field.
  • No value is required in the Password field.

Notes:

  • With a Service Manager server that does not have profiles installed (Exchange mailserver only), you must set the Server Name and the UserID in Incoming Email.
  • With a system that does have profiles installed, the Server Name is not required in Incoming Email and the User ID must be the name of the profile.

Restarting the Polling Service

Before you test your MAPI Incoming Email configurations for Service Manager, you must restart the Service Manager polling service.

Running the Service Manager Test Application

You can use the mailTest.exe program to test if your MAPI configurations are correct.
 
To run the Service Manager Test application:
  1. Save the mailTest.exe file to the Service Manager installation directory in which you copied the other Mail DLLs.
  2. Open the mailText executable file and enter the information you provided in the Incoming Email account:

    1. If required, enter the server location in the Server field.
    2. Enter the user in the User field.
    3. Leave the Password field blank.

  3. Click Connect POP3/MAPI. Any email retrieved appears on the right side of the window.
Note: The mailTest application may display a dialog that asks you if you want to use the profile specified in the user account. This may occur when creating a new Windows profile. If this occurs, click OK. This dialog no longer appear when using MAPI.

When the test application is complete, VMware recommends you to test Incoming Email on Service Manager.

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 4 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.
What can we do to improve this information? (4000 or fewer characters)
  • 4 Ratings
Actions
KB: