Documentation

Google_Service_Gmail_Resource_UsersSettingsSendAsSmimeInfo extends Google_Service_Resource
in package

Application

The "smimeInfo" collection of methods.

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

$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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes the specified S/MIME config for the specified send-as alias.
get() : Google_Service_Gmail_SmimeInfo: Gets the specified S/MIME config for the specified send-as alias.
insert() : Google_Service_Gmail_SmimeInfo: Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. (smimeInfo.insert)
listUsersSettingsSendAsSmimeInfo() : Google_Service_Gmail_ListSmimeInfoResponse: Lists S/MIME configs for the specified send-as alias.
setDefault() : mixed: Sets the default S/MIME config for the specified send-as alias.
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 —

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 S/MIME config for the specified send-as alias.


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

(smimeInfo.delete)

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$sendAsEmail : string: The email address that appears in the "From:" header for mail sent using this alias.
$id : string: The immutable ID for the SmimeInfo.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets the specified S/MIME config for the specified send-as alias.


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

(smimeInfo.get)

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$sendAsEmail : string: The email address that appears in the "From:" header for mail sent using this alias.
$id : string: The immutable ID for the SmimeInfo.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_SmimeInfo —

insert()

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. (smimeInfo.insert)


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

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$sendAsEmail : string: The email address that appears in the "From:" header for mail sent using this alias.
$postBody : Google_Service_Gmail_SmimeInfo
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_SmimeInfo —

listUsersSettingsSendAsSmimeInfo()

Lists S/MIME configs for the specified send-as alias.


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

(smimeInfo.listUsersSettingsSendAsSmimeInfo)

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$sendAsEmail : string: The email address that appears in the "From:" header for mail sent using this alias.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_ListSmimeInfoResponse —

setDefault()

Sets the default S/MIME config for the specified send-as alias.


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

(smimeInfo.setDefault)

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$sendAsEmail : string: The email address that appears in the "From:" header for mail sent using this alias.
$id : string: The immutable ID for the SmimeInfo.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —