EWS managed API for TypeScript/JavaScript - code ported from OfficeDev/ews-managed-api. availbale for nodejs, browser and mobile devices (cordova).
Pluggable XHRApi adapter to replace client (browser) based XHR call with server brokered call (example coming soon). Example Ruby on rails, PHP or any server side framework where c# or nodejs is not available
Works with Office 365/Exchange Online and on-premises Exchange (2007 - 2016)
- Basic - inbuilt
- NTLM - using XHRApi adapter
- Cookies/FBA Authentication with TMG/ISA - using XHRApi adapter
use SSL for basic authentication
NTLM and Cookies Authentication works with nodejs only
- commonjs module for NodeJs
- AMD module for browser*
All http call is wrapped in promise using WinJS promise.
Code sample from EWS Managed API 2.1. should work with little modificaion to Promise format
Api document generated using TypeDoc and is hosted at ews-javascript-api.github.io/api.
Check Wiki for more details
also track what is coming in backlog, keep eye on milestones when I start working on it
- new: Conversation operations availbale, see MSDN: How to: Work with conversations by using EWS in Exchange
- new: MRM operations now work,
GetUserRetentionPolicyTagsis ready to use see MSDN: GetUserRetentionPolicyTags operation - fix: #60 - use of
Mailboxobject cause error when used withuotreoutingTypeparameter, which should is"SMTP"/nullby default. Constructor overloads have now implemented. - fix: #61 -
AutodiscoverService.GetUserSettingssilently crashs when one of the user is not found in Exchange
- new: InboxRule Operations now works,
GetInboxRulesandUpdateInboxRulesmethods on ExchangeService now availbale see MSDN: How to: Manage Inbox rules by using EWS in Exchange - new: Delegate management operations now work see MSDN: Delegate access and EWS in Exchange
- new: Mailbox synchronization now works,
SyncFolderItemsandSyncFolderHierarchyExchangeService now availbale see MSDN for example - new: Pull Subscription should now work use MSDN example
- new:
SetTeamMailboxandUnpinTeamMailboxExchangeService methods now availbale. (SetTeamMailboxdoes not work with Office 365, Access Denied error, on-prem test is pending) See official MSDN reference for detail ExchangeService.UnpinTeamMailbox method - new:
GetRoomsandGetRoomListsExchangeService methods now availbale. See official MSDN reference for detail ExchangeService.GetRooms method and ExchangeService.GetRoomLists method - new:
ConvertIdandConvertIdsExchangeService methods now availbale, see MSDN detail at EWS Identifiers in Exchange - new:
GetClientAccessTokenExchangeService method now availbale, used with "Mail App" management, App management (#41) coming later - fix:
ImpersonatedUserIdbug #34
- new: Streaming Notification code updated, see issue #24 for example. More details at How to: Stream notifications about mailbox events by using EWS in Exchange
new: Pull Subscription should also work MSDNnot updated yet, pushed to 0.2.8- new:
SearchFiltercode update. See official MSDN link for examples How to: Use search filters with EWS in Exchange - new: Some use of
ExtendedPropertyDefinitionworks, see #23 for an example. - new:
Groupingclass updated, it can be applied onFindItems - new:
AccountLockoutdetection in failed conenction. Does not work with Office 365 - improvements:
Contactobject related code udpate, fix code errors - improvement:
SoapFaultDetailsupdated for improved error handling, most EWS operation not return instance ofSoapFaultDetailsin case of any failure, it containsExceptionproperty with information of failures oe exception in operation. - fix:
FindItemsimprovements- bug fixed where code was not updated to handle correct constructor overload
- SearchFilter can be used
- Grouping can be used
- Appointment/CalendarItem code update
- Appointment can be created using
new Appointment() - Appointment can be saved with
Appointment.Save() - Meeting invitation can be send using
Appointment.Save(SendInvitationsMode.SendToAllAndSaveCopy) - issue - HTML Body is not working using
Appointment
- Appointment can be created using
GetUserOofSettingsandSetUserOofSettingson ExchangeService is ready to be used.- fix: Autodiscover issue fixed, where it throws exception when redirecting to office 365 using 302 redirect from CNAME dns record
- Attachment Operations
- GetAttachment method - load attachment information from Attachemnt or AttachmentId
- Create email message with attachment, sample code in Wiki
[sudo] npm install ews-javascript-api//classic Javascript style var ews = require('ews-javascript-api'); var exch = new ews.ExchangeService(ExchangeVersion.Exchange2013); //ES6 TypeScript style import {ExchangeService, AutodiscoverService, Folder, Item, ExchangeVersion} from "ews-javascript-api"; var exch = new ExchangeService(ExchangeVersion.Exchange2013);//import ews module var ews = require('ews-javascript-api'); //create AutodiscoverService object var autod = new ews.AutodiscoverService(new ews.Uri("https://autodiscover-s.outlook.com/autodiscover/autodiscover.svc"), ews.ExchangeVersion.Exchange2010); //you can omit url and it will autodiscover the url, version helps throw error on client side for unsupported operations.example - //var autod = new ews.AutodiscoverService(ews.ExchangeVersion.Exchange2010); //set credential for service autod.Credentials = new ews.ExchangeCredentials("userName", "password"); //create array to include list of desired settings var settings = [ ews.UserSettingName.InternalEwsUrl, ews.UserSettingName.ExternalEwsUrl, ews.UserSettingName.UserDisplayName, ews.UserSettingName.UserDN, ews.UserSettingName.EwsPartnerUrl, ews.UserSettingName.DocumentSharingLocations, ews.UserSettingName.MailboxDN, ews.UserSettingName.ActiveDirectoryServer, ews.UserSettingName.CasVersion, ews.UserSettingName.ExternalWebClientUrls, ews.UserSettingName.ExternalImap4Connections, ews.UserSettingName.AlternateMailboxes ]; //get the setting autod.GetUserSettings(["email1@domain.com", "email2@domain.com"], settings) .then(function (response) { //do what you want with user settings var tabcount = 0; var tabs = function () { return ews.StringHelper.Repeat("\t", tabcount); }; console.log(autod.Url.ToString()); //uncoment next line to see full response from autodiscover, you will need to add var util = require('util'); //console.log(util.inspect(response, { showHidden: false, depth: null, colors: true })); for (var _i = 0, _a = response.Responses; _i < _a.length; _i++) { var resp = _a[_i]; console.log(ews.StringHelper.Format("{0}settings for email: {1}", tabs(), resp.SmtpAddress)); tabcount++; for (var setting in resp.Settings) { console.log(ews.StringHelper.Format("{0}{1} = {2}", tabs(), ews.UserSettingName[setting], resp.Settings[setting])); } tabcount--; } }, function (e) { //log errors or do something with errors });Example of user availability
var ews = require('ews-javascript-api'); //create ExchangeService object var exch = new ews.ExchangeService(ews.ExchangeVersion.Exchange2013); exch.Credentials = new ews.ExchangeCredentials("userName", "password"); //set ews endpoint url to use exch.Url = new ews.Uri("https://outlook.office365.com/Ews/Exchange.asmx"); // you can also use exch.AutodiscoverUrl var attendee =[ new ews.AttendeeInfo("email1@domain.com"), new ews.AttendeeInfo("email2@domain.com")]; //create timewindow object o request avaiability suggestions for next 48 hours, DateTime and TimeSpan object is created to mimic portion of .net datetime/timespan object using momentjs var timeWindow = new ews.TimeWindow(ews.DateTime.Now, new ews.DateTime(ews.DateTime.Now.TotalMilliSeconds + ews.TimeSpan.FromHours(48).asMilliseconds())); exch.GetUserAvailability(attendee, timeWindow, ews.AvailabilityData.FreeBusyAndSuggestions) .then(function (availabilityResponse) { //do what you want with user availability }, function (errors) { //log errors or do something with errors }); Review Core/ExchangeService methods in api document, Any method not marked private oe internal (internal marker is in description of method) is posted and can be used, open issue if it doe snot work
ArchiveItems
AutodiscoverUrl
BindToGroupItems
BindToItems
ConvertId
ConvertIds
CopyItems
CreateItems
DeleteItems
ExpandGroup
FindAppointments
FindFolders
FindItems
GetAttachments
GetClientAccessToken
GetPasswordExpirationDate
GetRoomLists
GetRooms
GetUserAvailability
GetUserOofSettings
GetUserOofSettings
LoadPropertiesForItems
MarkAsJunk
MoveItems
ResolveName
SetTeamMailbox
SetUserOofSettings SetUserOofSettings
SubscribeToPullNotifications
SubscribeToStreamingNotifications
SubscribeToStreamingNotificationsOnAllFolders
SyncFolderHierarchy
SyncFolderItems
UnpinTeamMailbox
UpdateItems
GetInboxRules
UpdateInboxRules
AddDelegates
GetDelegates
RemoveDelegates
UpdateDelegates
GetUserRetentionPolicyTags *
FindConversation*
FindGroupConversation*
GetConversationItems*
GetGroupConversationItems*
EnableAlwaysCategorizeItemsInConversations*
DisableAlwaysCategorizeItemsInConversations*
EnableAlwaysDeleteItemsInConversations*
DisableAlwaysDeleteItemsInConversations*
EnableAlwaysMoveItemsInConversations*
DisableAlwaysMoveItemsInConversations*
MoveItemsInConversations*
CopyItemsInConversations*
DeleteItemsInConversations*
SetReadStateForItemsInConversations*
SetRetentionPolicyForItemsInConversations*
SetFlagStatusForItemsInConversations*
* is for new items in recent update
BindToFolder
CopyFolder
CreateFolder
DeleteFolder
EmptyFolder
FindFolders
FindItems
Load
LoadPropertiesForFolder
MarkAllItemsAsRead
MarkAllItemsAsUnread
RemoveExtendedProperty
SetExtendedProperty
MoveFolder
Save
UpdateFolder
ArchiveItem
BindToItem
CopyItem[s]
CreateItem
DeleteItem[s]
FindAppointments
FindItems
LoadPropertiesForItems
MarkAsJunk
MoveItem
SendItem
Save
UpdateItem[s]
RemoveExtendedProperty
SetExtendedProperty
AcceptTentatively [Appointment]
AcceptTentatively [Appointment]
Decline [Appointment]
AMD module for require.js to be included in build system, bower module and related documentation will be published.
in progress....
Licensed under MIT