Error handling¶

The Crunchmail API Client simplifies the exceptions that Guzzle will throw in different scenarios, and always throws an ApiException for API errors.

For other errors, the client will throw a RuntimeException most of the time. This will most likely happens when using the client in a wrong way.

The ApiException Class¶

Method:	`getMessage()`
Summary:	Returns the error message sent by the API
Return:	String

try
{
    $client->invalidresource->get();
}
catch (\Crunchmail\Exceptions\ApiException $e)
{
    echo "Error: " . $e->getMessage();
}

Warning

The message may or may not contain html tags, be careful when printing it.

try
{
    $client->invalidresource->get();
}
catch (\Crunchmail\Exceptions\ApiException $e)
{
    echo "Error code was " . $e->getCode();
}

Method:	`getDetail()`
Summary:	Return details about the exception
Return:	stdClass

try
{
    $client->invalidresource->get();
}
catch (\Crunchmail\Exceptions\ApiException $e)
{
    var_dump($e->getDetail());
}

Method:	`toHtml()`
Summary:	Return a debug string, in HTML format
Return:	String

try
{
    $client->invalidresource->get();
}
catch (\Crunchmail\Exceptions\ApiException $e)
{
    echo $e->toHtml();
}