5000 UVM E-Mail Synchronization Administrator Guide
5000 UVM E-Mail Synchronization Administrator Guide
5000 UVM E-Mail Synchronization Administrator Guide
5000 COMMUNICATIONS
PLATFORM (CP)
For additional information and/or technical assistance in North America, certified technicians may contact:
Mitel Networks Corporation
Technical Support Department (USA)
1146 North Alma School Road
Mesa, AZ 85201
1-888-777-EASY (3279)
Trademarks
Mitel, 5000 CP, Inter-tel Axxess, SX-200, and SUPERSET are trademarks of Mitel Networks Corporation.
Adobe Acrobat Reader is a registered trademark of Adobe Systems Incorporated.
Mitel® is a registered trademark of Mitel Networks Corporation.
Inter-Tel® is a registered trademark of Inter-Tel (Delaware), Incorporated.
All other trademarks mentioned in this document are the property of their respective owners, including Mitel
Networks Corporation and Inter-Tel (Delaware), Incorporated. All rights reserved.
ii
Contents
Contents
Overview 1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
E-Mail Synchronization Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Capacities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Features 7
Feature Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
E-Mail Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuring E-Mail Synchronization with Microsoft Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . 8
E-Mail Synchronization E-mail Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Welcome Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
New Voice Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Voice Message Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Voice Message Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Synchronize MWI with E-Mail Client Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Programming 15
Diagnostics 21
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Troubleshooting 23
Troubleshooting Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
E-mail Client Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page v
Contents
Page vi UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Overview
Overview
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
E-Mail Synchronization Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Capacities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 1
Overview
Introduction
Introduction
E-Mail Synchronization for Unified Voice Messaging (UVM) is a software application that
integrates the Mitel® 5000 Communications Platform (CP) embedded voice mail function with a
specified external e-mail server. This gives E-Mail Synchronization users the option to access,
play, and manage their voice mail messages directly from their computer or Blackberry® e-mail
client application. Each UVM voice mail message received by the user can also be delivered as
an audio file attachment within an e-mail message sent to the user. For more information about
e-mail client integration, see page 8.
Page 2 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Overview
E-Mail Synchronization Levels
BlackBerry
Forward Forward Enhanced
Feature Enhanced
Only and Copy Integration
Integration
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 3
Overview
Requirements
Requirements
The E-Mail Synchronization system and user requirements are described below.
System Requirements
The following are system requirements for the “enhanced” E-Mail Synchronization levels:
• Mitel® 5000 Communications Platform (CP) v6.0 or later.
• An IMAP-compliant, version 4 e-mail server.
• The appropriate software licenses (see page 5).
User Requirements
To access all E-Mail Synchronization features and functionality, users must have an e-mail
account with the company’s e-mail system and a voice mailbox on UVM.
The user requires one of the following hardware devices (and associated software applications)
to access E-Mail Synchronization features and functionality:
• A computer with:
o Network access.
o A compatible e-mail client.
o 20 MB available hard disk space.
o A monitor, mouse, and keyboard.
o A sound card and speakers (or headset/headphones).
o A media player that can play WAV files encoded as 8-bit, 8 kHz, mono, and mu-law or
MPEG-1 Audio Layer 3 (MP3) files.
• A mobile device with:
o Network access.
o A compatible e-mail client.
o A media player that can play WAV or MP3 files.
See page 5 for the e-mail servers that have been validated to interoperate with E-Mail
Synchronization.
To ensure that users have the information they need to use E-Mail Synchronization features,
refer to Table 2 when you add E-Mail Synchronization users to the system.
E-Mail Synchronization
Required Information.
Feature
E-Mail Synchronization Inform users which E-Mail Synchronization level they are configured for (see page 2):
Level • Forward Only and Forward and Copy: Users do not receive a Welcome
message.
• Enhanced Integration and BlackBerry Enhanced Integration: Users receive a
Welcome e-mail message that includes the synchronization type (level).
Page 4 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Overview
Software Compatibility
Software Compatibility
The “enhanced” levels of E-Mail Synchronization for UVM have been validated to work with the
following IMAP-compliant e-mail servers:
• Microsoft® Exchange 2003, 2007, or 2010
• IBM® Lotus® Domino® v8.5
• Novell® GroupWise® v7.0
• Google Gmail
• Microsoft® Office 365
Consult with your e-mail system administrator about message size limitations
IMPORTANT and e-mail policies to determine the possible impact to E-Mail
Synchronization users.
Capacities
E-Mail Synchronization for UVM supports up to 100 enhanced integration voice mailboxes on
5000 CP systems that are not equipped with a PS-1 and up to 250 enhanced integration voice
mailboxes on systems equipped with a PS-1.
Licensing
To use the Enhanced Integration and/or Blackberry Enhanced Integration E-Mail
Synchronization levels, the 5000 CP must be equipped with the appropriate system license(s),
as listed in Table 3.
Note that the Enhanced Integration license allows the MP3 file attachment option to be used
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 5
Overview
Licensing
Page 6 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Features
Features
Feature Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
E-Mail Client Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuring E-Mail Synchronization with Microsoft Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . 8
E-Mail Synchronization E-mail Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Welcome Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
New Voice Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Voice Message Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Voice Message Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Synchronize MWI with E-Mail Client Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 7
Features
Feature Summary
Feature Summary
E-Mail Synchronization provides access to voice mail messages through the user’s e-mail client
(see page 8). For detailed information about how to use this feature, refer to the UVM E-Mail
Synchronization User Guide (part no. 835.3287). For detailed information on programming E-
Mail Synchronization, see page 16.
Voice Messages
Page 8 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Features
Configuring E-Mail Synchronization with Microsoft Office 365
4. In the left-side navigation pane click Users&Groups, and then click Distribution Group.
5. Click New. . ..
The New Group dialog box displays.
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 9
Features
Configuring E-Mail Synchronization with Microsoft Office 365
If the WinRM service is already running, you don't have to start it. You can check
the status of the WinRM service by running the command sc query winrm.
In the results, look for the value Basic = . If the value is Basic = false, you
NOTE
must change the value to Basic = true as follows:
winrm set winrm/config/client/auth @{Basic="true"}
In the command output, verify the value Basic = true.
Import-PSSession $Session
11. Run the following command:
Add-RecipientPermission <identity> -AccessRights SendAs -Trustee
<user>
Where <user> is the administrator name as displayed in Step 6, <identity> is the alias
name ("NoReplyWelcome" in the example above).
12. Switch back to the Office 365 Server configuration window (or log back in if necessary).
13. In the left-side navigation pane click Settings, the click Mail.
Page 10 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Features
E-Mail Synchronization E-mail Messages
Welcome Message
After you configure the user’s account for Enhanced Integration or BlackBerry Enhanced
Integration, they receive a Welcome e-mail message. Welcome e-mail messages contain the
following information:
• From: The “From” address is NoReplyWelcome@<server name>.com, where server
name is the name of your voice mail server.
• Sent: Includes the day, date, and time the message was sent by UVM.
• To: The “To” address is the user’s e-mail address for voice messages as configured in DB
Programming. For example, [email protected].
• Subject: The subject of this message is Welcome to Mitel’s E-Mail Synchronization.
The Welcome e-mail contains basic account information and indicates the user’s
synchronization type, which corresponds to the E-Mail Synchronization level the account is
configured for (see page 2).
Options include:
• Enhanced Integration
• BlackBerry Enhanced Integration
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 11
Features
Error Message
Error Message
Error messages indicate that E-Mail Synchronization encountered a problem delivering a voice
message. Error messages contain the following:
• From: The “From” address is NoReplyError@<server name>.com, where server name
is the name of your voice mail server.
• Sent: Includes the day, date, and time the message was sent by UVM.
• To: The “To” address is the user’s e-mail address for voice messages as configured in DB
Programming. For example, [email protected].
• Subject: The subject of this message is Error Synchronizing UVM Mailbox. Additional
error text is available in the body of the message.
See page 24 for a troubleshooting table that provides a list of error messages, the possible
causes, and corrective actions.
Consult with your e-mail system administrator about message size limitations
IMPORTANT and e-mail policies to determine the possible impact to E-Mail
Synchronization users.
Page 12 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Features
Voice Message Synchronization
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 13
Features
Synchronize MWI with E-Mail Client Option
Page 14 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Programming
Programming
Programming E-Mail Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Programming Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Programming System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 15
Programming
Programming E-Mail Synchronization
Programming Users
To program users for E-Mail Synchronization, in 5000 DB Programming go to Voice Processor –
Devices – Mailboxes – <mailbox>.
The first field in the E-Mail Synchronization folder is the E-Mail Synchronization Level. The level
that is programmed in this field specifies the E-Mail Synchronization level of integration. Note
that prior to the 5000 CP v5.0 release, UVM only supported the Forward Only and Forward and
Copy levels. To enable the other levels for UVM, the system must be equipped with v5.0 or later
software.
The E-Mail Synchronization level you select determines which additional fields in the E-Mail
Synchronization folder are programmable. See page 17 for programming instructions and field
descriptions.
Table 4 indicates which fields in the E-Mail Synchronization folder must be programmed for
each E-Mail Synchronization level. The field appears with a red “X” if it is not supported by a
specific level.
Page 16 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Programming
Programming Users
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 17
Programming
Programming Users
• E-mail Account Folder for Synchronization: Indicates the path to the account
folder (such as Inbox, Voice Mail, etc.) on the e-mail server to use for message
synchronization. The folder name can be up to 127 characters. For example, to
synchronize messages to the folder named “Voice Mail” in the user’s e-mail client
account, type Voice Mail in the text box. To synchronize messages to the subfolder
named “VM” under the “Inbox” main folder, type Inbox/VM in the text box. This
field is set to Inbox by default.
If you are configuring multiple voice mailboxes to synchronize with a single e-mail
account, only one voice mailbox can synchronize with the default Inbox folder.
Users must create separate folders in their e-mail client for each voice mailbox they
want to synchronize.
NOTICE
Possible Data Loss. Changing the E-mail Account Folder for Synchronization to
anything other than “Inbox” when the account is setup for BlackBerry Enhanced
Integration may result in the deletion of messages. To support integration into
folders other than the “Inbox” folder, the user must set up message routing rules
at the e-mail server (server-based rules) so that voice mail messages that are
sent using BlackBerry Enhanced Integration will be routed into the expected
folder. For information about setting up server-based rules, refer to the
appropriate e-mail server’s guide or Help.
• E-mail Server: Indicates the name of the e-mail server for the account
synchronization. The server name can be up to 127 characters. This field is blank
by default.
• E-mail Account Password: Indicates the password of the account to use for
message synchronization. This is the user’s network password. The password can
be up to 40 characters.
• E-mail Account Username: Indicates the user name of the account to use for
message synchronization. This is the user’s network username. The username can
be up to 127 characters. This field is blank by default.
• E-mail Address for Voice Messages: Specifies the e-mail address to which the
voice mail messages will be forwarded. This is also the e-mail address where
welcome and error e-mails are sent for the Enhanced Integration and BlackBerry
Enhanced Integration E-Mail Synchronization levels. The content and format of the
field depends on the e-mail system being used. The address can be up to 127
characters. If you enter an invalid character (: ; “ \ | ( ) , < > ‘), an error tone occurs.
For example, when using Lotus Notes, this field could be set to John Doe/
Chandler/Mitel, and when using e-mail, it would be [email protected].
• E-mail Client Message Format: Specifies the format (WAV, MP3, or NONE) of the
file attached to the e-mail message. It is set to WAV by default. If set to NONE, the
user receives an e-mail message with the callback information from the system’s
programmed Message Notification/Retrieval Application and must call into the
system to retrieve the voice mail message.
Unless the user’s client application supports only MP3 files, Mitel
NOTE
recommends using the WAV file setting only.
Page 18 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Programming
Programming System Settings
The E-Mail SMTP Server field must use a fully-qualified domain name
NOTE
(FQDN) and not an IP address.
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 19
Programming
Programming System Settings
Page 20 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Diagnostics
Diagnostics
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 21
Diagnostics
Introduction
Introduction
For field technicians and system administrators who already trained on and familiar with using
the AvdapMon utility described in the Voice Processing Diagnostics Manual (document part no.
550.8019), this section describes additional diagnostic commands and logging options available
for the UVM E-Mail Synchronization application.
Commands
There is a new “U” character command. When “U” is entered at the AVDAPMON command line,
you are prompted with: UM Command?. The valid Unified Messaging (UM) Commands are:
• stop=xyz or stop=*
• start=xyz or start=*
• enable_error_msgs=xyz or enable_error_msgs=*
• disable_error_msgs=xyz or disable_error_msgs=*
• debug_level=xyz or debug_level=*
Where “xyz” is a specific mailbox number and “*” is a wildcard that includes all mailboxes.
The stop= command stops the account(s) from actively synchronizing voice mail messages.
The start= command starts or re-starts the account(s) that has (have) stopped synchronizing.
The enable_error_msgs= command enables the account(s) to receive error messages as e-mail
messages when something fails in the synchronization process. For example, if the
synchronization process cannot log on to the configured e-mail account, an error message is
sent to the e-mail account.
The disable_error_msgs= command disables the ability to receive error messages. (By default,
error messages are enabled.)
The debug_level= command changes the type of debug information that is displayed for the
account(s). After entering this command, you are prompted with: DebugLevel (0, 1, 2, or 3)?.
Enter:
• 0 to turn off logging
• 3 to turn on logging (logs all of the IMAP interaction between UVM and the remote IMAP
server)
Levels 2 and 3 are not currently used.
Page 22 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013
Troubleshooting
Troubleshooting
Troubleshooting Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
E-mail Client Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013 Page 23
Troubleshooting
Troubleshooting Summary
Troubleshooting Summary
This section describes troubleshooting issues for E-Mail Synchronization. If you cannot resolve
an issue after reviewing this information, contact your local authorized Mitel provider for
assistance.
Instruct users to not move voice messages from the specified folder in their e-mail
NOTES clients (see page 18). If users move voice messages from this folder, the
messages may be deleted from UVM.
Symptom/
Possible Cause Correction Action
Error Message
The user receives a The e-mail Large messages can be rejected due to
voice message with the attachment is larger limitations imposed by the e-mail server
following note: than the file size configuration.
“There was an error limitation set for the
appending this user’s e-mail
message. Check account on the e-
message size to see if mail server.
it exceeds your e-mail
server's configured
limit.”
The user receives an The user’s e-mail Verify that the proper e-mail user name and
error synchronizing credentials are password are programmed for the user (see
mailbox account incorrect. Or, the page 18). Ensure that the IMAP server is on
message with the IMAP server is off line.
following text: line or in the
“Error logging into: process of a
<user name>.” reboot.
The user receives an Not all of the Verify that the following fields are
error message with the required fields are programmed properly in DB Programming:
following text: configured for the • E-mail Server (page 18)
“Not all required e-mail server.
attributes for remote • E-mail Account Username (page 18)
server are populated • E-mail Account Password (page 18)
for: MB<xxxx>.”
• E-mail Account Folder for
Synchronization (see page 18)
The user receives an The E-mail Account Program this field with the proper folder
error message with the Folder for name.
following text: Synchronization
“Error selecting folder: field is not
Inbox/<folder name>.” programmed with
the proper folder
name.
Page 24 UVM E-Mail Synchronization Administrator Guide – Release 6.0, September 2013