Documentation

Google_Service_Gmail_Resource_UsersSettingsSendAs extends Google_Service_Resource
in package

Application

The "sendAs" collection of methods.

Typical usage is: $gmailService = new Google_Service_Gmail(...); $sendAs = $gmailService->sendAs;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Gmail_SendAs: 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: 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)
get() : Google_Service_Gmail_SendAs: 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)
listUsersSettingsSendAs() : Google_Service_Gmail_ListSendAsResponse: 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)
patch() : Google_Service_Gmail_SendAs: Patch the specified send-as alias. (sendAs.patch)
update() : Google_Service_Gmail_SendAs: 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)
verify() : mixed: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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)


    public
                create(string $userId, Google_Service_Gmail_SendAs $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_SendAs

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_SendAs
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_SendAs —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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)


    public
                delete(string $userId, string $sendAsEmail[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail : string: The send-as alias to be deleted.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

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)


    public
                get(string $userId, string $sendAsEmail[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_SendAs

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail : string: The send-as alias to be retrieved.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_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)


    public
                listUsersSettingsSendAs(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ListSendAsResponse

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_ListSendAsResponse —

patch()

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


    public
                patch(string $userId, string $sendAsEmail, Google_Service_Gmail_SendAs $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_SendAs

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail : string: The send-as alias to be updated.
$postBody : Google_Service_Gmail_SendAs
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_SendAs —

update()

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)


    public
                update(string $userId, string $sendAsEmail, Google_Service_Gmail_SendAs $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_SendAs

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail : string: The send-as alias to be updated.
$postBody : Google_Service_Gmail_SendAs
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_SendAs —

verify()

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.


    public
                verify(string $userId, string $sendAsEmail[, array<string|int, mixed> $optParams = array() ]) : mixed

(sendAs.verify)

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$sendAsEmail : string: The send-as alias to be verified.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —