Add-QADProxyAddress
From PowerGUI Wiki
Add e-mail addresses for an Exchange recipient.
This cmdlet is part of the Quest ActiveRoles Server product. Use Get-QARSProductInfo to view information about ActiveRoles Server.
Contents |
Syntax
Add-QADProxyAddress [-Address] <string> -CurrentAddresses <ProxyAddressChangesUI> [-CustomType <string>] [-Primary] [-Type <ProxyAddressType>] [-Confirm] [-WhatIf] [<CommonParameters>]
Add-QADProxyAddress [-Address] <string> -DirObject <IGenericDirectoryObject> [-CustomType <string>] [-Primary] [-Type <ProxyAddressType>] [-Confirm] [-WhatIf] [<CommonParameters>]
Detailed Description
Use this cmdlet to add an e-mail address for an Exchange recipient. You can add an SMTP e-mail address (default), or you can an e-mail address of a custom type, such as an X400, GroupWise, or Lotus Notes address type. It is also possible to specify an arbitrary custom e-mail address type. Since Exchange does not validate custom addresses for proper formatting, you must ensure that the custom address you specify complies with the format requirements for that address type. Because X.400 addresses are considered custom addresses in Exchange, they are also not validated. Therefore, you must provide the correct syntax when specifying an X.400 address.
The cmdlet allows you to identify the Exchange recipient by passing through the pipeline the corresponding output object of a Get-QAD* cmdlet. In this case, the DirObject parameter is used to receive the output object. Another way to identify the Exchange recipient is by passing the output of an *-QADProxyAddress cmdlet, in which case it is the CurrentAddresses parameter that receives the output object (see examples).
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Address | Use this parameter to specify the e-mail address to add, such as 'jsmith@company.com'. You could prepend the address with a prefix to specify the address type, such as 'X400:C=US;A=;O=Exchange;S=Smith;G=John'. If you do not add a prefix, you can specify the address type through the Type or CustomType parameter. By default, the address type is set to SMTP. | true | true (ByPropertyName) | |
| CurrentAddresses | This parameter is intended to receive an output object of an *-QADProxyAddress cmdlet, and is instrumental in a scenario where multiple e-mail address changes need to be applied to a single recipient. | true | true (ByValue) | |
| CustomType | Use this parameter to specify an arbitrary custom address type. The e-mail address type is the identifying proxy information for the e-mail address. Exchange uses this information to determine how to process the e-mail address. The e-mail address type cannot exceed 9 characters. | false | false | |
| DirObject | This parameter is intended to receive the object that represents the Exchange recipient. This could be an output object of a Get-QAD* cmdlet. | true | true (ByValue) | |
| Primary | Supply this parameter to set the e-mail address as the primary or "reply to" address. When the recipient sends an e-mail message, this is the e-mail address that is seen by other users and is the address to which they reply.
A recipient can have multiple e-mail addresses for a specific address type. This allows the recipient to receive messages that are addressed to any one of these e-mail addresses. However, a single address must be designated as the "reply to" address for each address type. An e-mail address that is designated as the "reply to" address is also considered the primary address for the specific address type. | false | false | |
| Type | Use this parameter to specify the address type of the e-mail address to add. The possible parameter values are:
- SMTP (this address type is used if the Type and CustomType parameters are omitted) - X400 - MS (MS Mail address type) - CCMAIL (ccMail address type) - MSA (MS Mail address type) - NOTES (Lotus Notes address type) - GWISE (Novell GroupWise address type) | false | false | |
| Confirm | Prompts you for confirmation before executing the command. | false | false | |
| WhatIf | Describes what would happen if you executed the command without actually executing the command. | false | false |
Examples
EXAMPLE 1
Get-QADUser company\jsmith | Add-QADProxyAddress -Address 'smtp:jsmith@company.com' | Add-QADProxyAddress -Type SMTP -Address 'john.smith@company.com' -Primary | Add-QADProxyAddress -CustomType 'sip' -Address 'john.smith@company.com'
Description
Add three e-mail addresses for a particular user mailbox. This command adds two SMTP addresses, one of which is set as the primary SMTP address, and a single e-mail address of a custom type. The first instance of Add-QADProxyAddress receives the user object through the DirObject parameter, whereas the other Add-QADProxyAddress instances rely on the CurrentAddresses parameter to receive the object that identifies the recipient.
EXAMPLE 2
Get-QADUser company\jsmith | Clear-QADProxyAddress | Add-QADProxyAddress -Address 'smtp:jsmith@company.com' | Add-QADProxyAddress -Type SMTP -Address 'john.smith@company.com' -Primary | Add-QADProxyAddress -CustomType 'sip' -Address 'john.smith@company.com'
Description
For a particular user mailbox, replace all the existing e-mail addresses with three other e-mail addresses. In this command, Clear-QADProxyAddress removes the existing addresses, and then Add-QADProxyAddress adds two SMTP addresses, one of which is set as the primary SMTP address, and a single e-mail address of a custom type. Clear-QADProxyAddress receives the user object through the DirObject parameter, whereas the Add-QADProxyAddress instances rely on the CurrentAddresses parameter to receive the object that identifies the recipient.
EXAMPLE 3
Get-QADUser company\jsmith | Add-QADProxyAddress -Address 'smtp:john.smith@company.com' -Primary | Remove-QADProxyAddress -Pattern '*@company.com'
Description
For a given user mailbox, replace the e-mail addresses that match a particular pattern with a new primary SMTP address.
