Add-GSUserEmail¶
SYNOPSIS¶
Builds a Email object to use when creating or updating a User
SYNTAX¶
Fields¶
Add-GSUserEmail [-Address <String>] [-CustomType <String>] [-Primary] [-Type <String>] [<CommonParameters>]
InputObject¶
Add-GSUserEmail [-InputObject <UserEmail[]>] [<CommonParameters>]
DESCRIPTION¶
Builds a Email object to use when creating or updating a User
EXAMPLES¶
EXAMPLE 1¶
$address = Add-GSUserAddress -Country USA -Locality Dallas -PostalCode 75000 Region TX -StreetAddress '123 South St' -Type Work -Primary
$phone = Add-GSUserPhone -Type Work -Value "(800) 873-0923" -Primary
$extId = Add-GSUserExternalId -Type Login_Id -Value jsmith2
$email = Add-GSUserEmail -Type work -Address [email protected]
New-GSUser -PrimaryEmail [email protected] -GivenName John -FamilyName Smith -Password (ConvertTo-SecureString -String 'Password123' -AsPlainText -Force) -ChangePasswordAtNextLogin -OrgUnitPath "/Users/New Hires" -IncludeInGlobalAddressList -Addresses $address -Phones $phone -ExternalIds $extId -Emails $email
Creates a user named John Smith and adds their work address, work phone, login_id and alternate non gsuite work email to the user object.
PARAMETERS¶
-Address¶
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
Type: String Parameter Sets: Fields Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-CustomType¶
If the value of type is custom, this property contains the custom type.
Type: String Parameter Sets: Fields Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-InputObject¶
Used for pipeline input of an existing Email object to strip the extra attributes and prevent errors
Type: UserEmail[] Parameter Sets: InputObject Aliases: Required: False Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False
-Primary¶
Indicates if this is the user's primary email. Only one entry can be marked as primary.
Type: SwitchParameter Parameter Sets: Fields Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False
-Type¶
The type of the email account.
Acceptable values are: * "custom" * "home" * "other" * "work"
Type: String Parameter Sets: Fields Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.