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
#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
    )
    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
            {
                $r = Get-Recipient $i
                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
                }

                $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')]
        [string]$Type = 'SMTP',
 
        [Parameter(
            Mandatory = $false
        )]
        [switch]$Primary,

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

    Begin {}

    Process
    {
        if($PSCmdlet.ShouldProcess($Identity))
        {
            # Get the recipient
            try
            {
                $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")
            {
                try
                {
                    $existingRecipient = Get-Recipient $Address -ErrorAction Stop
                    Write-Error ("The address $Address is already assigned to the object " + $existingRecipient.Identity + ".")
                    return
                }
                catch
                {
                }

                if($Primary)
                {
                    $AddressToAdd = "SMTP:"
                }
                else
                {
                    $AddressToAdd = "smtp:"
                }

                $AddressToAdd += $Address
            }

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

            $LDAPFilter = "(distinguishedname=$dn)"

            $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(!$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')]
        [string]$Type = 'SMTP'
     )

    Begin {}

    Process
    {
        if($PSCmdlet.ShouldProcess($Identity))
        {
            # Get the recipient
            try
            {
                $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)"

            $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
                }
            }

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

    End {}
}
#endregion

#endregion

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