Skip to content

l GAM3GroupSettings

Jump to bottom
Ross Scroggs edited this page Nov 16, 2024 · 1 revision

Enabling Google Groups for Business

In order to make use of the advanced Group Settings for your Google Apps domain, you need to have the Google Groups for Business service enabled for your domain. Please verify that you've enabled the service by following Google's instructions.

Updating Group Settings

You can update all of the group settings listed by the

gam update group <group>

command. You can also specify any of these group settings during group creation. For example:

gam create group [email protected] max_message_size 25M

The commands below are broken up below to only discuss one group setting for each area but they can easily be combined. For example you could change both the archive status, group name and description with a command like:

gam update group [email protected] is_archived true name "Example Employees" description "list of example employees"

Allow External Members

Syntax

gam update group <group> allow_external_members true|false

Whether or not group owners are allowed to add users outside the Google Apps domain to the group. Google Apps admins should always be able to add external email addresses to the group.

Example

This example prevents group owners from adding users outside the Google Apps domain to the employees group

gam update group [email protected] allow_external_members false

Message Moderation Level

Syntax

gam update group <group> message_moderation_level moderate_all_messages|moderate_new_members|moderate_none|moderate_non_members

The level of moderation that the group should have. moderate_all_messages will require a owner/manager to approve all messages sent to the group before they are emailed or viewable by group members. moderate_new_members places only new group members under moderation. moderate_none disables group moderation completely. moderate_non_members will moderate only messages sent to the group from email addresses that are not a member of the group.

Example

This example sets the group to moderate new members

gam update group [email protected] message_moderation_level moderate_new_members

Primary Language

Syntax

gam update group <group> primary_language <language>

Update the primary language used by the group. For a list of valid languages see here.

Example

This command sets the primary language for the english majors group to US English.

gam update group [email protected] primary_language en-US

Reply To

Syntax

gam update group <group> reply_to reply_to_custom|reply_to_ignore|reply_to_list|reply_to_managers|reply_to_owner|reply_to_sender

Determine who, by default replies to group messages will be directed to. reply_to_custom will use the email address set with the custom_reply_to command (suggest you combine these commands, see example). reply_to_ignore allows the group users to decide individually where the reply will go to. reply_to_list directs the reply back to the list address. reply_to_managers will direct replies to the group's managers/owners. reply_to_owner will direct replies to the group's owners. reply_to_sender directs replies at the sender of the original message.

Example

This command sets the reply to a custom address, the custom address is also set to [email protected] by the custom_reply_to command.

gam update group [email protected] reply_to reply_to_custom custom_reply_to [email protected]

This command sets the reply to go back to the list

gam update group [email protected] reply_to reply_to_list

Send Message Deny Notification

Syntax

gam update group <group> send_message_deny_notification true|false

Determine whether or not the text of message_deny_notification_text is sent to the sender of rejected messages. If this setting is true, message_deny_notification_text should also be set to something.

Example

This example turns message deny notification off for [email protected].

gam update group [email protected] send_message_deny_notification false

Show In Groups Directory

Syntax

gam update group <group> show_in_group_directory true|false

Should the group be listed in the master list of all groups shown to users.

Note: If you have "Group owners can hide groups from the groups directory" unchecked under Settings, Google Groups for Business within the Google Apps Control Panel, this setting will remain true for all groups and attempts to make it false will have no effect.

Example

This example removes the [email protected] group from the group directory listing.

gam update group <group> show_in_group_directory false

Who Can Invite

Syntax

gam update group <group> who_can_invite ALL_MEMBERS_CAN_INVITE|ALL_MANAGERS_CAN_INVITE|NONE_CAN_INVITE

Determine who is allowed to invite new members to the group. ALL_MEMBERS_CAN_INVITE allows anyone who is already a member of the group to invite others to join. ALL_MANAGERS_CAN_INVITE allows only group managers and owners to invite others. NONE_CAN_INVITE prevents anyone from inviting new members to the group via the web UI, requiring all members to be added via the API (or GAM).

Example

This example allows any existing member of [email protected] to invite others to join the group.

gam update group [email protected] who_can_invite all_members_can_invite

Who Can Join

Syntax

gam update group <group> who_can_join all_in_domain_can_join|anyone_can_join|can_request_to_join|invited_can_join

Determines who is allowed to become a member of the group. all_in_domain_can_join allows any domain members to directly join the group. anyone_can_join allows any logged in Google Account to join the group. can_request_to_join allows anyone to request membership to join. invited_can_join allows only those members who have received invitations to join the group (disable request to join). invited_can_join can be used with setting Who Can Invite to NONE_CAN_INVITE to prevent the addition of new members via the Web UI.

Example

This example allows anyone on the Internet to potentially join the [email protected] group.

gam update group [email protected]  who_can_join anyone_can_join

Who Can Post Message

Syntax

gam update group <group> who_can_post_message all_in_domain_can_post|all_managers_can_post|all_members_can_post|anyone_can_post|none_can_post

Determine who is allowed to send messages to the group. all_in_domain_can_post allows any Google Apps user in the domain to send messages (even if they're not a group member). all_managers_can_post limits sending rights to owners and managers. all_members_can_post allows anyone who has joined the group to send messages. anyone_can_post allows anyone on the Internet to send email to the group address. none_can_post is not normally directly set on a group, it will show as the return value for who_can_post if archive_only is true.

Example

This example locks the [email protected] group down to only accept posts from managers and owners.

gam update group [email protected] who_can_post_message all_managers_can_post

Who Can View Group

Syntax

gam update group <group> who_can_view_group all_in_domain_can_view|all_managers_can_view|all_members_can_view|anyone_can_view

Determine who can view this group including past messages sent to the group if is_archived is enabled. all_in_domain_can_view allows any Google Apps users in the domain to view the group. all_managers_can_view limits viewing the group to owners and managers only. all_members_can_view allows anyone who is a member of the group to view it. anyone_can_view allows anyone on the Internet to view the group.

Example

This example sets [email protected] to only be viewable by members.

gam update group [email protected] who_can_view_group all_members_can_view

Who Can View Membership

Syntax

gam update group <group>  who_can_view_membership all_in_domain_can_view|all_managers_can_view|all_members_can_view

Determine who can view the list of group members. all_in_domain_can_view opens group membership lists to all Google Apps users in the domain. all_managers_can_view limits group membership lists to group managers and owners. all_members_can_view allows anyone who is a member of the group to see the member list.

Example

This example locks down [email protected] so that only group managers can see who is a member of the group via the groups interface.

gam update group [email protected] who_can_view_membership all_managers_can_view

Allow Google Communication

Syntax

gam update group <group> allow_google_communication true|false

Determine if Google is allowed to send communications to group managers and owners. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group. true allows this communication. false will prevent Google from ever sending these communications to the group.

Example

This example prevents Google from directly contacting [email protected] managers and owners.

gam update group [email protected] allow_google_communication false

Allow Web Posting

Syntax

gam update group <group> allow_web_posting true|false

Determine if users are allowed to post to the group from the Google Groups web interface or via email only.

Example

This example turns off web-based posting for the [email protected] group.

gam update group [email protected] allow_web_posting false

Archive Only

Syntax

gam update group <group> archive_only true|false

Determine if the group is limited to archival of old messages or if it is active. Setting archive only prevents new messages from going to the group.

Example

This example puts [email protected] into archive only mode.

gam update group [email protected] archive_only true

Custom Reply To

Syntax

gam update group <group> custom_reply_to <email>

Sets the email address that will be used when reply_to is set to reply_to_custom. When both settings are in place, this address will be the default reply to for messages sent to the group.

Example

This example enables reply_to_custom for [email protected] and sets the custom_reply_to address to [email protected]

gam update group [email protected] reply_to reply_to_custom custom_reply_to [email protected]

Is Archived

Syntax

gam update group <group> is_archived true|false

Determines whether or not messages sent to the group should be archived and viewable in the Google Groups interface.

Example

This example turns archiving off for the [email protected] group.

gam update group [email protected] is_archived false

Max Message Bytes

Syntax

gam update group <group> max_message_bytes <integer>

Determines the maximum size of a message sent to the group. Instead of entering a large number, K or M can be used to specify kilobytes or megabytes. For example, 512K or 1M would both be valid values.

Example

This example sets Twitter-like size limits for the [email protected] group. We bump it to 4 kilobytes instead of 160 bytes to account for message headers.

gam update group [email protected] max_message_bytes 4K

Members Can Post As The Group

Syntax

gam update group <group> members_can_post_as_the_group true|false

Determines if members are allowed to send to the group using the group's email address as the From.

Example

This example will allow [email protected] group members to send out messages to the group as [email protected].

gam update group [email protected] members_can_post_as_the_group true

Message Display Font

Syntax

gam update group <group> message_display_font default_font|fixed_width_font

Sets the font that will be used in display group messages from the Google Groups UI. default_font is the normal. fixed_width_font uses a special fixed-width font in the display.

Example

This example turns on the fixed_width_font for the [email protected] group

gam update group [email protected] message_display_font fixed_width_font

Description

Syntax

gam update group <group> description <group description>

Change the group description. This is the same group description set by the group provisioning GAM command. This command exists only to allow changing the group description with the same API call while performing other Group Settings operations.

Example

This example changes the [email protected] group description to be "messages regarding upcoming parties"

gam update group [email protected] description "messages regarding upcoming parties"

Group Name

Syntax

gam update group <group> name <new name>

Change the group name. This is the same group name set by the group provisioning GAM command. This command exists only to allow changing the group name with the same API call while performing other Group Settings operations.

Example

This example changes the group name to "Acme Employees"

gam update group [email protected] name "Acme Employees"

Spam Moderation Level

Syntax

gam update group <group> spam_moderation_level allow|moderate|silently_moderate|reject

Change the spam moderation settings for the group. Allow will disable the spam filter and allow all mail from persons allowed to post to the group. moderate will place suspected spam messages in a moderation queue and notify group owners. silenty_moderate will place suspected spam message in a moderation queue WITHOUT notifying group owners. reject will fail message delivery for messages suspected of being spam.

Example

This example turns off spam filtering for the [email protected] group

gam update group [email protected] spam_moderation_level allow

Include in Global Address List (GAL)

Syntax

gam update group <group> include_in_global_address_list true|false

Include or remove this group's address from the Google Apps Global Address List (GAL). This setting is the group equivalent of the Hide/Unhide user profile setting. If a group is included (true), they'll show up in autocomplete and contact searches for addresses. If a group is not included (false), users will not be able to discover the groups's address and detailed contact info via autocomplete or contacts search.

Note: this setting and the Show in Groups Directory setting are not the same. To hide a group completely you should set both to false.

Example

This example hides the group [email protected] from the Global Address List.

gam update group [email protected] include_in_global_address_list false

Who Can Leave Group

Syntax

gam update group <group> who_can_leave_group NONE_CAN_LEAVE|ALL_MEMBERS_CAN_LEAVE|ALL_MANAGERS_CAN_LEAVE

Determines if regular users are allowed to leave a group. Setting this to ALL_MANAGERS_CAN_LEAVE prevents regular members from unsubscribing to the group via the Web UI or email. Setting this to NONE_CAN_LEAVE prevents all members, including managers and owners, from unsubscribing to the group via the Web UI or email. Note that forcing a user to remain in a group increases the odds that they'll report your group mail as spam so it's strongly recommended to only use this setting for groups containing internal users only.

Example

This example prevents regular users from leaving the [email protected] group.

gam update group [email protected] who_can_leave_group ALL_MANAGERS_CAN_LEAVE

Who Can Contact Owner

Syntax

gam update group <group> who_can_contact_owner ANYONE_CAN_CONTACT|ALL_IN_DOMAIN_CAN_CONTACT|ALL_MEMBERS_CAN_CONTACT|ALL_MANAGERS_CAN_CONTACT

Determines who is allowed to email the special [email protected] address in order to contact group owners.

Example

This example prevents external email addresses from spamming [email protected].

gam update group [email protected] who_can_contact_owner ALL_IN_DOMAIN_CAN_CONTACT

Need more help? Ask on the GAM Discussion Group

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

GAM Tutorials

Clone this wiki locally