Gmail API . users . settings . forwardingAddresses

Instance Methods

create(userId, body=None, x__xgafv=None)

Creates a forwarding address. If ownership verification is required, a

delete(userId, forwardingEmail, x__xgafv=None)

Deletes the specified forwarding address and revokes any verification that

get(userId, forwardingEmail, x__xgafv=None)

Gets the specified forwarding address.

list(userId, x__xgafv=None)

Lists the forwarding addresses for the specified account.

Method Details

create(userId, body=None, x__xgafv=None)
Creates a forwarding address.  If ownership verification is required, a
message will be sent to the recipient and the resource's verification
status will be set to <code>pending</code>; otherwise, the resource will be
created with verification status set to <code>accepted</code>.

This method is only available to service account clients that have been
delegated domain-wide authority.

Args:
  userId: string, User's email address.  The special value "me"
can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # Settings for a forwarding address.
    "forwardingEmail": "A String", # An email address to which messages can be forwarded.
    "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for
        # forwarding.  Read-only.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Settings for a forwarding address.
      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for
          # forwarding.  Read-only.
    }
delete(userId, forwardingEmail, x__xgafv=None)
Deletes the specified forwarding address and revokes any verification that
may have been required.

This method is only available to service account clients that have been
delegated domain-wide authority.

Args:
  userId: string, User's email address.  The special value "me"
can be used to indicate the authenticated user. (required)
  forwardingEmail: string, The forwarding address to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(userId, forwardingEmail, x__xgafv=None)
Gets the specified forwarding address.

Args:
  userId: string, User's email address.  The special value "me"
can be used to indicate the authenticated user. (required)
  forwardingEmail: string, The forwarding address to be retrieved. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Settings for a forwarding address.
      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for
          # forwarding.  Read-only.
    }
list(userId, x__xgafv=None)
Lists the forwarding addresses for the specified account.

Args:
  userId: string, User's email address.  The special value "me"
can be used to indicate the authenticated user. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the ListForwardingAddresses method.
    "forwardingAddresses": [ # List of addresses that may be used for forwarding.
      { # Settings for a forwarding address.
          "forwardingEmail": "A String", # An email address to which messages can be forwarded.
          "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for
              # forwarding.  Read-only.
        },
    ],
  }