RecipientAddress.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
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
#region Functions
#region Get-RecipientAddress
Function Get-RecipientAddress
{
    <#
        .SYNOPSIS
        Gets a list of all the addresses assigned to a recipient.
 
        .DESCRIPTION
        The Get-RecipientAddress cmdlet returns a list of all the addresses assigned to a recipient including the SMTP, SIP, X400 and X500 addresses.
     
        .PARAMETER Recipient
        Specifies the identity of the recipient.
 
        .PARAMETER Type
        Specifies the type of the addresses to return.
 
        .EXAMPLE
        Get-RecipientAddress -Identity $Mailbox.Identity -Type SMTP
 
        This command will return all the SMTP addresses of the mailbox saved in the Mailbox variable
 
        .EXAMPLE
        Get-Mailbox User1 | Get-RecipientAddress -Type SMTP
 
        This command will return all the SMTP addresses on the User1's mailbox
    #>

 
    [cmdletBinding()]
    
    Param
    (
         [Parameter(
                   Position = 0,
                   Mandatory = $true,
                   ValueFromPipeline = $true,
                   ValueFromPipelineByPropertyName = $true
         )]  
        [string[]]$Identity,

        [ValidateSet('SIP','SMTP','X500', 'X400')]
        [String]$Type,

        [Parameter()]
        [string]$DomainController
    )
    Begin
    {
        # Check if Exchange cmdlets are available
        try
        {
            Get-Command "Get-MailboxServer" -ErrorAction Stop |
                Out-Null
            Write-Verbose "Exchange cmdlets are available."
        }
        catch
        {
            Throw "Exchange cmdlets are not available. Please use the Exchange Management Shell."
        }        
    }

    Process
    {
        foreach($i in $Identity)
        {
            # Get the recipient
            try
            {
                if($DomainController)
                {                    
                    $r = Get-Recipient $i -DomainController $DomainController -ErrorAction Stop
                }
                else
                {
                    $r = Get-Recipient $i -ErrorAction Stop
                }
                Write-Verbose ("Found object " + $r.Identity)
            }
            catch
            {
                Write-Error "Could not find a recipient with identity $i."
                continue
            }    
        
            # Loop through the addresses of the mailbox
            foreach($a in $r.EmailAddresses)
            {
                # Create new custom object
                $obj = New-Object psobject
                $obj | Add-Member -MemberType NoteProperty -Name "Identity" -Value $r.Identity

                $address = $a.ToString()

                $parts  = $address.Split(":")
                $obj | Add-Member -MemberType NoteProperty -Name "Type" $parts[0]
                $obj | Add-Member -MemberType NoteProperty -Name "Address" $parts[1]

                if($parts[0].ToLower() -eq "smtp")
                {
                    if($parts[0].Equals("SMTP"))
                    {
                        $obj | Add-Member -MemberType NoteProperty -Name "Primary" -Value $true
                    }
                    else
                    {
                        $obj | Add-Member -MemberType NoteProperty -Name "Primary" -Value $false
                    }
                }
                else
                {
                    $obj | Add-Member -MemberType NoteProperty -Name "Primary" -Value $null
                }

                if($Type)
                {
                    if($Type -contains $obj.type)
                    {
                        $obj
                    }
                }
                else
                {
                    $obj
                }
            }
        }
    }

    End{}
}
#endregion

#region New-RecipientAddress
Function New-RecipientAddress
{
    <#
        .SYNOPSIS
        Adds an address to a recipient.
 
        .DESCRIPTION
        The New-RecipientAddress assigns a new address to a recipient.
     
        .PARAMETER Recipient
        Specifies the identity of the recipient on which the address will be assigned.
 
        .PARAMETER Address
        Specifies the address to be added.
 
        .PARAMETER Type
        Specifies the type of the address to be added.
 
        .PARAMETER UpdateMailAttribute
        Updates the mail attribute to match the new primary address.
 
        .PARAMETER Primary
        Specifies whether the new address will be marked as the primary address (SMTP Addresses only).
 
        .EXAMPLE
        New-RecipientAddress -Mailbox User1 -EmailAddress "user1@domain.com" -Primary
 
        This command will add the "user1@domain.com" email address to the User1 mailbox and will mark that address as the primary one.
    #>


    [cmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "High"
    )]

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

        [Parameter(
            Mandatory = $true,
            Position = 1
        )]
        [string]$Address,

        [Parameter(
            Mandatory = $false
        )]
        [ValidateSet('SMTP', 'X400', 'X500', 'SIP')]
        [string]$Type = 'SMTP',
 
        [Parameter(
            Mandatory = $false
        )]
        [switch]$Primary,

        [Parameter(
            Mandatory = $false
        )]
        [switch]$UpdateMailAttribute,

        [Parameter()]
        [string]$DomainController
    )

    Begin {}

    Process
    {
        if($PSCmdlet.ShouldProcess($Identity))
        {
            # Get the recipient
            try
            {
                if($DomainController)
                {
                    $r = Get-Recipient $Identity -ErrorAction Stop -DomainController $DomainController
                }
                else
                { 
                    $r = Get-Recipient $Identity -ErrorAction Stop
                }
                Write-Verbose ("Recipient " + $r.identity + " found.")
            }
            catch
            {
                Write-Error "Could not find a recipient with identity $Identity."
                return
            }

            # Check if the address is already assigned
            if($Type -eq "SMTP")
            {
                if($Primary)
                {
                    $AddressToAdd = "SMTP:"
                }
                else
                {
                    $AddressToAdd = "smtp:"
                }
            }
            else
            {
                $AddressToAdd = $Type + ":"
            }

            $AddressToAdd += $Address

            # Find the object in Active Directory and add the address
            $dn = $r.DistinguishedName

            $LDAPFilter = "(distinguishedname=$dn)"


            if($DomainController)
            {
                try
                {
                    $Domain = New-Object System.DirectoryServices.DirectoryEntry -ArgumentList "LDAP://$DomainController"
                    $Searcher = New-Object System.DirectoryServices.DirectorySearcher -ArgumentList $Domain
                }
                catch
                {
                    Write-Error "Could not contact the domain controller."
                    return
                }
            }
            else
            {
                $Domain = New-Object System.DirectoryServices.DirectoryEntry
                $Searcher = New-Object System.DirectoryServices.DirectorySearcher
            }

            $Searcher.PageSize = 10
            $Searcher.Filter = $LDAPFilter
            $Searcher.SearchScope = "Subtree"

            $Result = $Searcher.FindOne()

            $Object = [ADSI]$Result.GetDirectoryEntry()

            if(!$Object.proxyAddresses.Contains($AddressToAdd))
            {
                if($Primary)
                {
                    Write-Verbose ("Setting proxy address '" + $currentPrimaryAddress + "' to standard from primary.")
                    # get the current primary address
                    $currentPrimaryAddress = $Object.proxyAddresses | Where-Object {$_.StartsWith("SMTP:")}

                    if($Object.proxyAddresses.Count -le 1)
                    {
                        $array = New-Object System.Collections.ArrayList
                        $array.Add($AddressToAdd) |
                            Out-Null
                        $array.Add($currentPrimaryAddress.Replace("SMTP:","smtp:")) |
                            Out-Null
                        $Object.proxyAddresses = $array
                    }
                    else
                    {
                        # remove the current primary address
                        $Object.proxyAddresses.Remove($currentPrimaryAddress) |
                            Out-Null

                        Write-Verbose ("Adding proxy address '" + $AddressToAdd + "'")
                        # add the new primary address
                        $Object.proxyaddresses.Add($AddressToAdd) |
                            Out-Null

                        # add the old primary address as standard address
                        $Object.proxyAddresses.Add($currentPrimaryAddress.Replace("SMTP:","smtp:")) |
                            Out-Null
                    }

                    # set the mail attribute
                    if($UpdateMailAttribute)
                    {
                        Write-Verbose "Updating mail attribute..."
                        $Object.mail = $Address
                    }
                }
                else
                {
                    Write-Verbose ("Adding proxy address '" + $AddressToAdd + "'")

                    # add the new address
                    $Object.proxyaddresses.Add($AddressToAdd) |
                        Out-Null
                }
            }

            try
            {
                $Object.CommitChanges()
                Write-Verbose "Object updated successfully"
            }
            catch
            {
                Write-Error ("Could not update the object " + $Result.Properties.distinguishedname)
                $Error[0].ErrorDetails
            }
        }
    }

    End {}
}
#endregion

#region Remove-RecipientAddress
Function Remove-RecipientAddress
{
    <#
        .SYNOPSIS
        Removes an address from a recipient.
 
        .DESCRIPTION
        The Remove-RecipientAddress removes an address from a recipient.
     
        .PARAMETER Identity
        Specifies the identity of the recipient from which the address will be removed.
 
        .PARAMETER Address
        Specifies the address to be removed.
 
        .PARAMETER Type
        Specifies the type of the address to be removed.
 
        .EXAMPLE
        Remove-RecipientAddress -Identity $mailbox.Identity -Address "user1@domain.com" -Type SMTP
 
        This command will remove the "user1@domain.com" email address from the $mailbox.
    #>


    [cmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "High"
    )]

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

        [Parameter(
            Mandatory = $true,
            Position = 1
        )]
        [string]$Address,

        [Parameter(
            Mandatory = $false
        )]
        [ValidateSet('SMTP', 'SIP', 'X400', 'X500')]
        [string]$Type = 'SMTP',

        [Parameter()]
        [string]$DomainController
     )

    Begin {}

    Process
    {
        if($PSCmdlet.ShouldProcess($Identity))
        {
            # Get the recipient
            try
            {
                if($DomainController)
                {
                    $r = Get-Recipient $Identity -ErrorAction Stop -DomainController $DomainController
                }
                else
                {
                    $r = Get-Recipient $Identity -ErrorAction Stop
                }
                Write-Verbose ("Recipient " + $r.identity + " found.")
            }
            catch
            {
                Write-Error "Could not find a recipient with identity $Identity."
                return
            }

            # Find the object in Active Directory
            $dn = $r.DistinguishedName

            $LDAPFilter = "(distinguishedname=$dn)"

            if($DomainController)
            {
                try
                {
                    $Domain = New-Object System.DirectoryServices.DirectoryEntry -ArgumentList "LDAP://$DomainController"
                    $Searcher = New-Object System.DirectoryServices.DirectorySearcher -ArgumentList $Domain
                }
                catch
                {
                    Write-Error "Could not contact the domain controller."
                    return
                }
            }
            else
            {
                $Domain = New-Object System.DirectoryServices.DirectoryEntry
                $Searcher = New-Object System.DirectoryServices.DirectorySearcher
            }
            $Searcher.SearchRoot = $Domain
            $Searcher.PageSize = 10
            $Searcher.Filter = $LDAPFilter
            $Searcher.SearchScope = "Subtree"

            $Result = $Searcher.FindOne()

            $Object = [ADSI]$Result.GetDirectoryEntry()

            if($Type -eq "SMTP")
            {
                # check if the address is assigned to the user and is primary
                if($Object.proxyAddresses.Contains("SMTP:" + $Address))
                {
                    Write-Error ("The address " + $Address + " is the primary SMTP address of the object " + $Identity)
                    return
                }

                # check if the address is assigned to the user
                if(!$Object.proxyAddresses.Contains("smtp:" + $Address))
                {
                    Write-Error ("The address " + $Address + " is not assigned to the object " + $Identity)
                    return
                }
                else
                {
                    Write-Verbose ("Removing proxy address 'smtp:" + $Address + "'")

                    # remove the current primary address
                    $Object.proxyAddresses.Remove("smtp:" + $Address) |
                        Out-Null
                }
            }
            else
            {
                foreach($pa in $Object.proxyAddresses)
                {
                    if($pa -eq ($Type + ":" + $Address))
                    {
                        # remove the current primary address
                        $Object.proxyAddresses.Remove($Type + ":" + $Address) |
                            Out-Null
                    }
                }                
            }

            try
            {
                $Object.CommitChanges()
                Write-Verbose "Object updated successfully"
            }
            catch
            {
                Write-Error ("Could not update the object " + $Result.Properties.distinguishedname)
                $Error[0].ErrorDetails
            }
        }
    }

    End {}
}
#endregion

#region Copy-RecipientAddress
Function Copy-RecipientAddress
{
    <#
        .SYNOPSIS
        Copy the addresses between recipients.
 
        .DESCRIPTION
        The Copy-RecipientAddress cmdlet copies the addresses assigned to a recipient including the SMTP, SIP, X400 and X500 addresses to another recipient.
     
        .PARAMETER Recipient
        Specifies the identity of the recipient.
 
        .PARAMETER Type
        Specifies the type of the addresses to return.
 
        .EXAMPLE
        Get-RecipientAddress -Identity $Mailbox.Identity -Type SMTP
 
        This command will return all the SMTP addresses of the mailbox saved in the Mailbox variable
 
        .EXAMPLE
        Get-Mailbox User1 | Get-RecipientAddress -Type SMTP
 
        This command will return all the SMTP addresses on the User1's mailbox
 
    #>

 
    [CmdletBinding(SupportsShouldProcess=$true, 
                  ConfirmImpact='High')]
    
    Param
    (
         [Parameter(
                   Position = 0,
                   Mandatory = $true,
                   ValueFromPipeline = $true,
                   ValueFromPipelineByPropertyName = $true
         )]  
        [string]$SourceObject,

         [Parameter(
                   Position = 0,
                   Mandatory = $true,
                   ValueFromPipeline = $true,
                   ValueFromPipelineByPropertyName = $true
         )]  
        [string]$TargetObject,

        [ValidateSet('All', 'SIP','SMTP','X500', 'X400', 'LDN')]
        [String]$Type = 'All',

        [Parameter()]
        $DomainController
    )
    Begin
    {
        # Check if Exchange cmdlets are available
        try
        {
            Get-Command "Get-MailboxServer" -ErrorAction Stop |
                Out-Null
            Write-Verbose "Exchange cmdlets are available."
        }
        catch
        {
            Throw "Exchange cmdlets are not available. Please use the Exchange Management Shell."
        }        
    }

    Process
    {
        if ($pscmdlet.ShouldProcess("$TargetObject", "Copy-RecipientAddress"))
        {
            #region Get the recipients
            Write-Verbose "Getting the recipients."
            # Get the source recipient
            try
            {
                if($DomainController)
                {
                    $sourceRecipient = Get-Recipient $SourceObject -DomainController $DomainController -ErrorAction Stop
                }
                else
                {
                    $sourceRecipient = Get-Recipient $SourceObject -ErrorAction Stop
                }
                Write-Verbose ("Found source object " + $sourceRecipient.Identity)
            }
            catch
            {
                Write-Error "Could not find a recipient with identity $SourceObject."
                continue
            }    

            # Get the destination recipient
            try
            {
                if($DomainController)
                {
                    $targetRecipient = Get-Recipient $TargetObject -ErrorAction Stop -DomainController $DomainController
                }
                else
                {
                    $targetRecipient = Get-Recipient $TargetObject -ErrorAction Stop
                }
                Write-Verbose ("Found target object " + $targetRecipient.Identity)
            }
            catch
            {
                Write-Error "Could not find a recipient with identity $TargetObject."
                continue
            }    
            #endregion

            #region Process the addresses

            Write-Verbose "Getting the recipients' addresses."

            # Temporarily set the verbose preference
            $vp = $VerbosePreference
            $VerbosePreference = 'SilentlyContinue'

            if($DomainController)
            {
                $sourceAddresses = Get-RecipientAddress -Identity $sourceRecipient.distinguishedName -DomainController $DomainController

                $targetAddresses = Get-RecipientAddress -Identity $targetRecipient.distinguishedName -DomainController $DomainController
            }
            else
            {
                $sourceAddresses = Get-RecipientAddress -Identity $sourceRecipient.distinguishedName

                $targetAddresses = Get-RecipientAddress -Identity $targetRecipient.distinguishedName
            }

            # Restore the verbose preference
            $VerbosePreference = $vp

            foreach($sa in $sourceAddresses)
            {
                #region Decide to add the address or not
                $add = $false

                if($Type -eq 'All')
                {
                    $add = $true
                }
                else
                {
                    if($Type -eq $sa.Type)
                    {
                        $add = $true
                    }
                    else
                    {
                        $add = $false
                    }
                }

                if($add -eq $true)
                {
                    # Check if the address is already assigned
                    $exists = $targetAddresses |
                                Where-Object {$_.type -eq $sa.Type -and $_.address -eq $sa.Address}

                    if($exists -ne $null)
                    {
                        $add = $false
                        Write-Verbose "The $($sa.Type) address $($sa.Address) already exists on target object."
                    }
                }

                #endregion

                #region Add the address
                if($add -eq $true)
                {
                    Write-Verbose "Adding $($sa.Type) address $($sa.Address) to target object."

                    # Temporarily set the verbose preference
                    $vp = $VerbosePreference
                    $VerbosePreference = 'SilentlyContinue'

                    # Add the address
                    if($DomainController)
                    {
                        New-RecipientAddress -Identity $targetRecipient.distinguishedname -Address $sa.Address -Type $sa.Type -Confirm:$false -DomainController $DomainController
                    }
                    else
                    {
                        New-RecipientAddress -Identity $targetRecipient.distinguishedname -Address $sa.Address -Type $sa.Type -Confirm:$false
                    }

                    # Restore the verbose preference
                    $VerbosePreference = $vp
                }
                #endregion
            }

            # Copy the Legacy-Exchange-DN
            if($Type -in ("All", "LDN"))
            {
                Write-Verbose "Copying Legacy-Exchange-DN as X500 address."

                # Find the object in Active Directory and add the address
                $dn = $sourceRecipient.DistinguishedName

                $LDAPFilter = "(distinguishedname=$dn)"

                if($DomainController)
                {
                    try
                    {
                        $Domain = New-Object System.DirectoryServices.DirectoryEntry -ArgumentList "LDAP://$DomainController"
                        $Searcher = New-Object System.DirectoryServices.DirectorySearcher -ArgumentList $Domain
                    }
                    catch
                    {
                        Write-Error "Could not contact the domain controller."
                        return
                    }
                }
                else
                {
                    $Domain = New-Object System.DirectoryServices.DirectoryEntry
                    $Searcher = New-Object System.DirectoryServices.DirectorySearcher
                }

                $Searcher.SearchRoot = $Domain
                $Searcher.PageSize = 10
                $Searcher.Filter = $LDAPFilter
                $Searcher.SearchScope = "Subtree"

                $Result = $Searcher.FindOne()

                $Object = [ADSI]$Result.GetDirectoryEntry()

                # Temporarily set the verbose preference
                $vp = $VerbosePreference
                $VerbosePreference = 'SilentlyContinue'

                # Add the address
                if($DomainController)
                {
                    New-RecipientAddress -Identity $targetRecipient.distinguishedname -Address $Object.LegacyExchangeDN -Type X500 -DomainController $DomainController -Confirm:$false
                }
                else
                {
                    New-RecipientAddress -Identity $targetRecipient.distinguishedname -Address $Object.LegacyExchangeDN -Type X500 -Confirm:$false
                }

                # Restore the verbose preference
                $VerbosePreference = $vp                
            }

            #endregion
        }
    }

    End{}
}
#endregion

#endregion

#region Exports
Export-ModuleMember -Function Get-RecipientAddress
Export-ModuleMember -Function New-RecipientAddress
Export-ModuleMember -Function Remove-RecipientAddress
Export-ModuleMember -Function Copy-RecipientAddress
#endregion