Google Apps Script

Class GroupsApp

This class provides access to Google Groups information. It can be used to query information such as a group's email address, or the list of groups in which the user is a direct member. Here's an example that shows how many groups the current user is a member of:

 
var groups = GroupsApp.getGroups();
   Logger.log('You belong to ' + groups.length + ' groups.');
 

Properties

PropertyTypeDescription
RoleRole

Methods

MethodReturn typeBrief description
getGroupByEmail(email)GroupRetrieves the group having the specified email address.
getGroups()Group[]Retrieves all the groups of which you are a direct member.

Detailed documentation

getGroupByEmail(email)

Retrieves the group having the specified email address. Throws an exception if the group does not exist or if you do not have permission to see it. Here is an example that gets a group by its email address and outputs whether the current user is a member. Before running, replace the sample email address with a real group's email.

 
var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
   var currentUser = Session.getActiveUser();
   if (group.hasUser(currentUser)) {
     Logger.log("You are a member of this group.");
   }
   else {
     Logger.log("You are not a member of this group.");
   }
 

Parameters

NameTypeDescription
emailStringthe email address of the group to retrieve

Return

Group — the group with the specified email address


getGroups()

Retrieves all the groups of which you are a direct member. This will be an empty list if you are not in any groups. Throws an exception if the group does not exist or if you do not have permission to see it. Here's an example of how to print the email address for every group the user belongs to:

 
function showMyGroups() {
     var groups = GroupsApp.getGroups();
     var s = 'You are in ' + groups.length + ' groups: ';
     for (var i = 0; i < groups.length; i++) {
       var group = groups[i];
       s = s + group.getEmail() + ' ';
     }
     Logger.log(s);
   }
 
Note that if you are a member of a group, B, which is itself a member of another group, A, then you are indirectly subscribed to group A. Even though you receive copies of messages sent to the "parent" group A, you are not actually subscribed to that group.

Return

Group[] — the list of groups of which the user is a direct member

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.