updateAutoForwarding method

Future<AutoForwarding> updateAutoForwarding(AutoForwarding request, String userId, { String? $fields, })

Updates the auto-forwarding setting for the specified account.

A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

request - The metadata request object.

Request parameters:

userId - User's email address. The special value "me" can be used to indicate the authenticated user.

$fields - Selector specifying which fields to include in a partial response.

Completes with a AutoForwarding.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<AutoForwarding> updateAutoForwarding(
  AutoForwarding request,
  core.String userId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'gmail/v1/users/' +
      commons.escapeVariable('$userId') +
      '/settings/autoForwarding';

  final response_ = await _requester.request(
    url_,
    'PUT',
    body: body_,
    queryParams: queryParams_,
  );
  return AutoForwarding.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}