Swagger\Client\SMTPApi

All URIs are relative to https://api.mailvio.com/v3/

Method	HTTP request	Description
createSmtpTemplate	POST /smtp/templates	Create a transactional email template
deleteHardbounces	POST /smtp/deleteHardbounces	Delete hardbounces
deleteSmtpTemplate	DELETE /smtp/templates/{templateId}	Delete an inactive transactional email template
getAggregatedSmtpReport	GET /smtp/statistics/aggregatedReport	Get your transactional email activity aggregated over a period of time
getEmailEventReport	GET /smtp/statistics/events	Get all your transactional email activity (unaggregated events)
getSmtpReport	GET /smtp/statistics/reports	Get your transactional email activity aggregated per day
getSmtpTemplate	GET /smtp/templates/{templateId}	Returns the template informations
getSmtpTemplates	GET /smtp/templates	Get the list of transactional email templates
getTransacBlockedContacts	GET /smtp/blockedContacts	Get the list of blocked or unsubscribed transactional contacts
getTransacEmailContent	GET /smtp/emails/{uuid}	Get the personalized content of a sent transactional email
getTransacEmailsList	GET /smtp/emails	Get the list of transactional emails on the basis of allowed filters
sendTemplate	POST /smtp/templates/{templateId}/send	Send a template
sendTestTemplate	POST /smtp/templates/{templateId}/sendTest	Send a template to your test list
sendTransacEmail	POST /smtp/email	Send a transactional email
updateSmtpTemplate	PUT /smtp/templates/{templateId}	Updates a transactional email templates

createSmtpTemplate

\Swagger\Client\Model\CreateModel createSmtpTemplate($smtp_template)

Create a transactional email template

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$smtp_template = new \Swagger\Client\Model\CreateSmtpTemplate(); // \Swagger\Client\Model\CreateSmtpTemplate | values to update in transactional email template

try {
    $result = $api_instance->createSmtpTemplate($smtp_template);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->createSmtpTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
smtp_template	\Swagger\Client\Model\CreateSmtpTemplate	values to update in transactional email template

Return type

\Swagger\Client\Model\CreateModel

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteHardbounces

deleteHardbounces($delete_hardbounces)

Delete hardbounces

Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$delete_hardbounces = new \Swagger\Client\Model\DeleteHardbounces(); // \Swagger\Client\Model\DeleteHardbounces | values to delete hardbounces

try {
    $api_instance->deleteHardbounces($delete_hardbounces);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->deleteHardbounces: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
delete_hardbounces	\Swagger\Client\Model\DeleteHardbounces	values to delete hardbounces	[optional]

Return type

void (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSmtpTemplate

deleteSmtpTemplate($template_id)

Delete an inactive transactional email template

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_id = 789; // int | id of the template

try {
    $api_instance->deleteSmtpTemplate($template_id);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->deleteSmtpTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	int	id of the template

Return type

void (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAggregatedSmtpReport

\Swagger\Client\Model\GetAggregatedReport getAggregatedSmtpReport($start_date, $end_date, $days, $tag)

Get your transactional email activity aggregated over a period of time

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$start_date = "start_date_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
$end_date = "end_date_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
$days = 56; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
$tag = "tag_example"; // string | Tag of the emails

try {
    $result = $api_instance->getAggregatedSmtpReport($start_date, $end_date, $days, $tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getAggregatedSmtpReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
start_date	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate	[optional]
end_date	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate	[optional]
days	int	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
tag	string	Tag of the emails	[optional]

Return type

\Swagger\Client\Model\GetAggregatedReport

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEventReport

\Swagger\Client\Model\GetEmailEventReport getEmailEventReport($limit, $offset, $start_date, $end_date, $days, $email, $event, $tags, $message_id, $template_id)

Get all your transactional email activity (unaggregated events)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$limit = 50; // int | Number limitation for the result returned
$offset = 0; // int | Beginning point in the list to retrieve from.
$start_date = "start_date_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
$end_date = "end_date_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
$days = 56; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
$email = "email_example"; // string | Filter the report for a specific email addresses
$event = "event_example"; // string | Filter the report for a specific event type
$tags = "tags_example"; // string | Filter the report for tags (serialized and urlencoded array)
$message_id = "message_id_example"; // string | Filter on a specific message id
$template_id = 789; // int | Filter on a specific template id

try {
    $result = $api_instance->getEmailEventReport($limit, $offset, $start_date, $end_date, $days, $email, $event, $tags, $message_id, $template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getEmailEventReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
limit	int	Number limitation for the result returned	[optional] [default to 50]
offset	int	Beginning point in the list to retrieve from.	[optional] [default to 0]
start_date	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate	[optional]
end_date	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate	[optional]
days	int	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
email	string	Filter the report for a specific email addresses	[optional]
event	string	Filter the report for a specific event type	[optional]
tags	string	Filter the report for tags (serialized and urlencoded array)	[optional]
message_id	string	Filter on a specific message id	[optional]
template_id	int	Filter on a specific template id	[optional]

Return type

\Swagger\Client\Model\GetEmailEventReport

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSmtpReport

\Swagger\Client\Model\GetReports getSmtpReport($limit, $offset, $start_date, $end_date, $days, $tag)

Get your transactional email activity aggregated per day

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$limit = 50; // int | Number of documents returned per page
$offset = 0; // int | Index of the first document on the page
$start_date = "start_date_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
$end_date = "end_date_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
$days = 56; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
$tag = "tag_example"; // string | Tag of the emails

try {
    $result = $api_instance->getSmtpReport($limit, $offset, $start_date, $end_date, $days, $tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getSmtpReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
limit	int	Number of documents returned per page	[optional] [default to 50]
offset	int	Index of the first document on the page	[optional] [default to 0]
start_date	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)	[optional]
end_date	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)	[optional]
days	int	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
tag	string	Tag of the emails	[optional]

Return type

\Swagger\Client\Model\GetReports

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSmtpTemplate

\Swagger\Client\Model\GetSmtpTemplateOverview getSmtpTemplate($template_id)

Returns the template informations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_id = 789; // int | id of the template

try {
    $result = $api_instance->getSmtpTemplate($template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getSmtpTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	int	id of the template

Return type

\Swagger\Client\Model\GetSmtpTemplateOverview

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSmtpTemplates

\Swagger\Client\Model\GetSmtpTemplates getSmtpTemplates($template_status, $limit, $offset)

Get the list of transactional email templates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_status = true; // bool | Filter on the status of the template. Active = true, inactive = false
$limit = 50; // int | Number of documents returned per page
$offset = 0; // int | Index of the first document in the page

try {
    $result = $api_instance->getSmtpTemplates($template_status, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getSmtpTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_status	bool	Filter on the status of the template. Active = true, inactive = false	[optional]
limit	int	Number of documents returned per page	[optional] [default to 50]
offset	int	Index of the first document in the page	[optional] [default to 0]

Return type

\Swagger\Client\Model\GetSmtpTemplates

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransacBlockedContacts

\Swagger\Client\Model\GetTransacBlockedContacts getTransacBlockedContacts($start_date, $end_date, $limit, $offset, $senders)

Get the list of blocked or unsubscribed transactional contacts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$start_date = "start_date_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
$end_date = "end_date_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
$limit = 50; // int | Number of documents returned per page
$offset = 0; // int | Index of the first document on the page
$senders = array("senders_example"); // string[] | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed

try {
    $result = $api_instance->getTransacBlockedContacts($start_date, $end_date, $limit, $offset, $senders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getTransacBlockedContacts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
start_date	string	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts	[optional]
end_date	string	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts	[optional]
limit	int	Number of documents returned per page	[optional] [default to 50]
offset	int	Index of the first document on the page	[optional] [default to 0]
senders	string[]	Comma separated list of emails of the senders from which contacts are blocked or unsubscribed	[optional]

Return type

\Swagger\Client\Model\GetTransacBlockedContacts

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransacEmailContent

\Swagger\Client\Model\GetTransacEmailContent getTransacEmailContent($uuid)

Get the personalized content of a sent transactional email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$uuid = "uuid_example"; // string | Unique id of the transactional email that has been sent to a particular contact

try {
    $result = $api_instance->getTransacEmailContent($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getTransacEmailContent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
uuid	string	Unique id of the transactional email that has been sent to a particular contact

Return type

\Swagger\Client\Model\GetTransacEmailContent

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransacEmailsList

\Swagger\Client\Model\GetTransacEmailsList getTransacEmailsList($email, $template_id, $message_id, $start_date, $end_date)

Get the list of transactional emails on the basis of allowed filters

This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$email = "email_example"; // string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
$template_id = 789; // int | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
$message_id = "message_id_example"; // string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
$start_date = "start_date_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
$end_date = new \DateTime(); // \DateTime | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

try {
    $result = $api_instance->getTransacEmailsList($email, $template_id, $message_id, $start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->getTransacEmailsList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
email	string	Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.	[optional]
template_id	int	Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.	[optional]
message_id	string	Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.	[optional]
start_date	string	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]
end_date	\DateTime	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]

Return type

\Swagger\Client\Model\GetTransacEmailsList

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendTemplate

\Swagger\Client\Model\SendTemplateEmail sendTemplate($template_id, $send_email)

Send a template

This endpoint is deprecated. Prefer v3/smtp/email instead.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_id = 789; // int | Id of the template
$send_email = new \Swagger\Client\Model\SendEmail(); // \Swagger\Client\Model\SendEmail | 

try {
    $result = $api_instance->sendTemplate($template_id, $send_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->sendTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	int	Id of the template
send_email	\Swagger\Client\Model\SendEmail

Return type

\Swagger\Client\Model\SendTemplateEmail

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendTestTemplate

sendTestTemplate($template_id, $send_test_email)

Send a template to your test list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_id = 789; // int | Id of the template
$send_test_email = new \Swagger\Client\Model\SendTestEmail(); // \Swagger\Client\Model\SendTestEmail | 

try {
    $api_instance->sendTestTemplate($template_id, $send_test_email);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->sendTestTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	int	Id of the template
send_test_email	\Swagger\Client\Model\SendTestEmail

Return type

void (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendTransacEmail

\Swagger\Client\Model\CreateSmtpEmail sendTransacEmail($send_smtp_email)

Send a transactional email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$send_smtp_email = new \Swagger\Client\Model\SendSmtpEmail(); // \Swagger\Client\Model\SendSmtpEmail | Values to send a transactional email

try {
    $result = $api_instance->sendTransacEmail($send_smtp_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->sendTransacEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
send_smtp_email	\Swagger\Client\Model\SendSmtpEmail	Values to send a transactional email

Return type

\Swagger\Client\Model\CreateSmtpEmail

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSmtpTemplate

updateSmtpTemplate($template_id, $smtp_template)

Updates a transactional email templates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\SMTPApi();
$template_id = 789; // int | id of the template
$smtp_template = new \Swagger\Client\Model\UpdateSmtpTemplate(); // \Swagger\Client\Model\UpdateSmtpTemplate | values to update in transactional email template

try {
    $api_instance->updateSmtpTemplate($template_id, $smtp_template);
} catch (Exception $e) {
    echo 'Exception when calling SMTPApi->updateSmtpTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	int	id of the template
smtp_template	\Swagger\Client\Model\UpdateSmtpTemplate	values to update in transactional email template

Return type

void (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SMTPApi.md

Latest commit

History

SMTPApi.md

File metadata and controls

Swagger\Client\SMTPApi

createSmtpTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

deleteHardbounces

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSmtpTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

getAggregatedSmtpReport

Example

Parameters

Return type

Authorization

HTTP request headers

getEmailEventReport

Example

Parameters

Return type

Authorization

HTTP request headers

getSmtpReport

Example

Parameters

Return type

Authorization

HTTP request headers

getSmtpTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

getSmtpTemplates

Example

Parameters

Return type

Authorization

HTTP request headers

getTransacBlockedContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getTransacEmailContent

Example

Parameters

Return type

Authorization

HTTP request headers

getTransacEmailsList

Example

Parameters

Return type

Authorization

HTTP request headers

sendTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

sendTestTemplate