-
Notifications
You must be signed in to change notification settings - Fork 88
Users Gmail Send As Signature Vacation
- API documentation
- Collections of Users
- Definitions
- Manage sendas
- Display sendas
- Manage signature
- Display signature
- Manage vacation
- Display vacation
- User attribute
replace <Tag> <UserReplacement>
processing
- https://developers.google.com/gmail/api/v1/reference/users/settings/sendAs
- https://developers.google.com/gmail/api/v1/reference/users/settings
<UserGoogleDoc> ::=
<EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>|(<TeamDriveEntity> <TeamDriveFileNameEntity>)
<FalseValues>= false|off|no|disabled|0
<TrueValues> ::= true|on|yes|enabled|1
<DomainName> ::= <String>(.<String>)+
<EmailAddress> ::= <String>@<DomainName>
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
<EmailAddressEntity> ::=
<EmailAddressList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>
<Charset> ::= ascii|mbcs|utf-8|utf-8-sig|utf-16|<String>
<Password> ::= <String>
<SMTPHostName> ::= <String>
<Tag> ::= <String>
<UserName> ::= <String>
<UserReplacement> ::=
(field:<UserReplacementFieldName>)|(schema:<SchemaName>.<FieldName>)|<String>
gam <UserTypeEntity> [create|add] sendas <EmailAddress> <String>
[signature|sig|htmlsig <String>|(file|htmlfile <FileName> [charset <CharSet>])|(gdoc|ghtml <UserGoogleDoc>)
(replace <Tag> <UserReplacement>)*]
[html [<Boolean>]] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
[smtpmsa.host <SMTPHostName> smtpmsa.port 25|465|587
smtpmsa.username <UserName> smtpmsa.password <Password>
[smtpmsa.securitymode none|ssl|starttls]]
gam <UserTypeEntity> update sendas <EmailAddress> [name <String>]
[signature|sig|htmlsig <String>|(file|htmlfile <FileName> [charset <CharSet>])|(gdoc|ghtml <UserGoogleDoc>)
(replace <Tag> <UserReplacement>)*]
[html [<Boolean>]] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
gam <UserTypeEntity> delete sendas <EmailAddressEntity>
You can allow users to send mail through an external SMTP server when configuring a sendas address hosted outside your email domains. You must enable this capability in Admin Console/Apps/G Suite/Gmail/Advanced settings/End User Access/Allow per-user outbound gateways.
Example:
Paul shall send emails from the marketing email address with the name Paul from Example" and replies shall go back to them.
gam user paul add sendas [email protected] "Paul from Example" replyto paul
gam <UserTypeEntity> info sendas <EmailAddressEntity> [compact|format|html]
gam <UserTypeEntity> show sendas [compact|format|html]
Gam displays the information as an indented list of keys and values.
These are the output formatting options:
-
compact
- Escape carriage returns as \r and newlines as \n in original HTML; this format produces output that can be used as input to GAM -
format
- Strip HTML keywords leaving basic printable information -
html
- Show original HTML; this is the default option; the output is human readable but cannot be used an input to GAM
gam <UserTypeEntity> print sendas [compact] [todrive <ToDriveAttribute>*]
Gam displays the information in CSV form.
-
compact
- Strip carriage returns and newlines in original HTML; this makes these values easier to process in the CSV file and can be used as input to GAM.
gam <UserTypeEntity> signature|sig
<String>|(htmlsig <String>)|(file|htmlfile <FileName> [charset <Charset>])|(gdoc|ghtml <UserGoogleDoc>)
(replace <Tag> <UserReplacement>)*
[html [<Boolean>]] [name <String>] [replyto <EmailAddress>]
[default] [primary] [treatasalias <Boolean>]
gam <UserTypeEntity> show signature|sig [compact|format|html] [primary]
Gam displays the information as an indented list of keys and values.
These are the output formatting options:
-
compact
- Escape carriage returns as \r and newlines as \n in original HTML; this format produces output that can be used as input to GAM -
format
- Strip HTML keywords leaving basic printable information -
html
- Show original HTML; this is the default option; the output is human readable but cannot be used an input to GAM
gam <UserTypeEntity> print signature [compact] [todrive <ToDriveAttribute>*]
Gam displays the information in CSV form.
-
compact
- Strip carriage returns and newlines in original HTML; this makes these values easier to process in the CSV file and can be used as input to GAM.
gam <UserTypeEntity> vacation <Boolean> subject <String>
[message|htmlmessage <String>|(file|htmlfile <FileName> [charset <CharSet>])|(gdoc|ghtml <UserGoogleDoc>)]
(replace <Tag> <UserReplacement>)*
[html [<Boolean>]] [contactsonly [<Boolean>]] [domainonly [<Boolean>]]
[start|startdate <Date>|Started] [end|enddate <Date>|NotSpecified]
It's highly recommended to set (overwrite) start and end date. Otherwise it may not work for users who used vacation messages previously and where the end date is already expired.
Example:
gam [email protected] vacation ON subject "[Out of Office]" file autoreply.eml start 2000-01-01 end 2999-01-01
gam <UserTypeEntity> show vacation [compact|format|html] [enabledonly]
Gam displays the information as an indented list of keys and values.
These are the output formatting options:
-
compact
- Escape carriage returns as \r and newlines as \n in original HTML; this format produces output that can be used as input to GAM -
format
- Strip HTML keywords leaving basic printable information -
html
- Show original HTML; this is the default option; the output is human readable but cannot be used an input to GAM -
enabledonly
- Do not display users with vacation autoreply disabled.
gam <UserTypeEntity> print vacation [compact] [enabledonly] [todrive <ToDriveAttribute>*]
Gam displays the information in CSV form.
-
compact
- Strip carriage returns and newlines in original HTML; this makes these values easier to process in the CSV file and can be used as input to GAM. -
enabledonly
- Do not display users with vacation autoreply disabled.
Need more help? Ask on the GAM Discussion Group
Update History
Installation
- How to Install GAM7
- How to Uograde GAMADV-XTD3 to GAM7
- How to Upgrade Legacy GAM to GAM7
- How to Update GAM7
- Install GAM as Python Library
- GAM7 on Chrome OS Devices
- GAM7 on Android Devices
- Google Network Addresses
- HTTPS Proxy
- SSL Root CA Certificates
- How to Uninstall GAM7
Configuration
- Authorization
- GAM Configuration
- Running GAM7 securely on a Google Compute Engine
- Using GAM7 with a delegated admin service account
- Using GAM7 with a YubiKey
Notes and Information
- Upgrade Benefits
- Questions? Visit the GAM Discussion Forum
- GAM Public Chat Room
- Scripts
- Other Resources
- Drive REST API v3
- BNF Syntax
- GAM Return Codes
- Python Regular Expressions
- Rclone
Definitions
Command Processing
- Bulk Processing
- Command Line Parsing
- Command Logging and Progress
- Command data from Google Docs/Sheets/Storage
- CSV Special Characters
- CSV Input Filtering
- CSV Output Filtering
- Meta Commands and File Redirection
- Permission matches
- Tag Replace
- Todrive
Collections
Client Access
- Addresses
- Administrators
- Alert Center
- Aliases
- Calendars
- Calendars - Access
- Calendars - Events
- Chrome Auto Update Expiration Counts
- Chrome Browser Cloud Management
- Chrome Device Needs Attention Counts
- Chrome Installed Apps
- Chrome Policies
- Chrome Printers
- Chrome Profile Management
- Chrome Version Counts
- Chrome Version History
- ChromeOS Devices
- Classroom - Courses
- Classroom - Guardians
- Classroom - Invitations
- Classroom - Membership
- Cloud Channel
- Cloud Identity Devices
- Cloud Identity Groups
- Cloud Identity Groups - Membership
- Cloud Identity Policies
- Cloud Storage
- Context Aware Access Levels
- Customer
- Domains
- Domains - Verification
- Domain People - Contacts & Profiles
- Domain Shared Contacts - Global Address List
- Email Audit Monitor
- Find File Owner
- Google Data Transfers
- Groups
- Groups - Membership
- Inbound SSO
- Licenses
- Mobile Devices
- Organizational Units
- Reports
- Reseller
- Resources
- Send Email
- Schemas
- Shared Drives
- Sites
- Users
- Unmanaged Accounts
- Users - Signout and Turn off 2-Step Verification
- Vault - Takeout
- Version and Help
Special Service Account Access
Service Account Access
- Users - Analytics Admin
- Users - Application Specific Passwords
- Users - Backup Verification Codes
- Users - Calendars
- Users - Calendars - Access
- Users - Calendars - Events
- Users - Chat
- Users - Classification Labels
- Users - Classroom - Profile
- Users - Deprovision
- Users - Contacts
- Users - Contacts - Delegates
- Users - Drive - File Selection
- Users - Drive - Activity/Settings
- Users - Drive - Cleanup
- Users - Drive - Comments
- Users - Drive - Copy/Move
- Users - Drive - Files-Display
- Users - Drive - Files-Manage
- Users - Drive - Orphans
- Users - Drive - Ownership
- Users - Drive - Permissions
- Users - Drive - Query
- Users - Drive - Revisions
- Users - Drive - Shortcuts
- Users - Drive - Transfer
- Users - Forms
- Users - Gmail - Client Side Encryption
- Users - Gmail - Delegates
- Users - Gmail - Filters
- Users - Gmail - Forwarding
- Users - Gmail - Labels
- Users - Gmail - Messages/Threads
- Users - Gmail - Profile
- Users - Gmail - S/MIME
- Users - Gmail - SendAs/Signature/Vacation
- Users - Gmail - Settings
- Users - Group Membership
- Users - Keep
- Users - Looker Studio
- Users - Meet
- Users - Classroom - Profile
- Users - People - Contacts & Profiles
- Users - Photo
- Users - Profile Sharing
- Users - Shared Drives
- Users - Spreadsheets
- Users - Tasks
- Users - Tokens
- Users - YouTube