Update-PEmailAddress

NAME Update-PEmailAddress



SYNOPSIS

Updates an email address.





SYNTAX

Update-PEmailAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> [-EmailId <Int32>] [-EmailAddress

<MailAddress>] [-EmailType <String>] [-Primary <Int32>] [-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm]

[<CommonParameters>]



Update-PEmailAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> [-EmailId <Int32>] [-EmailAddress

<MailAddress>] [-OrgEmailType <String>] [-Primary <Int32>] [-Old <Int32>] [-Public <Int32>] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

Updates an email address using the given parameters. Review the parameters for specific requirements and settings.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

The current user must have the Staff role or else be updating an email address on his/her own profile.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EmailId <Int32>

Numeric ID of the email address. Required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-EmailAddress <MailAddress>

e.g. bob@example.com



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EmailType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OrgEmailType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Primary <Int32>

Use if you want to mark the email address as primary or not primary. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Old <Int32>

Use if you want to mark the email address as old or not old. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Public <Int32>

Use if you want to mark the email address as public or not public. e.g. 1 or 0



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns PowerShell object:

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 12/17/2018

Updated: 11/06/2019



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>#Update email address with a person email id.



Update-PEmailAddress -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'

-EmailId '7781234' -EmailAddress 'bob@school.edu' -EmailType SCHOOL









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Update email address with an organizational email id.



Update-PEmailAddress -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'

-EmailId '2265253' -EmailAddress 'org@school.edu' -OrgEmailType WORK











RELATED LINKS