-
Notifications
You must be signed in to change notification settings - Fork 10
Get GGmailThread
Gets the specified thread.
Get-GGmailThread [-UserId] <String> [-Id] <String> [[-Format] <FormatEnum>] [[-MetadataHeaders] <String[]>]
[-TargetUserEmail <String>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
[-Confirm]
Get-GGmailThread [-UserId] <String> [-All] [[-IncludeSpamTrash] <Boolean>] [[-LabelIds] <String[]>]
[[-MaxResults] <Int32>] [[-Query] <String>] [-TargetUserEmail <String>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Gets the specified thread.
PS C:\> Get-GGmailThread -UserId $SomeUserIdString -Id $SomeIdString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
PS C:\> Get-GGmailThread -UserId $SomeUserIdString -All
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
The user's email address. The special value me can be used to indicate the authenticated user.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe ID of the thread to retrieve.
Type: String
Parameter Sets: one
Aliases:
Required: True
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe format to return the messages in.
Possible values: Full, Metadata, Minimal
Type: FormatEnum
Parameter Sets: one
Aliases:
Accepted values: Full, Metadata, Minimal
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhen given and format is METADATA, only include headers specified.
Type: String[]
Parameter Sets: one
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA switch to list all results
Type: SwitchParameter
Parameter Sets: list
Aliases:
Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseInclude threads from SPAM and TRASH in the results.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOnly return threads with labels that match all of the specified label IDs.
Type: String[]
Parameter Sets: list
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of threads to return.
Type: Int32
Parameter Sets: list
Aliases:
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOnly return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:[email protected] rfc822msgid: is:unread".
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email account to be targeted by the service account.
Type: String
Parameter Sets: (All)
Aliases: ServiceAccountTarget
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe user's email address. The special value me can be used to indicate the authenticated user.
The ID of the thread to retrieve.
The format to return the messages in.
When given and format is METADATA, only include headers specified.
Include threads from SPAM and TRASH in the results.
Only return threads with labels that match all of the specified label IDs.
Maximum number of threads to return.
Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:[email protected] rfc822msgid: is:unread".
Part of the gShell Project, relating to the Google Gmail API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads