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
-
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
|
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
|
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
|
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
|
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.
|