1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Gmail
  7. \
  8. Resource
  9. \
  10. UsersSettingsFilters

UsersSettingsFilters

class UsersSettingsFilters extends Resource (View source)

The "filters" collection of methods.

Typical usage is:

 $gmailService = new Google\Service\Gmail(...);
 $filters = $gmailService->users_settings_filters;

Methods

Filter
create(string $userId, Filter $postBody, array $optParams = [])

Creates a filter. Note: you can only create a maximum of 1,000 filters.

delete(string $userId, string $id, array $optParams = [])

Immediately and permanently deletes the specified filter. (filters.delete)

Filter
get(string $userId, string $id, array $optParams = [])

Gets a filter. (filters.get)

ListFiltersResponse
listUsersSettingsFilters(string $userId, array $optParams = [])

Lists the message filters of a Gmail user. (filters.listUsersSettingsFilters)

Details

at line 44
Filter create(string $userId, Filter $postBody, array $optParams = [])

Creates a filter. Note: you can only create a maximum of 1,000 filters.

(filters.create)

Parameters

string $userId

User's email address. The special value "me" can be used to indicate the authenticated user.
Filter $postBody
array $optParams

Optional parameters.

Return Value

Filter

Exceptions

Exception

at line 59
delete(string $userId, string $id, array $optParams = [])

Immediately and permanently deletes the specified filter. (filters.delete)

Parameters

string $userId

User's email address. The special value "me" can be used to indicate the authenticated user.
string $id

The ID of the filter to be deleted.
array $optParams

Optional parameters.

Exceptions

Exception

at line 75
Filter get(string $userId, string $id, array $optParams = [])

Gets a filter. (filters.get)

Parameters

string $userId

User's email address. The special value "me" can be used to indicate the authenticated user.
string $id

The ID of the filter to be fetched.
array $optParams

Optional parameters.

Return Value

Filter

Exceptions

Exception

at line 90
ListFiltersResponse listUsersSettingsFilters(string $userId, array $optParams = [])

Lists the message filters of a Gmail user. (filters.listUsersSettingsFilters)

Parameters

string $userId

User's email address. The special value "me" can be used to indicate the authenticated user.
array $optParams

Optional parameters.

Return Value

ListFiltersResponse

Exceptions

Exception