Automapping.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
#region Types
add-type @'
namespace CPolydorou.Exchange
{
    public class MailboxAutomapping
    {
        public string SharedName;
        public string SharedIdentity;
        public string SharedDN;
        public string DelegateName;
        public string DelegateIdentity;
        public string DelegateDN;
    }
 
    public class UserAutomapping
    {
        public string UserName;
        public string UserIdentity;
        public string UserDN;
        public string ShareName;
        public string ShareIdentity;
        public string ShareDN;
    }
}
'@

#endregion

#region Functions
#region Get-MailboxAutomapping
Function Get-MailboxAutomapping
{
    <#
    .SYNOPSIS
 
    Get if a use has automapping enabled for a mailbox.
    .DESCRIPTION
 
    The Get-MailboxAutomappingStatus function will check if a user has automapping enabled for a mailbox.
    .PARAMETER SharedMailbox
 
    The shared mailbox.
    .PARAMETER UserMailbox
 
    The user's mailbox.
    .EXAMPLE
        PS C:\> Get-MailboxAutomapping testsharedmailbox
 
        SharedName DelegateName
        ---------- ------------
        Test Shared Mailbox Christos Polydorou
        Test Shared Mailbox Administrator
 
        Get the automapping for all users on shared mailbox "testsharedmailbox"
 
    .EXAMPLE
        PS C:\> Get-MailboxAutomapping -SharedMailbox testsharedmailbox -UserMailbox cpolydorou
 
        SharedName DelegateName
        ---------- ------------
        Test Shared Mailbox Christos Polydorou
 
        Get the automapping for user "cpolydorou" on mailbox "testsharedmailbox"
 
    .EXAMPLE
        PS C:\> Get-MailboxAutomapping -SharedMailbox testsharedmailbox -UserMailbox cpolydorou | fl *
 
        SharedName : Test Shared Mailbox
        SharedIdentity : LAB.local/LAB/Shared Mailboxes/Test Shared Mailbox
        SharedDN : CN=Test Shared Mailbox,OU=Shared Mailboxes,OU=LAB,DC=LAB,DC=local
        DelegateName : Christos Polydorou
        DelegateIdentity : LAB.local/LAB/Users/Christos Polydorou
        DelegateDN : CN=Christos Polydorou,OU=Users,OU=LAB,DC=LAB,DC=local
 
        Get full details.
 
    .NOTES
    The shared mailbox does not have to be of type shared.
    #>


    [cmdletBinding()]

    Param
    (
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
        [string]$SharedMailbox,
        [Parameter(Mandatory = $false, Position = 1)]
        [string]$UserMailbox
    )

    Begin
    {
        # Check if Exchange tools are available
        Write-Verbose "Checking for Exchange cmdlets."
        try
        {
            Get-Command -Name "Get-Recipient" -ErrorAction Stop |
                Out-Null
        }
        catch
        {
            Throw "Exchange cmdlets are not available."
        }

        # Tools to search Active Directory
        $domaininfo = new-object DirectoryServices.DirectoryEntry
        $searcher = New-Object System.DirectoryServices.DirectorySearcher($domaininfo)
    }

    Process
    {
        try
        {
            # Get the shared mailbox
            $shared = Get-Recipient $SharedMailbox -ErrorAction stop
            if($shared.count -gt 1)
            {
                Throw "Multiple objects found for $SharedMailbox"
            }
        }
        catch
        {
            throw $_
        }
    
        if($UserMailbox)
        {
            try
            {
                # Get the user
                $user = Get-Recipient $UserMailbox -ErrorAction Stop
                if($user.count -gt 1)
                {
                    Throw "Multiple objects found for $UserMailbox"
                }
            }
            catch
            {
                Throw $_
            }
        }

        # Get the Active Directory object for the shared mailbox
        try
        {
            $searcher.filter = "(distinguishedname=$($shared.distinguishedname))"
            $SharedResult = $searcher.FindOne()

            $sharedADObject = [ADSI]$SharedResult.GetDirectoryEntry()
        }
        catch
        {
            Throw $_
        }

        # Get the list of delegates (Distinguished Names)
        $delegates = $sharedADObject.Properties["msExchDelegateListLink"]

        # Get the recipients for the delegates
        $delegateRecipients = $delegates |
                                    Get-Recipient

        # If a delegate was specified, display the results for this one
        if($UserMailbox)
        {
            $delegateRecipients = $delegateRecipients |
                                    Where-Object {$_.distinguishedname -eq $user.distinguishedname}
        }

        # Return the results
        $delegateRecipients |
            %{
                # Create and return custom objects
                $obj = New-Object CPolydorou.Exchange.MailboxAutomapping
                $obj.SharedIdentity = $shared.Identity
                $obj.SharedName = $shared.Name
                $obj.SharedDN = $shared.DistinguishedName
                $obj.DelegateIdentity = $_.Identity
                $obj.DelegateName = $_.Name
                $obj.DelegateDN = $_.DistinguishedName
                $obj
            }
    }

    End
    {
        # Clean up
        $searcher.Dispose()
    }
}
#endregion

#region Enable-MailboxAutomapping
Function Enable-MailboxAutomapping
{
    <#
    .SYNOPSIS
 
    Enable mailbox automapping.
    .DESCRIPTION
 
    The Enable-MailboxAutomapping function will enable the automapping feature on a user for a shared mailbox.
    .PARAMETER SharedMailbox
 
    The mailbox that the user has permissions on.
    .PARAMETER UserMailbox
 
    The mailbox of the user.
    .EXAMPLE
 
    PS C:\> Enable-MailboxAutomapping -SharedMailbox testsharedmailbox -UserMailbox cpolydorou -Verbose -Confirm:$false
    VERBOSE: Performing the operation "Enable mailbox automapping for Christos Polydorou on" on target "Test Shared Mailbox".
    VERBOSE: Enabling automapping for recipient Christos Polydorou on Test Shared Mailbox.
 
    SharedName DelegateName
    ---------- ------------
    Test Shared Mailbox Christos Polydorou
 
    Enable the mailbox automapping for the user "CPolydorou" on mailbox "TestSharedMailbox".
 
    .NOTES
    The shared mailbox does not have to be of type shared.
    #>


    [CmdletBinding(SupportsShouldProcess=$true, 
                  PositionalBinding=$false,
                  ConfirmImpact='High')]

    Param
    (
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
        [string]$SharedMailbox,
        [Parameter(Mandatory = $true, Position = 1)]
        [string]$UserMailbox
    )

    Begin
    {
        # Check if Exchange tools are available
        Write-Verbose "Checking for Exchange cmdlets."
        try
        {
            Get-Command -Name "Get-Recipient" -ErrorAction Stop |
                Out-Null
        }
        catch
        {
            Throw "Exchange cmdlets are not available."
        }

        # Tools to search Active Directory
        $domaininfo = new-object DirectoryServices.DirectoryEntry
        $searcher = New-Object System.DirectoryServices.DirectorySearcher($domaininfo)
    }

    Process
    {
        try
        {
            # Get the shared mailbox
            $shared = Get-Recipient $SharedMailbox -ErrorAction stop
            if($shared.count -gt 1)
            {
                Throw "Multiple objects found for $SharedMailbox"
            }
        }
        catch
        {
            throw $_
        }
    
        try
        {
            # Get the user
            $user = Get-Recipient $UserMailbox -ErrorAction Stop
            if($user.count -gt 1)
            {
                Throw "Multiple objects found for $UserMailbox"
            }
        }
        catch
        {
            Throw $_
        }

        # Search Active Directory for the shared mailbox
        try
        {
            $searcher.filter = "(distinguishedname=$($shared.distinguishedname))"
            $SharedResult = $searcher.FindOne()

            $sharedADObject = [ADSI]$SharedResult.GetDirectoryEntry()
        }
        catch
        {
            Throw $_
        }

        # Get the delegates (list of Distinguished Names)
        $delegates = $sharedADObject.Properties["msExchDelegateListLink"]

        # Enable automapping
        if($delegates.Contains($user.distinguishedName))
        {
            Write-Warning "Automapping for recipient $($user.Name) on $($shared.Name) is already enabled."
            return
        }
        else
        {
            if($PSCmdlet.ShouldProcess($shared.Name, "Enable mailbox automapping for $($user.Name) on"))
            {
                Write-Verbose "Enabling automapping for recipient $($user.Name) on $($shared.Name)."
                $sharedADObject.Properties["msExchDelegateListLink"].Add($user.distinguishedname) |
                    Out-Null
            }
        }
        try
        {
            $sharedADObject.CommitChanges()

            # Create and return a custom object
            $obj = New-Object CPolydorou.Exchange.MailboxAutomapping
            $obj.SharedName = $shared.Name
            $obj.SharedIdentity = $shared.Identity
            $obj.DelegateName = $user.Name
            $obj.DelegateIdentity = $user.Identity
            $obj
        }
        catch
        {
            Throw $_
        }
    }

    End
    {
        # Clean up
        $searcher.Dispose()
    }
}
#endregion

#region Disable-MailboxAutomapping
Function Disable-MailboxAutomapping
{
    <#
    .SYNOPSIS
 
    Disable mailbox automappping.
    .DESCRIPTION
 
    The Disable-MailboxAutomapping function will disable the automapping feature on a user for a shared mailbox.
    .PARAMETER SharedMailbox
 
    The mailbox that the user has permissions on.
    .PARAMETER UserMailbox
 
    The mailbox of the user.
    .EXAMPLE
 
    PS C:\> Disable-MailboxAutomapping -SharedMailbox testsharedmailbox -UserMailbox cpolydorou -Verbose -Confirm:$false
     
    VERBOSE: Performing the operation "Disable mailbox automapping for Christos Polydorou on " on target "Test Shared Mailbox".
    VERBOSE: Disabling automapping for recipient Christos Polydorou on Test Shared Mailbox.
 
    Disable mailbox automapping for user "CPolydorou" on mailbox "TestSharedMailbox"
 
    .NOTES
    The shared mailbox does not have to be of type shared.
    #>


    [CmdletBinding(SupportsShouldProcess=$true, 
                  PositionalBinding=$false,
                  ConfirmImpact='High')]

    Param
    (
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
        [string]$SharedMailbox,
        [Parameter(Mandatory = $true, Position = 1, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
        [string]$UserMailbox
    )

    Begin
    {
        # Check if Exchange tools are available
        Write-Verbose "Checking for Exchange cmdlets."
        try
        {
            Get-Command -Name "Get-Recipient" -ErrorAction Stop |
                Out-Null
        }
        catch
        {
            Throw "Exchange cmdlets are not available."
        }

        # Tools to search Active Directory
        $domaininfo = new-object DirectoryServices.DirectoryEntry
        $searcher = New-Object System.DirectoryServices.DirectorySearcher($domaininfo)
    }

    Process
    {
        try
        {
            # Get the shared mailbox
            $shared = Get-Recipient $SharedMailbox -ErrorAction stop
            if($shared.count -gt 1)
            {
                Throw "Multiple objects found for $SharedMailbox"
            }
        }
        catch
        {
            throw $_
        }
    
        try
        {
            # Get the user
            $user = Get-Recipient $UserMailbox -ErrorAction Stop
            if($user.count -gt 1)
            {
                Throw "Multiple objects found for $UserMailbox"
            }
        }
        catch
        {
            Throw $_
        }

        # Search the shared mailbox in Active Directory
        try
        {
            $searcher.filter = "(distinguishedname=$($shared.distinguishedname))"
            $SharedResult = $searcher.FindOne()

            $sharedADObject = [ADSI]$SharedResult.GetDirectoryEntry()
        }
        catch
        {
            Throw $_
        }

        # Get the list of delegates (list of Distinguished Names)
        $delegates = $sharedADObject.Properties["msExchDelegateListLink"]

        # Remove the delegate
        if( -Not $delegates.Contains($user.distinguishedName))
        {
            Write-Warning "Automapping for recipient $($user.Name) on $($shared.Name) was not enabled."
            return
        }
        else
        {
            if($PSCmdlet.ShouldProcess($shared.Name, "Disable mailbox automapping for $($user.Name) on "))
            {
                Write-Verbose "Disabling automapping for recipient $($user.Name) on $($shared.Name)."
                $sharedADObject.Properties["msExchDelegateListLink"].Remove($user.distinguishedname)
            }
        }

        try
        {
            $sharedADObject.CommitChanges()
        }
        catch
        {
            Throw $_
        }
    }

    End
    {
        # Clean up
        $searcher.Dispose()
    }
}
#endregion

#region Get-UserAutomapping
function Get-UserAutomapping
{
    <#
    .Synopsis
       Get the mailbox automapping status for a user.
    .DESCRIPTION
       Get the mailboxes that are going to be automatically mapped to a user's outlook account.
    .INPUTS
        System.String
    .OUTPUTS
        CPolydorou.UserAutoMapping
    .EXAMPLE
        PS C:\> Get-UserAutomapping cpolydorou
 
        UserName ShareName
        -------- ---------
        Christos Polydorou eVoices
        Christos Polydorou Shared Mailbox
 
        Get the mailboxes that are going to be automapped on cpolydorou's account.
    .EXAMPLE
        PS C:\> Get-UserAutomapping cpolydorou | fl *
 
        UserName : Christos Polydorou
        UserIdentity : LAB.local/LAB/Users/Christos Polydorou
        UserDN : CN=Christos Polydorou,OU=Users,OU=LAB,DC=LAB,DC=local
        ShareName : eVoices
        ShareIdentity : LAB.local/LAB/Shared Mailboxes/eVoices
        ShareDN : CN=eVoices,OU=Shared Mailboxes,OU=LAB,DC=LAB,DC=local
 
        UserName : Christos Polydorou
        UserIdentity : LAB.local/LAB/Users/Christos Polydorou
        UserDN : CN=Christos Polydorou,OU=Users,OU=LAB,DC=LAB,DC=local
        ShareName : Shared Mailbox
        ShareIdentity : LAB.local/LAB/Shared Mailboxes/Shared Mailbox
        ShareDN : CN=Shared Mailbox,OU=Shared Mailboxes,OU=LAB,DC=LAB,DC=local
 
        Get more details on the recipients.
    .NOTES
       Unlike the Get-MailboxAutommaping which will list the users that will automatically map a mailbox,
       this cmdlet will list the mailboxes that will be automatically mapped by a user.
    #>


    [CmdletBinding()]
    [OutputType([String])]
    Param
    (
        # The identity of the user
        [Parameter(Mandatory=$true, 
                   ValueFromPipeline=$true,
                   ValueFromPipelineByPropertyName=$true, 
                   ValueFromRemainingArguments=$false, 
                   Position=0
        )]
        $Identity
    )

    Begin
    {
        # Check if Exchange tools are available
        Write-Verbose "Checking for Exchange cmdlets."
        try
        {
            Get-Command -Name "Get-Recipient" -ErrorAction Stop |
                Out-Null
        }
        catch
        {
            Throw "Exchange cmdlets are not available."
        }

        # Create the Active Directory searcher
        $Domain = New-Object System.DirectoryServices.DirectoryEntry
        $Searcher = New-Object System.DirectoryServices.DirectorySearcher
        $Searcher.SearchRoot = $Domain
        $Searcher.PageSize = 10

    }
    Process
    {
        # Get the recipient object for the user
        try
        {
            $recipient = Get-Recipient $Identity -ErrorAction Stop
        }
        catch
        {
            Throw $_
            return
        }

        # Check if multiple user objects exist for the supplied identity
        if($recipient.count -gt 1)
        {
            Throw "Multiple recipients were found for $Identity."
        }

        Write-Verbose "Getting automapping settings for $Identity"

        # Find the object in Active Directory and add the address
        $dn = $recipient.DistinguishedName
        $LDAPFilter = "(distinguishedname=$dn)"
        $Searcher.Filter = $LDAPFilter
        $Searcher.SearchScope = "Subtree"
        $Result = $Searcher.FindOne()
        $Object = [ADSI]$Result.GetDirectoryEntry()
        $sharedMailboxes = $Object.Properties["msExchDelegateListBL"]

        foreach($sm in $sharedMailboxes)
        {
            # Get the recipient for the shared resource
            try
            {
                $shareRecipient = Get-Recipient $sm -ErrorAction Stop
            }
            catch
            {
                Write-Error "Could not find a recipient for shared resource $sm"
            }

            # Create a custom object
            $obj = New-Object CPolydorou.Exchange.UserAutomapping
            $obj.UserName = $recipient.Name
            $obj.UserIdentity = $recipient.Identity
            $obj.UserDN = $recipient.DistinguishedName
            $obj.ShareName = $shareRecipient.Name
            $obj.ShareIdentity = $shareRecipient.Identity
            $obj.ShareDN = $shareRecipient.DistinguishedName
            $obj
        }
    }

    End
    {
        # Cleanup
        $Searcher.Dispose()
    }
}
#endregion
#endregion

#region Exports
Export-ModuleMember -Function Get-MailboxAutomapping
Export-ModuleMember -Function Enable-MailboxAutomapping
Export-ModuleMember -Function Disable-MailboxAutomapping
Export-ModuleMember -Function Get-UserAutomapping
#endregion