Add-PEmailAddress

NAME Add-PEmailAddress



SYNOPSIS

Adds an email to a person or organization.





SYNTAX

Add-PEmailAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-EmailAddress <MailAddress>]

[-EmailType <String>] [-Primary <Int32>] [-Public <Int32>] [<CommonParameters>]



Add-PEmailAddress [-PopuliUri] <String> [-PopuliAuthkey] <String> -OrganizationId <Int32> [-EmailAddress

<MailAddress>] [-OrgEmailType <String>] [-Primary <Int32>] [-Public <Int32>] [<CommonParameters>]





DESCRIPTION

Adds 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



-PersonId <Int32>

Numeric ID of the person to whose profile you are attaching this email address.

This Parameter is not required. (but either person_id OR organization_id MUST be set)



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-OrganizationId <Int32>

Numeric ID of the organization to whose profile you are attaching this email address.

This Parameter is not required. (but either person_id OR organization_id MUST be set)



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-EmailAddress <MailAddress>

e.g. bob@example.com

This parameter is required.



Required? true

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



-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



<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:

EmailId





NOTES





Author: Matthew Rehm

Creation Date: 01/02/2019

Updated: 04/25/2019



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



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

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













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



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

-OrganizationId '7781234' -EmailAddress 'org@school.edu' -OrgEmailType OTHER















RELATED LINKS