Avaya Solution & Interoperability Test Lab Configuring Avaya Aura Messaging R6.1 connectivity with IBM Lotus Notes R8.5 IMAP4 based Email Client using SSL Issue 1.0 Abstract These Application Notes present a sample configuration of a network consisting of a Centralized Avaya Aura Messaging solution supporting IBM Lotus Notes as an IMAP4 Email client. Testing was conducted via the Internal Interoperability Program at the Avaya Solution and Interoperability Test Lab. 1 of 42
1. Introduction These Application Notes were created to document the validated interoperability of Avaya Aura Messaging with IBM Lotus Notes email client using Internet Avaya Aura Message Access Protocol Version 4 (IMAP4) over the SSL (Secure Socket Layer) protocol connection. The SSL connection is created based on the negotiation/handshake between Avaya Aura Messaging and the Email Client. With the appropriate Email and Messaging settings, Avaya Aura Messaging subscribers can use standards-based email clients to receive, send, delete, purge and manage messages from a desktop computer. Subscribers can gain access to messages and deal with those messages by using any email clients of Standards based IMAP4. IMAP4 based email clients access and act on the message stored on the message store server in similar way as with the actions of other clients/tools such as the Telephone User Interface (TUI). For example, if both TUI and email client accessed/displayed the message that is on the Messaging then if a message is deleted by using a TUI the IMAP4-supporting email client would no longer display or retrieve that message. IBM Lotus Notes 8.5 can be configured as such an email client and these Application Notes describe how to achieve this. 2. Interoperability Testing The general test approach was to configure an Avaya SIP telephony solution that would support a third party IMAP4 based email application over an SSL connection. The third party application in this case was IBM Lotus Notes email client. The main focus was on the Messaging capability to support subscribers with the ability to manipulate voicemail messages by using an email client. The Lotus Notes configuration on these Application Notes was based on setting the mail file location as local rather than server. This allows cache version to be created locally on the user s personal computer. 2.1. Test Description and Coverage The interoperability test areas included the following: Basic calls with voicemail messages Subscribers ability to access/login to the Messaging Voicemail notification sent to subscriber via email Voicemail attachment (.wav files) to sent/generated notification Email MWI behavior upon email manipulation Email (mailbox) behavior upon deletion via TUI Voicemail (on storage server/messaging) behavior when deleted via Email client Forwarding of email with attached voice message file Forwarding of email with message attachment from TUI Sending of plain text (email) messages between subscribers/email accounts 2 of 42
2.2. Test Results and Observation Interoperability testing of the sample configuration was completed with successful results for the Messaging support of IBM Lotus Notes IMAP4 based email client. However, one observation was made with Lotus Notes email client whereby it appear to keep a cached version for every new voicemail retrieved. As a result when a voicemail is deleted via TUI (Telephone User Interface) Lotus Notes client only removes the attachment but appears to keep the text i.e. the email part of it. It is worth noting that the attachment is essentially the actual voicemail. Additionally it was noted that the Inbox did not automatically delete this leftover email either. On further investigation it was discovered that the normal refresh methods (clicking the refresh icon on screen or pressing F9) would not update the inbox to reflect the message had been listened to and deleted via the TUI. However it was discovered that by performing Action Refresh Summaries from the Menu bar within IBM Lotus Note Client would refresh the Inbox correctly and remove the email relating to the deleted voicemail. This issue was raised with IBM and after further investigation it was determined as previously known design limitation within their software. The details of this issue has been logged against their reference SPR AJES7XGPHL.IBM also advise this issue has been ongoing since version6.0 of Lotus Notes client. 3 of 42
3. Reference Configuration The sample network configuration used is illustrated in Figure 1, where SIP and H.323 handsets are used to generate calls for voicemail into Messaging. References [1], [2] and [3] in Section 9 describe how to install and provision stations on Communications Manager and Session Manager that would enable using Messaging for voice messages. Therefore, these Application Notes do not describe the whole integration of Messaging and Communication Manager as well as Session Manager but rather focus on Messaging and IBM Lotus Notes Email Client integration. These Application Notes also assume that IBM Lotus Notes client has been installed on a computer according to the installation instructions provided by IBM. The Lotus Notes configuration in these Application Notes are based on setting the mail file location as local rather than server. This allows cache version to be created locally on the user s personal computer. Figure 1: Network Setup for Avaya Aura Messaging and IBM Lotus Notes IMPA4 Email Client 4 of 42
4. Equipment and Software Validated The following equipment and software were used for the sample configuration provided: Equipment Avaya Aura Communication Manager running on Avaya S8800 Server Avaya Aura System Manager running on Avaya S8800 Server Avaya Aura Session Manager running on Avaya S8800 Server Avaya Aura Messaging running on Avaya S8800 Server Avaya G650 Media Gateway Software R6.2.0 Build/CM_Simplex R016x.02.0.823.0 VSP: 6.2.0.0.27 R6.2.0 SP1 Build No. - 6.2.0.0.15669-6.2.12.105 Software Update Revision No: 6.2.13.1.1871 VSP: 6.2.0.2.27 R6.2.1.0.621007 VSP : 6.2.0.2.27 R6.1-11.0 655A (Power Supply) TN2312BP HW28 FW054 (IP Service Interface) TN799DP HW16 FW040 (C-LAN) TN2602AP HW08 FW062 (IP Media Processor) TN2464CP HW13 FW025 (DS1 Interface) SIP Firmware S96x1_SALBR6_0_3_V470.tar H.323 Firmware ha96xxua3_11.bin Avaya Handset 9621G Avaya Handset 9650 IBM Lotus Notes R8.5.3 Revision 20110916.0921 on Windows 7 5 of 42
5. Configure Avaya Aura Messaging Messaging was configured for SIP communication with Session Manager. The procedures include the following areas: Administer Sites Administer Class Of Service Administer Telephony Integration Administer Subscribers See reference [4] in Section 9 for standard installation and configuration information. General knowledge of the configuration tools and interfaces is assumed. 5.1. Administer Sites A Messaging Pilot number and a Messaging Auto Attendant number need to be defined for every site. Log into the Messaging System Management Interface (SMI) and navigate to Administration Messaging. In the left panel, under Messaging System (Storage) select Sites. In the right panel fill in the following: Under Main Properties: Messaging access number (external) Enter a Messaging Pilot number Message access number (internal) Enter a Messaging Pilot number Subscriber number length Set the digit length. In this example it s set to 5 6 of 42
Under Site Internal Dial Plan: Short extension length Set the extension length. In this example set to 5 Short mailbox length Set the extension length. In this example set to 5 5.2. Administer Class Of Service Log on to the Messaging System Management Interface (SMI) navigate to Administration Messaging. In the left panel, under Messaging System (Storage) select Class of Service. In the right panel fill in the following: Class of Service: Under General: IMAP4/POP3 access Set the Class of Service that is currently being used; in this example it was set to Standard Ensure is set to Full Set Message Waiting Indicator (MWI) on user s desk phone Ensure this check box is ticked 7 of 42
Under Greetings: Two greeting (different greetings for busy and no-answer) Ensure this radio button is checked/selected Maximum length Set the maximum greetings length Under Notifications: Allow text message (or page) notification Set to Yes Allow outcalling notification Select Yes Allow email notification Select Yes, with or without recording Click Save to save changes. 8 of 42
5.3. Administer Telephony Integration A SIP trunk needs to be configured from Messaging to Session Manager. Log into the Messaging System Management Interface (SMI) and navigate to Administration Messaging. In the left panel, under Telephony Settings (Application) select Telephony Integration. In the right panel fill in the following: Under Basic Configuration: Switch Integration Type: Under SIP Specific Configuration: Transport Method Connection 1 Messaging Address SIP Domain Click Save to save changes. SIP TCP Enter the Session Manager signaling IP address and TCP port number Enter the Messaging IP address and TCP port number Enter the Messaging and Session Manager domain names 9 of 42
5.4. Administer Subscribers Log into the Messaging System Management Interface (SMI) and navigate to Administration Messaging. In the left panel, under Messaging System (Storage) select User Management. To Add a new User, click on the Add button. This will open the Properties for New User screen. In the New User screen enter the following details: Under User Properties: First Name Enter first name Last Name Enter last name Display Name Enter display name ASCII Name Enter a suitable Name Site Enter site name, in the example Default was used Mailbox Number Enter desired mailbox number e.g. 42215 Internal Identifier This will form the the email address for the mailbox, so may be entered in the format firstname.lastname.the @domain will be added after the mailbox has been saved. Extension Enter desired extension number e.g. 42215 Class Of Service Select a Class Of Service Pronounceable Name Enter a pronounceable name to be used when dialing the extension using voice commands MWI Enabled Enable MWI light New Password/Confirm Password Enter desired extension password Click Save to save changes.(full Screen shot on following page) 10 of 42
11 of 42
Once the Mailbox has been saved, further configuration is necessary under User Preferences. To access the User Preferences, scroll to the bottom of the Mailbox settings screen. This area can be found underneath the Reset button. Hover the mouse over the line Open UserPreferences for <extension number> until the line changes colour and click. 12 of 42
Once the user Preferences screen has opened click Notify Me Under Email Notifications: Email me a notification for each voice message Ensure this box is ticked To email address Type the email address e.g., 42215.42215@mango61.mmsil.local Include the recording Ensure this check box is ticked Click Save. Repeat this section for all phones that will use Messaging for voice messaging services. 13 of 42
6. Configure IBM Lotus Notes 6.1. Initial Lotus Notes Client Configuration From the top bar of Lotus Notes click File Preferences 14 of 42
On the Preferences screen, select Basic Notes Client Configuration followed by Client Reconfiguration Wizard and click OK. The first step in the Wizard will appear. Under Additional Services check Internet mail server (POP or IMAP, SMTP) and click Next. 15 of 42
Under Set Up Internet Mail Select the type of server used for retrieving incoming mail Set to IMAP Incoming mail server Enter Messaging storage server FQDN name or IP, e.g. Mango61.mmsil.local or 10.10.9.25 Click Next. 16 of 42
On the Set Up Internet Mail screen add the following settings: Account name Enter the subscriber s account name e.g., 42215 Password Enter the password as provisioned on the Messaging Log on using SSL Ensure this box is not checked for now as SSL connection will be activated later on in these application notes Click Next. 17 of 42
For the Outgoing SMTP mail server enter the FQDN name or IP address; in the example, Messaging FQDN (mango61.mmsil.local) is used. Alternatively the IP Address of the Messaging server may be entered. Click Next Note: In this reference configuration Messaging was used as the Outgoing mail (SMTP) server. This will allow users to forward emails to other subscribers IMAP email accounts. The Messaging was also used as Message Storage Server. Lotus Notes Client may also be configured to use an existing corporate (i.e., external) email system. 18 of 42
Enter the E-mail address associated with the subscriber account. In this example the E-mail address used was 42215.42215@mango61.mmsil.local. Enter the Internet domain and click Next. This will return the user to the Preferences Screen. 19 of 42
Click OK to complete. 20 of 42
To ensure an Internet Mail box can be opened at this stage click Open Applications Incoming Internet mail. If desired, a test voicemail can be left in the voicemail box for the extension to check connectivity with Messaging. (Also see Section7 Verification ). After a minute the corresponding email containing the voicemail message should appear in the Incoming Internet Mail box. The next steps will cover configuring the voicemail box for SSL. 6.2. Activating SSL To activate the SSL connection between the client and server for the newly created account.take the following steps: Navigate to Open Contacts. 21 of 42
Click Advanced. Double-click on Incoming Internet mail. 22 of 42
Click Edit Account to enable modifying the settings. 23 of 42
Under the Basics tab set SSL to Enabled. 24 of 42
Click on the Advanced tab Accept SSL site certificates Set to Yes Accept expired SSL certificates Set to Yes Send SSL certificates when asked (outbound connections only) Set to Yes Verify account server name with Remote server s certificate Set to Enabled SSL protocol version Set to Negotiated. This will enable client to negotiate between using either of version 2 or 3, or combination version 3 with 2 handshake Click Save & Close. 25 of 42
To configure the SSL Settings for Outgoing Internet Mail is very similar. From the Contacts Advanced screen double-click on Outgoing Internet mail (screen not shown) followed by Edit Account button. Under the Basics tab set SSL to Enabled. 26 of 42
Under the Advanced tab Accept SSL site certificates Accept expired SSL certificates Send SSL certificates when asked (outbound connections only) Verify account server name with Remote server s certificate SSL protocol version Click Save & Close. Set to Yes Set to Yes Set to Yes Set to Enabled Set to Negotiated. This will enable client to negotiate between using either of version 2 or 3, or combination version 3 with 2 handshake 27 of 42
6.3. Configuration of IMAP and SMTP with SSL The second phase of IMAP and SMTP credentials set up is done as follows. Navigate File Preferences Accounts. Double click on Incoming Internet Mail. Under Basics Account Name Enter Account Name or leave as default e.g., Incoming Internet mail Type Set to IMAP Online (SSL Enabled) Server Enter the IMAP email server, e.g., mango61.mmsil.local or 10.10.9.25 Under Log in information Name Enter the account login credentials to an IMAP server, e.g., 42215 Password Enter password (same used to access voicemail box in Messaging) Under Advanced properties Accept SSL site certificates Set to Yes Send SSL certificates when asked (outbound connections only) Set to Yes Verify account server name with remote server s certificates Set to Enabled SSL protocol version Set to Negotiated (Screen shot on next page showing these settings) Click OK. The user will be returned to the Accounts screen (not shown) 28 of 42
29 of 42
To configure the SMTP credentials double click on Outgoing Internet Mail on the Accounts screen. Under Basics Account Name Enter Account Name or leave as default e.g., Outgoing Internet mail Type Set to SMTP (SSL Enabled) Server Enter the IMAP email server, e.g., mango61.mmsil.local or 10.10.9.25 Under Log in information Name Enter the account login credentials to an IMAP server, e.g., 42215 Password Enter password (same used to access voicemail box in Messaging) Under Advanced properties Accept SSL site certificates Set to Yes Send SSL certificates when asked (outbound connections only) Set to Yes Verify account server name with remote server s certificates Set to Enabled SSL protocol version Set to Negotiated (Screen shot on next page showing these settings) Click OK. The user will be returned to the Accounts screen (not shown) 30 of 42
31 of 42
On the Accounts screen click OK to confirm the created IMAP/SMTP client credentials. 32 of 42
The final stage is to configure the Online location.to set the Mailbox to be on the local PC and to set the final SSL settings. To configure the settings for the online location click File Locations Manage Locations.Highlight the location Online. Click Edit to edit profile for the Online location 33 of 42
Under the Basics tab Location name Location type Internet mail address Enter location name, e.g., Online Select appropriate location, e.g. Local Area Network Enter email address, e.g., 42215.42215@mango61.mmsil.local Under the Servers tab Home/mail server Enter mail server used, e.g., 10.10.9.25 Passthru server Enter passthru server, e.g., 10.10.9.25 34 of 42
Under Ports tab ensure TCPIP box is ticked to allow TCP to be used for initial connection opening between client and server. Under Mail tab Mail file location Domino mail domain Set to Local. This will enable email client to locate a mail file on a local machine rather than on a server Enter Messaging FQDNdomain or server IP address, e.g., mango61.mmsil.local Internet domain for Notes addresses when connecting directly to the Internet Enter domain name. In this example the Messaging domain name was entered i.e. mango61.mmsil.local Mail addressing Send outgoing mail Transfer outgoing mail if Set to Local then Server. Set to directly to Internet. This enables use of mail server other than through Lotus Domino server Set to 1. This stands for number of messages that must accumulate before Lotus Notes automatically sends mail out. 35 of 42
Under Replication tab Enable replication Check the box to enable replication Create new replicas Check the Immediately radio button Replication when Notes starts Ensure check box is ticked Replicate when Notes ends Ensure check box is ticked 36 of 42
Click the Advanced tab. Under SSL tab Accept SSL site certificates Accept expired SSL certificates SSL protocol version Select the Yes radio button Ensure the Yes radio button is selected Ensure is set to Negotiated Click OK followed by OK on the Prefences Screen (not shown). This will return the user to the main desktop of Lotus Notes. Close the Notes email application including all the open tabs then re-start the Client software. Once the Notes has started open the Inbox by clicking File Applications Incoming Internet mail. At this stage an SSL connection is created between client and server. Note: To refresh the Inbox, select F9 on the keyboard. In the event of the Inbox not updating accurately, from the menu select Action Refresh Summaries. 37 of 42
38 of 42
7. Verification Steps This section provides verification methods that can be performed on Messaging, and IBM Lotus Notes to verify their working configurations. 7.1. Avaya Aura Messaging Verification To verify basic email interaction between the newly created Lotus Notes email client/account and the Messaging as a server the following steps can be followed for a chosen subscriber. In the example below email client/account for extension 42215 was used. Log on to the Messaging http://messagingip/ with the appropriate login and password then select Administration Messaging under Diagnostics select Mail Delivery then under Mail Delivery Test set the following: Sender Enter the sending extension, in this example 42210 Sender s Password Enter the messaging password associated with 42210 Recipient Enter Recipient s extention, in this example 42215 Click Run Test to enable Messaging to generate a test/diagnostic email to the set mailbox account. If the test is successful then the following Test Results should be displayed on the Messaging test screen as seen below: 39 of 42
A Diagnotics test email message is generated by the Messaging for the mailbox extension 42215. If the setup is correct then IBM Lotus Notes email client should see/retrieve the test email message for extension 42215 as seen below. Note: Just in case, to force new message retrieval (if it does not automatically appear) press F9 button on the keyboard or select Actions Refresh Summaries 7.2. Verification of IBM Lotus Notes upon new Voicemail To verify retrieval of email message by a subscriber (via Lotus Notes email client) when a new voicemail is left on Messaging the outlined steps below can be followed: Dial that subscriber s number and leave a message on their voice mail. Ensure the MWI light on their handset lights up Verify that an email can then be retrieved by that subscriber s Lotus Notes email client. This email will have an attached.wav file containing the voice message Read/play the message and ensure the MWI light on their handset is extinguished The image below indicates an unread message from ext 42216 (email is in red and starred ) and a message from ext 35009 has been read. (black). As Lotus Notes client does not automatically delete the message from the Mailbox when the message has been read and deleted via the Telephone, it is necessary to manually clear these messages from Lotus Notes in one of two ways:- Select Action Refresh Summaries Highlight the message in the Inbox, press the Delete button and then press F9. 40 of 42
8. Conclusion As illustrated in these Application Notes, Avaya Aura Messaging can interoperate, via Avaya Aura Session Manager and Avaya Aura Communication Manager, with IBM Lotus Notes Email client over IMAP4 protocol. Please refer to Section 2.2 for test/observation details. 9. References Product documentation for Avaya products available at http://support.avaya.com 1. Administering Avaya Aura Communication Manager 03-300509 Release 6.2 Issue 7.0 2. Administering Avaya Aura Session Manager 03-603324 Release 6.2 Issue 1.0 3. Maintaining Troubleshooting Avaya Aura Session Manager 03-603325 Release 6.2 Issue 1.0 4. Administering Avaya Aura Messaging Release 6.1 CID: 151610 Product Documentation for IBM Lotus Products may be found at http://www.ibm.com/support/documentation/ 5. IBM Lotus Notes documentation www-10.lotus.com/ldd/dominowiki.nsf 41 of 42
Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by and are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners. The information provided in these Application Notes is subject to change without notice. The configurations, technical data, and recommendations provided in these Application Notes are believed to be accurate and dependable, but are presented without express or implied warranty. Users are responsible for their application of any products specified in these Application Notes. Please e-mail any questions or comments pertaining to these Application Notes along with the full title name and filename, located in the lower right corner, directly to the Avaya Solution & Interoperability Test Lab at interoplabnotes@list.avaya.com 42 of 42