Skip to content

Set GEmailSettingsVacationResponder

Spencer Varney edited this page Dec 9, 2016 · 5 revisions

Deprectiation Notice: The Email Settings API is deprecated and will be turned off on July 7, 2017. Migrate to the Gmail API as soon as possible to avoid disruptions to your application. See the following URL for more information: https://developers.google.com/admin-sdk/email-settings/

Set-GEmailSettingsVacationResponder

SYNOPSIS

Update Google Mail vacation-responder settings.

SYNTAX

Set-GEmailSettingsVacationResponder [-UserName] <String> [-ContactsOnly] <Boolean> [[-DomainOnly] <Boolean>]
 [-Enable] <Boolean> [-EndDate] <DateTime> [-Message] <String> [-StartDate] <DateTime> [-Subject] <String>
 [-Domain <String>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Update Google Mail vacation-responder settings.

EXAMPLES

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

PS C:\> Get-GEmailSettingsVacationResponder -UserName $SomeUserNameString -ContactsOnly $SomeContactsOnlyBool
              -Enable $SomeEnableBool -EndDate $SomeEndDateTimeObject -Message $SomeMessageString -StartDate $SomeStartDateTimeObject -Subject $SomeSubjectString

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

-UserName

The target Google Apps user.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ContactsOnly

Whether to only send the autoresponse to known contacts.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-DomainOnly

Whether to only send the autoresponse to users in the same primary domain as the user taking the vacation.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Enable

Whether to enable the vacation-responder.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EndDate

The last day until which vacation responder is enabled for the user. In this version of the API, the endDate is the UTC timezone, not the user's timezone. Also see the startDate property.

Type: DateTime
Parameter Sets: (All)
Aliases: 

Required: True
Position: 5
Default value: 1/1/0001 12:00:00 AM
Accept pipeline input: False
Accept wildcard characters: False

-Message

The message body of the vacation-responder autoresponse.

Type: String
Parameter Sets: (All)
Aliases: 

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

-StartDate

The first day when the vacation responder was enabled for the user. In this version of the API, the startDate is in the UTC timezone, not the user's timezone. Also see the endDate property.

Type: DateTime
Parameter Sets: (All)
Aliases: 

Required: True
Position: 7
Default value: 1/1/0001 12:00:00 AM
Accept pipeline input: False
Accept wildcard characters: False

-Subject

The subject line of the vacation-responder autoresponse.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 8
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Domain

The target domain for this email settings cmdlet.

Type: String
Parameter Sets: (All)
Aliases: 

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

-GAuthId

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

INPUTS

System.String

The target domain for this email settings cmdlet.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally