| page_type | products | languages | extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
|
|
|
#Email Peek - An iOS app built using Office 365 #
Email Peek is a cool mail app built using the Office 365 APIs on the iOS platform. This app allows you to peek at just the email conversations you truly care about when you are away, such as when you are on vacation. Email Peek also makes it easy for you to send quick replies to messages without typing. This app uses many of the features of the Office 365 Mail API such as read/write, server-side filtering, and categories.
Table of contents
- Set up your environment
- Use CocoaPods to import the O365 iOS SDK
- Register your app with Microsoft Azure
- Get the Client ID and Redirect Uri into the project
- Important code files
- Questions and comments
- Troubleshooting
- Additional resources
To run Email Peek, you need the following:
- Xcode from Apple.
- An Office 365 account. You can get an Office 365 account by signing up for an Office 365 Developer site. This will give you access to the APIs that you can use to create apps that target Office 365 data.
- A Microsoft Azure tenant to register your application. Azure Active Directory provides identity services that applications use for authentication and authorization. A trial subscription can be acquired here: Microsoft Azure.
Important: You will also need to ensure your Azure subscription is bound to your Office 365 tenant. To do this see the Adding a new directory section in the Active Directory team's blog post, Creating and Managing Multiple Windows Azure Active Directories. You can also read Set up Azure Active Directory access for your Developer Site for more information.
- Installation of CocoaPods as a dependency manager. CocoaPods will allow you to pull the Office 365 and Azure Active Directory Authentication Library (ADAL) dependencies into the project.
Once you have an Office 365 account and an Azure AD account that is bound to your Office 365 Developer site, you'll need to perform the following steps:
- Register your application with Azure, and configure the appropriate Office 365 Exchange Online permissions.
- Install and use CocoaPods to get the Office 365 and ADAL authentication dependencies into your project.
- Enter the Azure app registration specifics (ClientID and RedirectUri) into the Email Peel app.
Note: If you've never used CocoaPods before as a dependency manager you'll have to install it prior to getting your Office 365 iOS SDK dependencies into your project.
Enter the next two lines of code from the Terminal app on your Mac.
sudo gem install cocoapods pod setup
If the install and setup are successful, you should see the message Setup completed in Terminal. For more information on CocoaPods, and its usage, see CocoaPods.
Get the Office 365 SDK for iOS dependencies in your project The Email Peek app already contains a podfile that will get the Office 365 and ADAL components (pods) into your project. It's located in the sample root ("Podfile"). The example shows the contents of the file.
target ‘O365-iOS-EmailPeek’ do pod 'ADALiOS', '~> 1.2.1' pod 'Office365/Outlook', '= 0.9.1' pod 'Office365/Discovery', '= 0.9.1' end
You'll simply need to navigate to the project directory in the Terminal (root of the project folder) and run the following command.
pod install
Note: You should receive confirmation that these dependencies have been added to the project and that you must open the workspace instead of the project from now on in Xcode (O365-iOS-EmailPeek.xcworkspace). If there is a syntax error in the Podfile, you will encounter an error when you run the install command.
- Sign in to the Azure Management Portal, using your Azure AD credentials.
- Select Active Directory on the left menu, then select the directory for your Office 365 developer site.
- On the top menu, select Applications.
- Select Add from the bottom menu.
- On the What do you want to do page, select Add an application my organization is developing.
- On the Tell us about your application page, specify O365-iOS-EmailPeek for the application name and select NATIVE CLIENT APPLICATION for type.
- Select the arrow icon on the lower-right corner of the page.
- On the Application information page, specify a Redirect URI, for this example, you can specify http://localhost/emailpeek, and then select the check box in the lower-right hand corner of the page. Remember this value for the section Get the ClientID and RedirectUri into the project.
- Once the application has been successfully added, you will be taken to the Quick Start page for the application. Select Configure in the top menu.
- Under permissions to other applications, add the following permission: Add the Office 365 Exchange Online application, and select Read and write user mail, and Send mail as a user permissions.
- Copy the value specified for Client ID on the Configure page. Remember this value for the section Getting the ClientID and RedirectUri into the project.
- Select Save in the bottom menu.
Finally you'll need to add the Client ID and Redirect Uri you recorded from the previous section Register your app with Microsoft Azure.
Browse the O365-iOS-EmailPeek project directory and open up the workspace (O365-EmailPeek-iOS.xcworkspace). In the AppDelegate.m file you'll see that the ClientID and RedirectUri values can be added to the top of the file. Supply the necessary values in this file.
// You will set your application's clientId and redirect URI. You get // these when you register your application in Azure AD. static NSString * const kClientId = @"ENTER_REDIRECT_URI_HERE"; static NSString * const kRedirectURLString = @"ENTER_CLIENT_ID_HERE"; static NSString * const kAuthorityURLString = @"https://login.microsoftonline.com/common";
Models
These domain entities are custom classes that represent the data of the application. All of these classes are immutable. They wrap the basic entities provided by the Office 365 SDK.
Office365 Helpers
The helpers are the classes that actually communicate with Office 365 by making API calls. This architecture decouples the rest of the app from the Office365 SDK.
Office365 Server Side Filters
These classes help make the appropriate API call with the correct Office 365 server-side filter clauses during fetch.
ConversationManager and SettingsManager
These classes help manage conversations and settings in the app.
Controllers
These are the controllers for the different views supported by Email Peek.
Views
This implements a custom cell which is used in two different places, in the ConversationListViewController and ConversationViewController.
We'd love to get your feedback on the Email Peek app sample. You can send your feedback to us in the Issues section of this repository.
Questions about Office 365 development in general should be posted to Stack Overflow. Please tag your questions are tagged with [Office365] and [API].
With the Xcode 7.0 update, App Transport Security is enabled for simulators and devices running iOS 9. See App Transport Security Technote.
For this sample we have created a temporary exception for the following domain in the plist:
- outlook.office365.com
If these exceptions are not included, all calls into the Office 365 API will fail in this app when deployed to an iOS 9 simulator in Xcode.
- Office 365 Connect app for iOS
- Office 365 Code Snippets for iOS
- Office 365 Profile Sample for iOS
- Office 365 APIs documentation
- Office 365 API code samples and videos
- Office Dev Center
- Medium article on Email Peek
Copyright (c) 2015 Microsoft. All rights reserved.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent