Skip to content

Users Gmail Send As Signature Vacation

Dominik Kugelmann edited this page Aug 26, 2020 · 37 revisions

Users - Gmail - Send As/Signature/Vacation

API documentation

Definitions

<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>

Manage sendas

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

Display sendas

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.

Manage signature

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>]

Display signature

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.

Manage vacation

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

Display vacation

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.

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally