PHP API Client for Freshmail API V3
This API V3 client covers only sending transactional emails by FreshMail Application. If You want to use any other functions of API use API V2 client.
- PHP7.2 and above
Update your composer.json and run composer update
{
"require": {
"freshmail/php-api-client": "^1.0"
}
}or execute
composer require freshmail/php-api-clientuse \FreshMail\Api\Client\Service\Messaging\Mail;
use \FreshMail\Api\Client\Messaging\Mail\MailBag;
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mail = new MailBag();
$mail->setFrom('[email protected]', 'Office');
$mail->setSubject('That\'s my awesome first mail!');
$mail->setHtml('<html><body><strong>Look!</strong> its working!</body></html>');
$mail->addRecipientTo('recipient email address');
$response = $mailService->send($mail);if ($response->isSuccess()) {
$responseData = $response->getData();
}Handle with raw PSR-7 ResponseInterface
$response->getPsr7Response();use \FreshMail\Api\Client\Service\Messaging\Mail;
use \FreshMail\Api\Client\Messaging\Mail\MailBag;
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mail = new MailBag();
$mail->setFrom('[email protected]', 'Office');
$mail->setSubject('Hello $$first_name$$! I\'v got promotion code for You!');
$mail->setHtml('<html><body>Your code is <strong>$$code$$</strong></body></html>');
$mail->addRecipientTo('recipient email address', [
'first_name' => 'Joshua',
'code' => 'CODE1234'
]);
$response = $mailService->send($mail);You can send multiple emails by one request. It's much faster than sending one email by one request. In one request You can send up to 100 emails.
use \FreshMail\Api\Client\Service\Messaging\Mail;
use \FreshMail\Api\Client\Messaging\Mail\MailBag;
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mail = new MailBag();
$mail->setFrom('[email protected]', 'Office');
$mail->setSubject('Hello $$first_name$$! I\'v got promotion code for You!');
$mail->setHtml('<html><body>Your code is <strong>$$code$$</strong></body></html>');
//first recipient
$mail->addRecipientTo('recipient email address', [
'first_name' => 'Joshua',
'code' => '10percentDISCOUNT'
]);
//second recipient
$mail->addRecipientTo('second recipient email address', [
'first_name' => 'Donald',
'code' => '25percentDISCOUNT'
]);
//third recipient
$mail->addRecipientTo('third recipient email address', [
'first_name' => 'Abbie',
'code' => 'FREEshippingDISCOUNT'
]);
$response = $mailService->send($mail);You can use FreshMail Templates mechanism to optimize requests to API. Additionally You can modify content of Your emails in FreshMail, not modifying the code of Your application.
use \FreshMail\Api\Client\Service\Messaging\Mail;
use \FreshMail\Api\Client\Messaging\Mail\MailBag;
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mail = new MailBag();
$mail->setFrom('[email protected]', 'Support');
$mail->setSubject('Hello, that\'s my email genereted by template!');
$mail->setTemplateHash('TEMPLATE_HASH');
$mail->addRecipientTo('recipient email address');
$response = $mailService->send($mail);You can sent emails with attachments. You can upload up to 10 files. Weight of all attachments in email can't exceed 10Mb.
use \FreshMail\Api\Client\Service\Messaging\Mail;
use \FreshMail\Api\Client\Messaging\Mail\Base64Attachment;
use \FreshMail\Api\Client\Messaging\Mail\LocalFileAttachment;
use \FreshMail\Api\Client\Messaging\Mail\MailBag;
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
//attachment from hard drive
$localFileAttachment = new LocalFileAttachment(
'/my/local/path/file.extension',
'optional file name'
);
//attachment from base64
$base64Attachment = new Base64Attachment(
'example.txt',
base64_encode('example content')
);
$mail = new MailBag();
$mail->setFrom('[email protected]', 'Support');
$mail->setSubject('Hello, thats mail with attachments!!');
$mail->setHtml('<html><body><strong>Attachments</strong> in mail</body></html>');
$mail->addRecipientTo('recipient email address');
$mail->addAttachment($localFileAttachment);
$mail->addAttachment($base64Attachment);
$response = $mailService->send($mail);API throws exceptions for errors that occurred during requests and errors occurred before sending requests.
- If request is not sent to server because of wrong API usage, a
FreshMail\Api\Client\Exception\ApiUsageExceptionis thrown. This kind of exception means, for example, wrong parameters pass to some methods or passing both content and template in transactional mail, which means request won't be accepted, so API does not make any request. - If request is sent and some network issue occurred (DNS error, connection timeout, firewall blocking requests), a
FreshMail\Api\Client\Exception\RequestExceptionis thrown. - If request is sent, a response is received but some server error occurred (500 level http code), a
FreshMail\Api\Client\Exception\ServerExceptionis thrown. - If request is sent, a response is received but some client error occurred (400 level http code), a
FreshMail\Api\Client\Exception\ClientErroris thrown. This error message hasgetRequestandgetResponsemethods to receive raw Request nad Response object (implemented by PSR-7Psr\Http\Message\RequestInterfaceandPsr\Http\Message\ResponseInterface)
use FreshMail\Api\Client\Exception\ClientError;
try {
$response = $mailService->send($mail);
} catch (ClientException $exception) {
echo $exception->getRequest()->getBody();
echo $exception->getResponse()->getBody();
}FreshMail\Api\Client\Exception\RequestException, FreshMail\Api\Client\Exception\ClientException and FreshMail\Api\Client\Exception\ServerException extends from FreshMail\Api\Client\Exception\TransferException.
FreshMail\Api\Client\Exception\TransferException and FreshMail\Api\Client\Exception\ApiUsageException extends from FreshMail\Api\Client\Exception\GeneralApiException. All exceptions has methods hasRequest, hasResponse.
use FreshMail\Api\Client\Exception\GeneralApiException;
try {
$response = $mailService->send($mail);
} catch (GeneralApiException $exception) {
$error = $exception->getMessage();
if ($exception->hasRequest()) {
$request = (string) $exception->getRequest()->getBody();
}
if ($exception->hasResponse()) {
$response = (string) $exception->getResponse()->getBody();
}
}If You need to configure proxy You can use a custom GuzzleHttp\Client object.
use \FreshMail\Api\Client\Service\Messaging\Mail;
$client = new \GuzzleHttp\Client(
[
'proxy' => 'my proxy url'
]
);
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mailService->setGuzzleHttpClient($client);If You need to log or debug Your request You can use 2 features.
You can use any library that implements PSR-3 Psr\Log\LoggerInterface, example with Monolog below:
use \FreshMail\Api\Client\Service\Messaging\Mail;
$logger = new \Monolog\Logger('myCustomLogger');
$logger->pushHandler(new \Monolog\Handler\StreamHandler('php:https://stderr', \Monolog\Logger::DEBUG));
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mailService->setLogger($logger);To make request API use GuzzleHttp\Client object. If You want You can configure it in any way You want, especially You can enable logging in Client.
use \FreshMail\Api\Client\Service\Messaging\Mail;
$stack = \GuzzleHttp\HandlerStack::create();
$stack->push(
\GuzzleHttp\Middleware::log(
new \Monolog\Logger('Logger'),
new \GuzzleHttp\MessageFormatter('{req_body} - {res_body}')
)
);
$client = new \GuzzleHttp\Client(
[
'handler' => $stack,
]
);
$token = 'MY_APP_TOKEN';
$mailService = new Mail($token);
$mailService->setGuzzleHttpClient($client);