Check out PSGSuite.io for PSGSuite documentation, including initial setup help as well as function help!
Interested in helping out with PSGSuite development? Please check out our Contribution Guidelines!
Building the module locally to test changes is as easy as running the build.ps1
file in the root of the repo. This will compile the module with your changes and import the newly compiled module at the end by default.
Want to run the Pester tests locally? Pass Test
as the value to the Task
script parameter like so:
.\build.ps1 -Task Test
Please adhere to our Code of Conduct when interacting with this repo.
The Gmail API does not yet support handling inbox delegation. The functionality addition has been pushed back again until Q3 of 2018. Once the Gmail API supports inbox delegation, those functions will be added.
Delegation functions have been re-added to PSGSuite as of v2.4.0! Update now to get all the goodness of v2 + delegation commands!
Please note that not all functions were ported to PSGSuite 2.0.0 due to restrictions within the .NET SDK and deprecated API calls. Here is the list of functions no longer existing in PSGSuite as of 2.0.0:
Get-GSToken
: no need for this as the keys are being consumed by Googles Auth SDK directly now, which makes Access/Refresh tokens non-existent for P12 Key service accounts and token management is handled automaticallyRevoke-GSToken
: same here, no longer needed due to auth service changesStart-PSGSuiteConfigWizard
: no longer supported as WPF is not compatible outside of WindowsAll other functions are either intact or have an alias included to support backwards compatibility in scripts. Full list of aliases:
Alias | Maps To |
---|---|
Add-GSDriveFilePermissions | Add-GSDrivePermission |
Export-PSGSuiteConfiguration | Set-PSGSuiteConfig |
Get-GSCalendarEventList | Get-GSCalendarEvent |
Get-GSCalendarResourceList | Get-GSResourceList |
Get-GSDataTransferApplicationList | Get-GSDataTransferApplication |
Get-GSDriveFileInfo | Get-GSDriveFile |
Get-GSDriveFilePermissionsList | Get-GSDrivePermission |
Get-GSGmailDelegates | Get-GSGmailDelegate |
Get-GSGmailFilterList | Get-GSGmailFilter |
Get-GSGmailLabelList | Get-GSGmailLabel |
Get-GSGmailMessageInfo | Get-GSGmailMessage |
Get-GSGmailSendAsSettings | Get-GSGmailSendAsAlias |
Get-GSGmailSignature | Get-GSGmailSendAsAlias |
Get-GSGroupList | Get-GSGroup |
Get-GSGroupMemberList | Get-GSGroupMember |
Get-GSMobileDeviceList | Get-GSMobileDevice |
Get-GSOrganizationalUnitList | Get-GSOrganizationalUnit |
Get-GSOrgUnit | Get-GSOrganizationalUnit |
Get-GSOrgUnitList | Get-GSOrganizationalUnit |
Get-GSOU | Get-GSOrganizationalUnit |
Get-GSResourceList | Get-GSResource |
Get-GSShortURLInfo | Get-GSShortURL |
Get-GSTeamDrive | Get-GSDrive |
Get-GSTeamDrivesList | Get-GSDrive |
Get-GSUserASPList | Get-GSUserASP |
Get-GSUserLicenseInfo | Get-GSUserLicense |
Get-GSUserLicenseList | Get-GSUserLicense |
Get-GSUserList | Get-GSUser |
Get-GSUserSchemaInfo | Get-GSUserSchema |
Get-GSUserSchemaList | Get-GSUserSchema |
Get-GSUserTokenList | Get-GSUserToken |
Import-PSGSuiteConfiguration | Get-PSGSuiteConfig |
Move-GSGmailMessageToTrash | Remove-GSGmailMessage |
New-GSCalendarResource | New-GSResource |
Remove-GSGmailMessageFromTrash | Restore-GSGmailMessage |
Set-PSGSuiteDefaultDomain | Switch-PSGSuiteConfig |
Switch-PSGSuiteDomain | Switch-PSGSuiteConfig |
Update-GSCalendarResource | Update-GSResource |
Update-GSGmailSendAsSettings | Update-GSGmailSendAsAlias |
Update-GSSheetValue | Export-GSSheet |
CheckAll
switch on Get-GSUserLicense
.CheckAll
switch parameter to Get-GSUserLicense
User
parameter aliases for all *-GSUserLicense
functions to include UserId
for better pipeline support.[SecureString]
decryption on Unix machines running PowerShell 7 (found additional bugs)Encrypt
and Decrypt
to EncryptionHelpers.ps1
in the Private folder to allow a single place to update.[ScriptBlock]
values on the config, allowing you to provide a script to run that will pull in a configuration value (vs embedded the value directly on the config)Get-GSGmailMessageList
Remove-GSDriveFile
.Send-GSChatMessage
.[SecureString]
decryption on Unix machines running PowerShell 7