Documentation

ApiEmailWarmupControllerApi
in package

MailSlurp

ApiEmailWarmupControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createEmailWarmupProgram' => ['application/json'], 'deleteEmailWarmupProgram' => ['application/json'], 'deleteEmailWarmupSenderSeats' => ['application/json'], 'getEmailWarmupOverview' => ['application/json'], 'getEmailWarmupPlacementChecks' => ['application/json'], 'getEmailWarmupProgram' => ['application/json'], 'getEmailWarmupProgramAnalytics' => ['application/json'], 'getEmailWarmupPrograms' => ['application/json'], 'getEmailWarmupReadiness' => ['application/json'], 'getEmailWarmupSlots' => ['application/json'], 'getEmailWarmupUsage' => ['application/json'], 'pauseEmailWarmupProgram' => ['application/json'], 'resumeEmailWarmupProgram' => ['application/json'], 'retryEmailWarmupProgram' => ['application/json'], 'startEmailWarmupProgram' => ['application/json'], 'stopEmailWarmupProgram' => ['application/json'], 'updateEmailWarmupProgram' => ['application/json'], 'updateEmailWarmupSenderSeats' => ['application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values

mixed —

createEmailWarmupProgram()

Operation createEmailWarmupProgram


    public
                    createEmailWarmupProgram(CreateEmailWarmupProgramOptions $create_email_warmup_program_options[, string $contentType = self::contentTypes['createEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Create an email warmup program

Parameters

$create_email_warmup_program_options : CreateEmailWarmupProgramOptions: create_email_warmup_program_options (required)
$contentType : string = self::contentTypes['createEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['createEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

createEmailWarmupProgramAsync()

Operation createEmailWarmupProgramAsync


    public
                    createEmailWarmupProgramAsync(CreateEmailWarmupProgramOptions $create_email_warmup_program_options[, string $contentType = self::contentTypes['createEmailWarmupProgram'][0] ]) : PromiseInterface

Create an email warmup program

Parameters

$create_email_warmup_program_options : CreateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['createEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['createEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

createEmailWarmupProgramAsyncWithHttpInfo()

Operation createEmailWarmupProgramAsyncWithHttpInfo


    public
                    createEmailWarmupProgramAsyncWithHttpInfo(CreateEmailWarmupProgramOptions $create_email_warmup_program_options[, string $contentType = self::contentTypes['createEmailWarmupProgram'][0] ]) : PromiseInterface

Create an email warmup program

Parameters

$create_email_warmup_program_options : CreateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['createEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['createEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

createEmailWarmupProgramRequest()

Create request for operation 'createEmailWarmupProgram'


    public
                    createEmailWarmupProgramRequest(CreateEmailWarmupProgramOptions $create_email_warmup_program_options[, string $contentType = self::contentTypes['createEmailWarmupProgram'][0] ]) : Request

Parameters

$create_email_warmup_program_options : CreateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['createEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['createEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

createEmailWarmupProgramWithHttpInfo()

Operation createEmailWarmupProgramWithHttpInfo


    public
                    createEmailWarmupProgramWithHttpInfo(CreateEmailWarmupProgramOptions $create_email_warmup_program_options[, string $contentType = self::contentTypes['createEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Create an email warmup program

Parameters

$create_email_warmup_program_options : CreateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['createEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['createEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

deleteEmailWarmupProgram()

Operation deleteEmailWarmupProgram


    public
                    deleteEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['deleteEmailWarmupProgram'][0] ]) : void

Delete an email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['deleteEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupProgram'] to see the possible values for this operation

Return values

void —

deleteEmailWarmupProgramAsync()

Operation deleteEmailWarmupProgramAsync


    public
                    deleteEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['deleteEmailWarmupProgram'][0] ]) : PromiseInterface

Delete an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['deleteEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailWarmupProgramAsyncWithHttpInfo()

Operation deleteEmailWarmupProgramAsyncWithHttpInfo


    public
                    deleteEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['deleteEmailWarmupProgram'][0] ]) : PromiseInterface

Delete an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['deleteEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailWarmupProgramRequest()

Create request for operation 'deleteEmailWarmupProgram'


    public
                    deleteEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['deleteEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['deleteEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

deleteEmailWarmupProgramWithHttpInfo()

Operation deleteEmailWarmupProgramWithHttpInfo


    public
                    deleteEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['deleteEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Delete an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['deleteEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteEmailWarmupSenderSeats()

Operation deleteEmailWarmupSenderSeats


    public
                    deleteEmailWarmupSenderSeats([string $contentType = self::contentTypes['deleteEmailWarmupSenderSeats'][0] ]) : EmailWarmupUsageSummaryDto

Cancel purchased email warmup sender seats

Parameters

$contentType : string = self::contentTypes['deleteEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

EmailWarmupUsageSummaryDto —

deleteEmailWarmupSenderSeatsAsync()

Operation deleteEmailWarmupSenderSeatsAsync


    public
                    deleteEmailWarmupSenderSeatsAsync([string $contentType = self::contentTypes['deleteEmailWarmupSenderSeats'][0] ]) : PromiseInterface

Cancel purchased email warmup sender seats

Parameters

$contentType : string = self::contentTypes['deleteEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailWarmupSenderSeatsAsyncWithHttpInfo()

Operation deleteEmailWarmupSenderSeatsAsyncWithHttpInfo


    public
                    deleteEmailWarmupSenderSeatsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteEmailWarmupSenderSeats'][0] ]) : PromiseInterface

Cancel purchased email warmup sender seats

Parameters

$contentType : string = self::contentTypes['deleteEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailWarmupSenderSeatsRequest()

Create request for operation 'deleteEmailWarmupSenderSeats'


    public
                    deleteEmailWarmupSenderSeatsRequest([string $contentType = self::contentTypes['deleteEmailWarmupSenderSeats'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['deleteEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

Request —

deleteEmailWarmupSenderSeatsWithHttpInfo()

Operation deleteEmailWarmupSenderSeatsWithHttpInfo


    public
                    deleteEmailWarmupSenderSeatsWithHttpInfo([string $contentType = self::contentTypes['deleteEmailWarmupSenderSeats'][0] ]) : array<string|int, mixed>

Cancel purchased email warmup sender seats

Parameters

$contentType : string = self::contentTypes['deleteEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupUsageSummaryDto, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getEmailWarmupOverview()

Operation getEmailWarmupOverview


    public
                    getEmailWarmupOverview([int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupOverview'][0] ]) : EmailWarmupOverviewDto

Get operational email warmup activity and program progress

Parameters

$days : int = 30: days (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupOverview'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupOverview'] to see the possible values for this operation

Return values

EmailWarmupOverviewDto —

getEmailWarmupOverviewAsync()

Operation getEmailWarmupOverviewAsync


    public
                    getEmailWarmupOverviewAsync([int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupOverview'][0] ]) : PromiseInterface

Get operational email warmup activity and program progress

Parameters

$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupOverview'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupOverview'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupOverviewAsyncWithHttpInfo()

Operation getEmailWarmupOverviewAsyncWithHttpInfo


    public
                    getEmailWarmupOverviewAsyncWithHttpInfo([int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupOverview'][0] ]) : PromiseInterface

Get operational email warmup activity and program progress

Parameters

$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupOverview'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupOverview'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupOverviewRequest()

Create request for operation 'getEmailWarmupOverview'


    public
                    getEmailWarmupOverviewRequest([int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupOverview'][0] ]) : Request

Parameters

$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupOverview'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupOverview'] to see the possible values for this operation

Return values

Request —

getEmailWarmupOverviewWithHttpInfo()

Operation getEmailWarmupOverviewWithHttpInfo


    public
                    getEmailWarmupOverviewWithHttpInfo([int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupOverview'][0] ]) : array<string|int, mixed>

Get operational email warmup activity and program progress

Parameters

$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupOverview'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupOverview'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupOverviewDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupPlacementChecks()

Operation getEmailWarmupPlacementChecks


    public
                    getEmailWarmupPlacementChecks(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupPlacementChecks'][0] ]) : array<string|int, EmailWarmupPlacementCheckDto>

List Gmail and Outlook placement checks for an email warmup program

Parameters

$program_id : string: program_id (required)
$contentType : string = self::contentTypes['getEmailWarmupPlacementChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPlacementChecks'] to see the possible values for this operation

Return values

array<string|int, EmailWarmupPlacementCheckDto> —

getEmailWarmupPlacementChecksAsync()

Operation getEmailWarmupPlacementChecksAsync


    public
                    getEmailWarmupPlacementChecksAsync(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupPlacementChecks'][0] ]) : PromiseInterface

List Gmail and Outlook placement checks for an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupPlacementChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPlacementChecks'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupPlacementChecksAsyncWithHttpInfo()

Operation getEmailWarmupPlacementChecksAsyncWithHttpInfo


    public
                    getEmailWarmupPlacementChecksAsyncWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupPlacementChecks'][0] ]) : PromiseInterface

List Gmail and Outlook placement checks for an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupPlacementChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPlacementChecks'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupPlacementChecksRequest()

Create request for operation 'getEmailWarmupPlacementChecks'


    public
                    getEmailWarmupPlacementChecksRequest(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupPlacementChecks'][0] ]) : Request

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupPlacementChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPlacementChecks'] to see the possible values for this operation

Return values

Request —

getEmailWarmupPlacementChecksWithHttpInfo()

Operation getEmailWarmupPlacementChecksWithHttpInfo


    public
                    getEmailWarmupPlacementChecksWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupPlacementChecks'][0] ]) : array<string|int, mixed>

List Gmail and Outlook placement checks for an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupPlacementChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPlacementChecks'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupPlacementCheckDto[], HTTP status code, HTTP response headers (array of strings)

getEmailWarmupProgram()

Operation getEmailWarmupProgram


    public
                    getEmailWarmupProgram(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Get an email warmup program

Parameters

$program_id : string: program_id (required)
$contentType : string = self::contentTypes['getEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

getEmailWarmupProgramAnalytics()

Operation getEmailWarmupProgramAnalytics


    public
                    getEmailWarmupProgramAnalytics(string $program_id[, int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupProgramAnalytics'][0] ]) : EmailWarmupProgramAnalyticsDto

Get email warmup program progress and daily activity

Parameters

$program_id : string: program_id (required)
$days : int = 30: days (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupProgramAnalytics'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgramAnalytics'] to see the possible values for this operation

Return values

EmailWarmupProgramAnalyticsDto —

getEmailWarmupProgramAnalyticsAsync()

Operation getEmailWarmupProgramAnalyticsAsync


    public
                    getEmailWarmupProgramAnalyticsAsync(string $program_id[, int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupProgramAnalytics'][0] ]) : PromiseInterface

Get email warmup program progress and daily activity

Parameters

$program_id : string: (required)
$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupProgramAnalytics'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgramAnalytics'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramAnalyticsAsyncWithHttpInfo()

Operation getEmailWarmupProgramAnalyticsAsyncWithHttpInfo


    public
                    getEmailWarmupProgramAnalyticsAsyncWithHttpInfo(string $program_id[, int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupProgramAnalytics'][0] ]) : PromiseInterface

Get email warmup program progress and daily activity

Parameters

$program_id : string: (required)
$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupProgramAnalytics'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgramAnalytics'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramAnalyticsRequest()

Create request for operation 'getEmailWarmupProgramAnalytics'


    public
                    getEmailWarmupProgramAnalyticsRequest(string $program_id[, int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupProgramAnalytics'][0] ]) : Request

Parameters

$program_id : string: (required)
$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupProgramAnalytics'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgramAnalytics'] to see the possible values for this operation

Return values

Request —

getEmailWarmupProgramAnalyticsWithHttpInfo()

Operation getEmailWarmupProgramAnalyticsWithHttpInfo


    public
                    getEmailWarmupProgramAnalyticsWithHttpInfo(string $program_id[, int $days = 30 ][, string $contentType = self::contentTypes['getEmailWarmupProgramAnalytics'][0] ]) : array<string|int, mixed>

Get email warmup program progress and daily activity

Parameters

$program_id : string: (required)
$days : int = 30: (optional, default to 30)
$contentType : string = self::contentTypes['getEmailWarmupProgramAnalytics'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgramAnalytics'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramAnalyticsDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupProgramAsync()

Operation getEmailWarmupProgramAsync


    public
                    getEmailWarmupProgramAsync(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupProgram'][0] ]) : PromiseInterface

Get an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramAsyncWithHttpInfo()

Operation getEmailWarmupProgramAsyncWithHttpInfo


    public
                    getEmailWarmupProgramAsyncWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupProgram'][0] ]) : PromiseInterface

Get an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramRequest()

Create request for operation 'getEmailWarmupProgram'


    public
                    getEmailWarmupProgramRequest(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

getEmailWarmupPrograms()

Operation getEmailWarmupPrograms


    public
                    getEmailWarmupPrograms(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getEmailWarmupPrograms'][0] ]) : EmailWarmupProgramPageDto

List email warmup programs

Parameters

$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['getEmailWarmupPrograms'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPrograms'] to see the possible values for this operation

Return values

EmailWarmupProgramPageDto —

getEmailWarmupProgramsAsync()

Operation getEmailWarmupProgramsAsync


    public
                    getEmailWarmupProgramsAsync(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getEmailWarmupPrograms'][0] ]) : PromiseInterface

List email warmup programs

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getEmailWarmupPrograms'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPrograms'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramsAsyncWithHttpInfo()

Operation getEmailWarmupProgramsAsyncWithHttpInfo


    public
                    getEmailWarmupProgramsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getEmailWarmupPrograms'][0] ]) : PromiseInterface

List email warmup programs

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getEmailWarmupPrograms'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPrograms'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupProgramsRequest()

Create request for operation 'getEmailWarmupPrograms'


    public
                    getEmailWarmupProgramsRequest(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getEmailWarmupPrograms'][0] ]) : Request

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getEmailWarmupPrograms'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPrograms'] to see the possible values for this operation

Return values

Request —

getEmailWarmupProgramsWithHttpInfo()

Operation getEmailWarmupProgramsWithHttpInfo


    public
                    getEmailWarmupProgramsWithHttpInfo(int $page[, int $size = 20 ][, string $contentType = self::contentTypes['getEmailWarmupPrograms'][0] ]) : array<string|int, mixed>

List email warmup programs

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['getEmailWarmupPrograms'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupPrograms'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramPageDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupProgramWithHttpInfo()

Operation getEmailWarmupProgramWithHttpInfo


    public
                    getEmailWarmupProgramWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Get an email warmup program

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupReadiness()

Operation getEmailWarmupReadiness


    public
                    getEmailWarmupReadiness(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupReadiness'][0] ]) : EmailWarmupReadinessDto

Get warmup readiness, adaptive pacing, and sender-health signals

Parameters

$program_id : string: program_id (required)
$contentType : string = self::contentTypes['getEmailWarmupReadiness'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupReadiness'] to see the possible values for this operation

Return values

EmailWarmupReadinessDto —

getEmailWarmupReadinessAsync()

Operation getEmailWarmupReadinessAsync


    public
                    getEmailWarmupReadinessAsync(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupReadiness'][0] ]) : PromiseInterface

Get warmup readiness, adaptive pacing, and sender-health signals

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupReadiness'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupReadiness'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupReadinessAsyncWithHttpInfo()

Operation getEmailWarmupReadinessAsyncWithHttpInfo


    public
                    getEmailWarmupReadinessAsyncWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupReadiness'][0] ]) : PromiseInterface

Get warmup readiness, adaptive pacing, and sender-health signals

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupReadiness'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupReadiness'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupReadinessRequest()

Create request for operation 'getEmailWarmupReadiness'


    public
                    getEmailWarmupReadinessRequest(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupReadiness'][0] ]) : Request

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupReadiness'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupReadiness'] to see the possible values for this operation

Return values

Request —

getEmailWarmupReadinessWithHttpInfo()

Operation getEmailWarmupReadinessWithHttpInfo


    public
                    getEmailWarmupReadinessWithHttpInfo(string $program_id[, string $contentType = self::contentTypes['getEmailWarmupReadiness'][0] ]) : array<string|int, mixed>

Get warmup readiness, adaptive pacing, and sender-health signals

Parameters

$program_id : string: (required)
$contentType : string = self::contentTypes['getEmailWarmupReadiness'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupReadiness'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupReadinessDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupSlots()

Operation getEmailWarmupSlots


    public
                    getEmailWarmupSlots(string $program_id, int $page[, int $size = 50 ][, string $contentType = self::contentTypes['getEmailWarmupSlots'][0] ]) : EmailWarmupSendSlotPageDto

List scheduled email warmup slots

Parameters

$program_id : string: program_id (required)
$page : int: page (optional, default to 0)
$size : int = 50: size (optional, default to 50)
$contentType : string = self::contentTypes['getEmailWarmupSlots'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupSlots'] to see the possible values for this operation

Return values

EmailWarmupSendSlotPageDto —

getEmailWarmupSlotsAsync()

Operation getEmailWarmupSlotsAsync


    public
                    getEmailWarmupSlotsAsync(string $program_id, int $page[, int $size = 50 ][, string $contentType = self::contentTypes['getEmailWarmupSlots'][0] ]) : PromiseInterface

List scheduled email warmup slots

Parameters

$program_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 50: (optional, default to 50)
$contentType : string = self::contentTypes['getEmailWarmupSlots'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupSlots'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupSlotsAsyncWithHttpInfo()

Operation getEmailWarmupSlotsAsyncWithHttpInfo


    public
                    getEmailWarmupSlotsAsyncWithHttpInfo(string $program_id, int $page[, int $size = 50 ][, string $contentType = self::contentTypes['getEmailWarmupSlots'][0] ]) : PromiseInterface

List scheduled email warmup slots

Parameters

$program_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 50: (optional, default to 50)
$contentType : string = self::contentTypes['getEmailWarmupSlots'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupSlots'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupSlotsRequest()

Create request for operation 'getEmailWarmupSlots'


    public
                    getEmailWarmupSlotsRequest(string $program_id, int $page[, int $size = 50 ][, string $contentType = self::contentTypes['getEmailWarmupSlots'][0] ]) : Request

Parameters

$program_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 50: (optional, default to 50)
$contentType : string = self::contentTypes['getEmailWarmupSlots'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupSlots'] to see the possible values for this operation

Return values

Request —

getEmailWarmupSlotsWithHttpInfo()

Operation getEmailWarmupSlotsWithHttpInfo


    public
                    getEmailWarmupSlotsWithHttpInfo(string $program_id, int $page[, int $size = 50 ][, string $contentType = self::contentTypes['getEmailWarmupSlots'][0] ]) : array<string|int, mixed>

List scheduled email warmup slots

Parameters

$program_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 50: (optional, default to 50)
$contentType : string = self::contentTypes['getEmailWarmupSlots'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupSlots'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupSendSlotPageDto, HTTP status code, HTTP response headers (array of strings)

getEmailWarmupUsage()

Operation getEmailWarmupUsage


    public
                    getEmailWarmupUsage([string $contentType = self::contentTypes['getEmailWarmupUsage'][0] ]) : EmailWarmupUsageSummaryDto

Get email warmup sender capacity, included credits, and billable usage

Parameters

$contentType : string = self::contentTypes['getEmailWarmupUsage'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupUsage'] to see the possible values for this operation

Return values

EmailWarmupUsageSummaryDto —

getEmailWarmupUsageAsync()

Operation getEmailWarmupUsageAsync


    public
                    getEmailWarmupUsageAsync([string $contentType = self::contentTypes['getEmailWarmupUsage'][0] ]) : PromiseInterface

Get email warmup sender capacity, included credits, and billable usage

Parameters

$contentType : string = self::contentTypes['getEmailWarmupUsage'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupUsage'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupUsageAsyncWithHttpInfo()

Operation getEmailWarmupUsageAsyncWithHttpInfo


    public
                    getEmailWarmupUsageAsyncWithHttpInfo([string $contentType = self::contentTypes['getEmailWarmupUsage'][0] ]) : PromiseInterface

Get email warmup sender capacity, included credits, and billable usage

Parameters

$contentType : string = self::contentTypes['getEmailWarmupUsage'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupUsage'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailWarmupUsageRequest()

Create request for operation 'getEmailWarmupUsage'


    public
                    getEmailWarmupUsageRequest([string $contentType = self::contentTypes['getEmailWarmupUsage'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getEmailWarmupUsage'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupUsage'] to see the possible values for this operation

Return values

Request —

getEmailWarmupUsageWithHttpInfo()

Operation getEmailWarmupUsageWithHttpInfo


    public
                    getEmailWarmupUsageWithHttpInfo([string $contentType = self::contentTypes['getEmailWarmupUsage'][0] ]) : array<string|int, mixed>

Get email warmup sender capacity, included credits, and billable usage

Parameters

$contentType : string = self::contentTypes['getEmailWarmupUsage'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailWarmupUsage'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupUsageSummaryDto, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

pauseEmailWarmupProgram()

Operation pauseEmailWarmupProgram


    public
                    pauseEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['pauseEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Pause an email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['pauseEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['pauseEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

pauseEmailWarmupProgramAsync()

Operation pauseEmailWarmupProgramAsync


    public
                    pauseEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['pauseEmailWarmupProgram'][0] ]) : PromiseInterface

Pause an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['pauseEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['pauseEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

pauseEmailWarmupProgramAsyncWithHttpInfo()

Operation pauseEmailWarmupProgramAsyncWithHttpInfo


    public
                    pauseEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['pauseEmailWarmupProgram'][0] ]) : PromiseInterface

Pause an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['pauseEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['pauseEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

pauseEmailWarmupProgramRequest()

Create request for operation 'pauseEmailWarmupProgram'


    public
                    pauseEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['pauseEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['pauseEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['pauseEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

pauseEmailWarmupProgramWithHttpInfo()

Operation pauseEmailWarmupProgramWithHttpInfo


    public
                    pauseEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['pauseEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Pause an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['pauseEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['pauseEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

resumeEmailWarmupProgram()

Operation resumeEmailWarmupProgram


    public
                    resumeEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['resumeEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Resume an email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['resumeEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['resumeEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

resumeEmailWarmupProgramAsync()

Operation resumeEmailWarmupProgramAsync


    public
                    resumeEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['resumeEmailWarmupProgram'][0] ]) : PromiseInterface

Resume an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['resumeEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['resumeEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

resumeEmailWarmupProgramAsyncWithHttpInfo()

Operation resumeEmailWarmupProgramAsyncWithHttpInfo


    public
                    resumeEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['resumeEmailWarmupProgram'][0] ]) : PromiseInterface

Resume an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['resumeEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['resumeEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

resumeEmailWarmupProgramRequest()

Create request for operation 'resumeEmailWarmupProgram'


    public
                    resumeEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['resumeEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['resumeEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['resumeEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

resumeEmailWarmupProgramWithHttpInfo()

Operation resumeEmailWarmupProgramWithHttpInfo


    public
                    resumeEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['resumeEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Resume an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['resumeEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['resumeEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

retryEmailWarmupProgram()

Operation retryEmailWarmupProgram


    public
                    retryEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['retryEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Retry a system-paused email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['retryEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['retryEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

retryEmailWarmupProgramAsync()

Operation retryEmailWarmupProgramAsync


    public
                    retryEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['retryEmailWarmupProgram'][0] ]) : PromiseInterface

Retry a system-paused email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['retryEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['retryEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

retryEmailWarmupProgramAsyncWithHttpInfo()

Operation retryEmailWarmupProgramAsyncWithHttpInfo


    public
                    retryEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['retryEmailWarmupProgram'][0] ]) : PromiseInterface

Retry a system-paused email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['retryEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['retryEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

retryEmailWarmupProgramRequest()

Create request for operation 'retryEmailWarmupProgram'


    public
                    retryEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['retryEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['retryEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['retryEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

retryEmailWarmupProgramWithHttpInfo()

Operation retryEmailWarmupProgramWithHttpInfo


    public
                    retryEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['retryEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Retry a system-paused email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['retryEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['retryEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

Return values

void —

startEmailWarmupProgram()

Operation startEmailWarmupProgram


    public
                    startEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['startEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Start an email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['startEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['startEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

startEmailWarmupProgramAsync()

Operation startEmailWarmupProgramAsync


    public
                    startEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['startEmailWarmupProgram'][0] ]) : PromiseInterface

Start an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['startEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['startEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

startEmailWarmupProgramAsyncWithHttpInfo()

Operation startEmailWarmupProgramAsyncWithHttpInfo


    public
                    startEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['startEmailWarmupProgram'][0] ]) : PromiseInterface

Start an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['startEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['startEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

startEmailWarmupProgramRequest()

Create request for operation 'startEmailWarmupProgram'


    public
                    startEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['startEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['startEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['startEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

startEmailWarmupProgramWithHttpInfo()

Operation startEmailWarmupProgramWithHttpInfo


    public
                    startEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['startEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Start an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['startEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['startEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

stopEmailWarmupProgram()

Operation stopEmailWarmupProgram


    public
                    stopEmailWarmupProgram(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['stopEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Stop an email warmup program

Parameters

$program_id : string: program_id (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: email_warmup_program_command_options (required)
$contentType : string = self::contentTypes['stopEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['stopEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

stopEmailWarmupProgramAsync()

Operation stopEmailWarmupProgramAsync


    public
                    stopEmailWarmupProgramAsync(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['stopEmailWarmupProgram'][0] ]) : PromiseInterface

Stop an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['stopEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['stopEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

stopEmailWarmupProgramAsyncWithHttpInfo()

Operation stopEmailWarmupProgramAsyncWithHttpInfo


    public
                    stopEmailWarmupProgramAsyncWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['stopEmailWarmupProgram'][0] ]) : PromiseInterface

Stop an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['stopEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['stopEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

stopEmailWarmupProgramRequest()

Create request for operation 'stopEmailWarmupProgram'


    public
                    stopEmailWarmupProgramRequest(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['stopEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['stopEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['stopEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

stopEmailWarmupProgramWithHttpInfo()

Operation stopEmailWarmupProgramWithHttpInfo


    public
                    stopEmailWarmupProgramWithHttpInfo(string $program_id, EmailWarmupProgramCommandOptions $email_warmup_program_command_options[, string $contentType = self::contentTypes['stopEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Stop an email warmup program

Parameters

$program_id : string: (required)
$email_warmup_program_command_options : EmailWarmupProgramCommandOptions: (required)
$contentType : string = self::contentTypes['stopEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['stopEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

updateEmailWarmupProgram()

Operation updateEmailWarmupProgram


    public
                    updateEmailWarmupProgram(string $program_id, UpdateEmailWarmupProgramOptions $update_email_warmup_program_options[, string $contentType = self::contentTypes['updateEmailWarmupProgram'][0] ]) : EmailWarmupProgramDto

Update a draft email warmup program

Parameters

$program_id : string: program_id (required)
$update_email_warmup_program_options : UpdateEmailWarmupProgramOptions: update_email_warmup_program_options (required)
$contentType : string = self::contentTypes['updateEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupProgram'] to see the possible values for this operation

Return values

EmailWarmupProgramDto —

updateEmailWarmupProgramAsync()

Operation updateEmailWarmupProgramAsync


    public
                    updateEmailWarmupProgramAsync(string $program_id, UpdateEmailWarmupProgramOptions $update_email_warmup_program_options[, string $contentType = self::contentTypes['updateEmailWarmupProgram'][0] ]) : PromiseInterface

Update a draft email warmup program

Parameters

$program_id : string: (required)
$update_email_warmup_program_options : UpdateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

updateEmailWarmupProgramAsyncWithHttpInfo()

Operation updateEmailWarmupProgramAsyncWithHttpInfo


    public
                    updateEmailWarmupProgramAsyncWithHttpInfo(string $program_id, UpdateEmailWarmupProgramOptions $update_email_warmup_program_options[, string $contentType = self::contentTypes['updateEmailWarmupProgram'][0] ]) : PromiseInterface

Update a draft email warmup program

Parameters

$program_id : string: (required)
$update_email_warmup_program_options : UpdateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupProgram'] to see the possible values for this operation

Return values

PromiseInterface —

updateEmailWarmupProgramRequest()

Create request for operation 'updateEmailWarmupProgram'


    public
                    updateEmailWarmupProgramRequest(string $program_id, UpdateEmailWarmupProgramOptions $update_email_warmup_program_options[, string $contentType = self::contentTypes['updateEmailWarmupProgram'][0] ]) : Request

Parameters

$program_id : string: (required)
$update_email_warmup_program_options : UpdateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupProgram'] to see the possible values for this operation

Return values

Request —

updateEmailWarmupProgramWithHttpInfo()

Operation updateEmailWarmupProgramWithHttpInfo


    public
                    updateEmailWarmupProgramWithHttpInfo(string $program_id, UpdateEmailWarmupProgramOptions $update_email_warmup_program_options[, string $contentType = self::contentTypes['updateEmailWarmupProgram'][0] ]) : array<string|int, mixed>

Update a draft email warmup program

Parameters

$program_id : string: (required)
$update_email_warmup_program_options : UpdateEmailWarmupProgramOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupProgram'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupProgram'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupProgramDto, HTTP status code, HTTP response headers (array of strings)

updateEmailWarmupSenderSeats()

Operation updateEmailWarmupSenderSeats


    public
                    updateEmailWarmupSenderSeats(UpdateEmailWarmupSenderSeatsOptions $update_email_warmup_sender_seats_options[, string $contentType = self::contentTypes['updateEmailWarmupSenderSeats'][0] ]) : EmailWarmupUsageSummaryDto

Update purchased email warmup sender seats

Parameters

$update_email_warmup_sender_seats_options : UpdateEmailWarmupSenderSeatsOptions: update_email_warmup_sender_seats_options (required)
$contentType : string = self::contentTypes['updateEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

EmailWarmupUsageSummaryDto —

updateEmailWarmupSenderSeatsAsync()

Operation updateEmailWarmupSenderSeatsAsync


    public
                    updateEmailWarmupSenderSeatsAsync(UpdateEmailWarmupSenderSeatsOptions $update_email_warmup_sender_seats_options[, string $contentType = self::contentTypes['updateEmailWarmupSenderSeats'][0] ]) : PromiseInterface

Update purchased email warmup sender seats

Parameters

$update_email_warmup_sender_seats_options : UpdateEmailWarmupSenderSeatsOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

PromiseInterface —

updateEmailWarmupSenderSeatsAsyncWithHttpInfo()

Operation updateEmailWarmupSenderSeatsAsyncWithHttpInfo


    public
                    updateEmailWarmupSenderSeatsAsyncWithHttpInfo(UpdateEmailWarmupSenderSeatsOptions $update_email_warmup_sender_seats_options[, string $contentType = self::contentTypes['updateEmailWarmupSenderSeats'][0] ]) : PromiseInterface

Update purchased email warmup sender seats

Parameters

$update_email_warmup_sender_seats_options : UpdateEmailWarmupSenderSeatsOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

PromiseInterface —

updateEmailWarmupSenderSeatsRequest()

Create request for operation 'updateEmailWarmupSenderSeats'


    public
                    updateEmailWarmupSenderSeatsRequest(UpdateEmailWarmupSenderSeatsOptions $update_email_warmup_sender_seats_options[, string $contentType = self::contentTypes['updateEmailWarmupSenderSeats'][0] ]) : Request

Parameters

$update_email_warmup_sender_seats_options : UpdateEmailWarmupSenderSeatsOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

Request —

updateEmailWarmupSenderSeatsWithHttpInfo()

Operation updateEmailWarmupSenderSeatsWithHttpInfo


    public
                    updateEmailWarmupSenderSeatsWithHttpInfo(UpdateEmailWarmupSenderSeatsOptions $update_email_warmup_sender_seats_options[, string $contentType = self::contentTypes['updateEmailWarmupSenderSeats'][0] ]) : array<string|int, mixed>

Update purchased email warmup sender seats

Parameters

$update_email_warmup_sender_seats_options : UpdateEmailWarmupSenderSeatsOptions: (required)
$contentType : string = self::contentTypes['updateEmailWarmupSenderSeats'][0]: The value for the Content-Type header. Check self::contentTypes['updateEmailWarmupSenderSeats'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailWarmupUsageSummaryDto, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

ApiEmailWarmupControllerApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

createEmailWarmupProgram()

Parameters

Tags

Return values

createEmailWarmupProgramAsync()

Parameters

Tags

Return values

createEmailWarmupProgramAsyncWithHttpInfo()

Parameters

Tags

Return values

createEmailWarmupProgramRequest()

Parameters

Tags

Return values

createEmailWarmupProgramWithHttpInfo()

Parameters

Tags

Return values

deleteEmailWarmupProgram()

Parameters

Tags

Return values

deleteEmailWarmupProgramAsync()

Parameters

Tags

Return values

deleteEmailWarmupProgramAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteEmailWarmupProgramRequest()

Parameters

Tags

Return values

deleteEmailWarmupProgramWithHttpInfo()

Parameters

Tags

Return values

deleteEmailWarmupSenderSeats()

Parameters

Tags

Return values

deleteEmailWarmupSenderSeatsAsync()

Parameters

Tags

Return values

deleteEmailWarmupSenderSeatsAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteEmailWarmupSenderSeatsRequest()

Parameters

Tags

Return values

deleteEmailWarmupSenderSeatsWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getEmailWarmupOverview()

Parameters

Tags

Return values

ApiEmailWarmupControllerApi
in package

MailSlurp