Skip to content

New GGmailVacationSettingsObj

Spencer Varney edited this page Dec 14, 2016 · 1 revision

New-GGmailVacationSettingsObj

SYNOPSIS

Creates a new Gmail API VacationSettings object.

SYNTAX

New-GGmailVacationSettingsObj [[-EnableAutoReply] <Boolean>] [[-EndTime] <Int64>]
 [[-ResponseBodyHtml] <String>] [[-ResponseBodyPlainText] <String>] [[-ResponseSubject] <String>]
 [[-RestrictToContacts] <Boolean>] [[-RestrictToDomain] <Boolean>] [[-StartTime] <Int64>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a VacationSettings object which may be required as a parameter for some other Cmdlets in the Gmail API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.Gmail.v1.Data.VacationSettings

EXAMPLES

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

PS C:\>New-GGmailVacationSettingsObj

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.

PARAMETERS

-EnableAutoReply

Flag that controls whether Gmail automatically replies to messages.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EndTime

An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Type: Int64
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResponseBodyHtml

Response body in HTML format. Gmail will sanitize the HTML before storing it.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResponseBodyPlainText

Response body in plain text format.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResponseSubject

Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RestrictToContacts

Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RestrictToDomain

Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StartTime

An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.

Type: Int64
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.Boolean

Flag that controls whether Gmail automatically replies to messages.

System.Int64

An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

System.String

Response body in HTML format. Gmail will sanitize the HTML before storing it.

System.String

Response body in plain text format.

System.String

Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.

System.Boolean

Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.

System.Boolean

Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.

System.Int64

An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.

OUTPUTS

Google.Apis.Gmail.v1.Data.VacationSettings

NOTES

Part of the gShell Project, relating to the Google Gmail API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally