{"id":2151,"date":"2018-11-18T11:00:57","date_gmt":"2018-11-18T11:00:57","guid":{"rendered":"https:\/\/developer.microsoft.com\/en-us\/office\/blogs\/?p=2151"},"modified":"2018-11-18T11:00:57","modified_gmt":"2018-11-18T11:00:57","slug":"30daysmsgraph-day-18-use-case-update-user-mailbox-settings","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/30daysmsgraph-day-18-use-case-update-user-mailbox-settings\/","title":{"rendered":"30DaysMSGraph \u2013 Day 18 \u2013 Use Case: Update User Mailbox Settings"},"content":{"rendered":"

List of all posts in the #30DaysMSGraph series<\/a><\/p>\n

In Day 17<\/a> we extended the base .Net Core console application to assign license to a user in Azure AD. Today we\u2019ll extend the base console application to update the users (exchange online) mailbox settings in Office 365.\u00a0 Note that it is not required to perform each of the daily Use Case samples in order to continue to the next.\u00a0 Starting with the base console application from Day 15 will be sufficient if building from scratch, or as always, you can clone the completed version in the provided repo at bottom of this post. The application uses a client secret and the Microsoft Authentication Library (MSAL) to establish an authentication context with the Microsoft Graph API.<\/p>\n

\"\"<\/a><\/p>\n

Today we will explore the process of updating a user mailbox in preparation for onboarding a user.<\/p>\n

Retrieve and Update User Mailbox Settings<\/h3>\n

In preparation for onboarding a user, once the user is created and appropriate license is applied, now we can update the user specific mailbox settings like the users time zone, locale info, working hours etc.<\/p>\n

You can use the Microsoft Graph endpoint \/users\/{id|userPrincipalName}\/mailboxSettings to access a users mailbox settings. You can find the Microsoft Graph documentation to retrieve mailbox settings here<\/a> and the documentation to update mailbox settings here<\/a>.<\/p>\n

To read and update users mailbox settings it requires new permissions. As such the Azure AD App Registration\u00a0needs to be updated to include the following application permissions: User.Read.All, MailboxSettings.Read, MailboxSettings.ReadWrite.<\/p>\n

This is optional: in addition to the above lets add Mail.Read application permission too as the code sample showcases how to use Microsoft Graph SDK to retrieve users inbox messages too.<\/p>\n

\"\"<\/a><\/p>\n

With the necessary permissions configured it is time to look at new the code required.<\/p>\n

Get and Set User Mailbox Default Time zone<\/p>\n

Below you will see the two helper methods that will get and set the user mailbox default time zone.<\/p>\n

\n
public async Task<string> GetUserMailboxDefaultTimeZone(string alias)\n{\n    User user = FindByAlias(alias).Result;\n    User detailedUser = await _graphClient.Users[user.Id].Request().Select(\"MailboxSettings\").GetAsync();\n    return detailedUser.MailboxSettings.TimeZone;\n}<\/pre>\n
The above method uses Microsoft Graph SDK to retrieve the supplied users current time zone setting.<\/div>\n<\/div>\n
<\/div>\n
\n
\n
public async void SetUserMailboxDefaultTimeZone(string alias, string timezone)\n{\n   User user = FindByAlias(alias).Result;\n   Uri Uri = new Uri(\"https:\/\/graph.microsoft.com\/v1.0\/users\/\"+ user.Id +\"\/mailboxSettings\");\n   String jsonContent = \"{\\\"timeZone\\\" : \\\"\"+ timezone +\"\\\"}\";\n   HttpContent httpContent = new StringContent(jsonContent, System.Text.Encoding.UTF8, \"application\/json\");\n   await _httpClient.PatchAsync(Uri, httpContent);\n}<\/pre>\n<\/div>\n
Above method takes the user alias and the timezone value that must be applied to the users mailbox.<\/div>\n
Note: An important thing to note here is that this method uses HttpClient instead of using Microsoft Graph SDK to update the mailbox settings. The reason for this is because as of today (Nov 18th 2018) there is no support to update MailboxSettings using the SDK. This capability is under work and it will be available soon.<\/div>\n<\/div>\n
<\/div>\n
Now that the helper methods are ready. You can call into these methods from the Program.cs class using below method:<\/div>\n
\n
\n
private static void GetUserMailboxDefaultTimeZone()\n{\n\u00a0\u00a0\u00a0const string alias = \"admin\";\n\u00a0\u00a0\u00a0var mailboxHelper = new MailboxHelper(_graphServiceClient);\n\u00a0\u00a0\u00a0var defaultTimeZone = mailboxHelper.GetUserMailboxDefaultTimeZone(alias).Result;\n\u00a0\u00a0\u00a0Console.WriteLine(\"Default timezone: \"+ defaultTimeZone);\n}\n\nprivate static void SetUserMailboxDefaultTimeZone()\n{\n\u00a0\u00a0\u00a0const string alias = \"admin\";\n\u00a0\u00a0\u00a0var mailboxHelper = new MailboxHelper(_graphServiceClient, _httpClient);\n\u00a0\u00a0\u00a0mailboxHelper.SetUserMailboxDefaultTimeZone(alias, \"Eastern Standard Time\");\n}<\/pre>\n
Note the SetUserMailboxefaultTimeZone method is initiating the MailboxHelper with both the _graphServiceClient and _httpClient. The reason for this is because the\u00a0SetUserMailboxDefaultTimeZone in the MailboxHelper.cs is using both the client objects. The GraphServiceClient object is used to find the user using the alias. The HttpClient object is used to update the mailboxsettings.<\/div>\n<\/div>\n<\/div>\n
<\/div>\n
Create and Retrieve User Mailbox Message Rules<\/h3>\n
The MailboxHelper class has additional methods that will showcase how to use Microsoft Graph SDK to retrieve user messages, create and retrieve message rules. Below is code snippet that encapsulates creation and retrieving of mailbox message rules.<\/div>\n
\n
\n
private static MessageRule BuildMailRule(string displayName, int sequence, bool isEnabled, string senderContains, string forwardToEmail)\n{\n\u00a0\u00a0\u00a0\u00a0IEnumerable<string> senderContainsList = new string[]{senderContains};\n\u00a0\u00a0\u00a0\u00a0EmailAddress email = new EmailAddress(){\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Address = forwardToEmail\n            };\n    Recipient recipient = new Recipient(){\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 EmailAddress = email\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 };\n\u00a0\u00a0\u00a0\u00a0IEnumerable<Recipient> recipientList = new Recipient[]{ recipient };\n\u00a0\u00a0\u00a0\u00a0var msgRule = new MessageRule{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 DisplayName = displayName,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Sequence = sequence,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 IsEnabled = isEnabled,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Conditions = new MessageRulePredicates{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 SenderContains = senderContainsList\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0    },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0    Actions = new MessageRuleActions{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ForwardTo = recipientList\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0    }\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 };\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return msgRule;\n}<\/pre>\n
Above is the helper method that takes various parameters needed to create a new message rule.<\/div>\n<\/div>\n<\/div>\n
\n
\n
public async Task CreateRule(string alias, string displayName, int sequence, bool isEnabled, string senderContains, string forwardToEmail)\n{\n\u00a0\u00a0\u00a0\u00a0MessageRule rule = BuildMailRule(displayName, sequence, isEnabled, senderContains, forwardToEmail);\n\u00a0\u00a0\u00a0\u00a0User user = FindByAlias(alias).Result;\n\u00a0\u00a0\u00a0\u00a0await _graphClient.Users[user.Id].MailFolders.Inbox.MessageRules.Request().AddAsync(rule);\n}<\/pre>\n
Above method users the BuildMailRule helper method to create a new MessageRule object and then uses Microsoft Graph SDK to add the rule to the users mailbox.<\/div>\n
\n
\n
public async Task<List<ResultsItem>> GetUserMailboxRules(string alias)\n{\n\u00a0\u00a0\u00a0\u00a0User user = FindByAlias(alias).Result;\n\u00a0\u00a0\u00a0\u00a0IMailFolderMessageRulesCollectionPage rules = await _graphClient.Users[user.Id].MailFolders.Inbox.MessageRules.Request().GetAsync();\n\u00a0\u00a0\u00a0\u00a0List<ResultsItem> items = new List<ResultsItem>();\n\u00a0\u00a0\u00a0\u00a0if (rules?.Count > 0)\n\u00a0\u00a0\u00a0\u00a0{\n\u00a0\u00a0\u00a0\u00a0\tforeach (MessageRule rule in rules)\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0   items.Add(new ResultsItem{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Display = rule.DisplayName,\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Id = rule.Id\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 });\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\u00a0\u00a0return items;\n}<\/pre>\n
Above method uses Microsoft Graph SDK to retrieve the message rules and then populates a List object with the rules collection.<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
<\/div>\n
There are additional details and functionality that you can find in the code sample provided in the repository. The complete set of instructions and code are on GitHub in the\u00a0dotnetcore-console-sample<\/a> repo for you try it yourself.<\/div>\n
<\/div>\n
\n
Try It Out<\/h2>\n
Navigate to the\u00a0dotnetcore-console-sample<\/a> repo.\u00a0 Do one (or both) of the following:<\/p>\n
Day 18 repo link<\/a><\/p>\n
    \n
  1. Clone the repo and configure the project in the Day 18 subfolder.<\/li>\n
  2. Follow the instructions in Day 18 to build the project from scratch yourself.<\/li>\n<\/ol>\n
    If you run into any issues while building or configuring the project please create a new Issue on the repo.<\/p>\n
    Join us tomorrow as we continue the onboarding steps for the user within an Office 365 tenant using Microsoft Graph requests in Day 19<\/a>.<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
    In preparation for onboarding a user, once the user is created and appropriate license is applied, now we can update the user specific mailbox settings like the users time zone, locale info, working hours etc.<\/p>\n","protected":false},"author":69213,"featured_media":25159,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3],"tags":[84,12],"class_list":["post-2151","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph","tag-30daysmsgraph","tag-outlook"],"acf":[],"blog_post_summary":"
    In preparation for onboarding a user, once the user is created and appropriate license is applied, now we can update the user specific mailbox settings like the users time zone, locale info, working hours etc.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/2151","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69213"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=2151"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/2151\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/25159"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=2151"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=2151"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=2151"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}