Get-GitHubUserEmail

SYNOPSIS

List email addresses for the authenticated user

SYNTAX

__AllParameterSets

Get-GitHubUserEmail [[-PerPage] <int>] [[-Context] <Object>] [-Public] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope. Specifying '-Public' will return only the publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint.

EXAMPLES

EXAMPLE 1

Get-GitHubUserEmail

Gets all email addresses for the authenticated user.

EXAMPLE 2

Get-GitHubUserEmail -Public

Gets the publicly visible email address for the authenticated user.

PARAMETERS

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PerPage

The number of results per page (max 100).

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Public

Get the publicly visible email address for the authenticated user.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSObject

{{ Fill in the Description }}

NOTES

List email addresses for the authenticated user List public email addresses for the authenticated user

RELATED LINKS