Overview

Classes

  • Google_Service_Gmail
  • Google_Service_Gmail_AutoForwarding
  • Google_Service_Gmail_BatchDeleteMessagesRequest
  • Google_Service_Gmail_BatchModifyMessagesRequest
  • Google_Service_Gmail_Delegate
  • Google_Service_Gmail_Draft
  • Google_Service_Gmail_Filter
  • Google_Service_Gmail_FilterAction
  • Google_Service_Gmail_FilterCriteria
  • Google_Service_Gmail_ForwardingAddress
  • Google_Service_Gmail_History
  • Google_Service_Gmail_HistoryLabelAdded
  • Google_Service_Gmail_HistoryLabelRemoved
  • Google_Service_Gmail_HistoryMessageAdded
  • Google_Service_Gmail_HistoryMessageDeleted
  • Google_Service_Gmail_ImapSettings
  • Google_Service_Gmail_Label
  • Google_Service_Gmail_LabelColor
  • Google_Service_Gmail_LanguageSettings
  • Google_Service_Gmail_ListDelegatesResponse
  • Google_Service_Gmail_ListDraftsResponse
  • Google_Service_Gmail_ListFiltersResponse
  • Google_Service_Gmail_ListForwardingAddressesResponse
  • Google_Service_Gmail_ListHistoryResponse
  • Google_Service_Gmail_ListLabelsResponse
  • Google_Service_Gmail_ListMessagesResponse
  • Google_Service_Gmail_ListSendAsResponse
  • Google_Service_Gmail_ListSmimeInfoResponse
  • Google_Service_Gmail_ListThreadsResponse
  • Google_Service_Gmail_Message
  • Google_Service_Gmail_MessagePart
  • Google_Service_Gmail_MessagePartBody
  • Google_Service_Gmail_MessagePartHeader
  • Google_Service_Gmail_ModifyMessageRequest
  • Google_Service_Gmail_ModifyThreadRequest
  • Google_Service_Gmail_PopSettings
  • Google_Service_Gmail_Profile
  • Google_Service_Gmail_SendAs
  • Google_Service_Gmail_SmimeInfo
  • Google_Service_Gmail_SmtpMsa
  • Google_Service_Gmail_Thread
  • Google_Service_Gmail_Users_Resource
  • Google_Service_Gmail_UsersDrafts_Resource
  • Google_Service_Gmail_UsersHistory_Resource
  • Google_Service_Gmail_UsersLabels_Resource
  • Google_Service_Gmail_UsersMessages_Resource
  • Google_Service_Gmail_UsersMessagesAttachments_Resource
  • Google_Service_Gmail_UsersSettings_Resource
  • Google_Service_Gmail_UsersSettingsDelegates_Resource
  • Google_Service_Gmail_UsersSettingsFilters_Resource
  • Google_Service_Gmail_UsersSettingsForwardingAddresses_Resource
  • Google_Service_Gmail_UsersSettingsSendAs_Resource
  • Google_Service_Gmail_UsersSettingsSendAsSmimeInfo_Resource
  • Google_Service_Gmail_UsersThreads_Resource
  • Google_Service_Gmail_VacationSettings
  • Google_Service_Gmail_WatchRequest
  • Google_Service_Gmail_WatchResponse
  • Overview
  • Class
  • Tree

Class Google_Service_Gmail_UsersSettingsSendAs_Resource

The "sendAs" collection of methods. Typical usage is:

 $gmailService = new Google_Service_Gmail(...);
 $sendAs = $gmailService->sendAs;
Google_Service_Resource
Extended by Google_Service_Gmail_UsersSettingsSendAs_Resource
Located at Gmail.php
Methods summary
public Google_Service_Gmail_SendAs
# create( string $userId, Google_Service_Gmail_SendAs $postBody, array $optParams = array() )

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

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

Parameters

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

Returns

Google_Service_Gmail_SendAs
Google_Service_Gmail_SendAs
public
# delete( string $userId, string $sendAsEmail, array $optParams = array() )

Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

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

Parameters

$userId
User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail
The send-as alias to be deleted.
$optParams
Optional parameters.
public Google_Service_Gmail_SendAs
# get( string $userId, string $sendAsEmail, array $optParams = array() )

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. (sendAs.get)

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. (sendAs.get)

Parameters

$userId
User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail
The send-as alias to be retrieved.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_SendAs
Google_Service_Gmail_SendAs
public Google_Service_Gmail_ListSendAsResponse
# listUsersSettingsSendAs( string $userId, array $optParams = array() )

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. (sendAs.listUsersSettingsSendAs)

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. (sendAs.listUsersSettingsSendAs)

Parameters

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

Returns

Google_Service_Gmail_ListSendAsResponse
Google_Service_Gmail_ListSendAsResponse
public Google_Service_Gmail_SendAs
# patch( string $userId, string $sendAsEmail, Google_Service_Gmail_SendAs $postBody, array $optParams = array() )

Patch the specified send-as alias. (sendAs.patch)

Patch the specified send-as alias. (sendAs.patch)

Parameters

$userId
User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail
The send-as alias to be updated.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_SendAs
Google_Service_Gmail_SendAs
public Google_Service_Gmail_SendAs
# update( string $userId, string $sendAsEmail, Google_Service_Gmail_SendAs $postBody, array $optParams = array() )

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. (sendAs.update)

Parameters

$userId
User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail
The send-as alias to be updated.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_SendAs
Google_Service_Gmail_SendAs
public
# verify( string $userId, string $sendAsEmail, array $optParams = array() )

Sends a verification email to the specified send-as alias address. The verification status must be pending.

Sends a verification email to the specified send-as alias address. The verification status must be pending.

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

Parameters

$userId
User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail
The send-as alias to be verified.
$optParams
Optional parameters.
© 2020 Google Inc.
Gmail API documentation generated by ApiGen 2.8.0