RetailCRM-Mirror/mailgun-php
1
0
Fork 0
mirror of https://github.com/retailcrm/mailgun-php.git synced 2024-11-25 22:36:06 +03:00
Code Issues Projects Releases Wiki Activity

phpdoc

Browse Source
This commit is contained in:
Artem Bondarenko 2020-11-26 20:03:00 +02:00 committed by David Garcia
parent 8c5c99a356
commit 2a35fcb077
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/Api/EmailValidationV4.php
View File

@ -34,6 +34,7 @@ class EmailValidationV4 extends HttpApi
* Addresses are validated based off defined checks. * Addresses are validated based off defined checks.
* *
* @param string $address An email address to validate. Maximum: 512 characters. * @param string $address An email address to validate. Maximum: 512 characters.
* @param bool $providerLookup
* *
* @return ValidateResponse|ResponseInterface * @return ValidateResponse|ResponseInterface
* *
@ -54,6 +55,7 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $listId
* @param mixed $filePath - file path or file content * @param mixed $filePath - file path or file content
* *
* @return mixed|ResponseInterface * @return mixed|ResponseInterface
@ -83,7 +85,10 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $fieldName
* @param array $filePath ['fileContent' => 'content'] or ['filePath' => '/foo/bar'] * @param array $filePath ['fileContent' => 'content'] or ['filePath' => '/foo/bar']
*
* @return array
*/ */
private function prepareFile(string $fieldName, array $filePath): array private function prepareFile(string $fieldName, array $filePath): array
{ {
@ -117,6 +122,7 @@ class EmailValidationV4 extends HttpApi
/** /**
* Close open resources. * Close open resources.
* @param array $params
*/ */
private function closeResources(array $params): void private function closeResources(array $params): void
{ {
@ -128,6 +134,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $listId
*
* @return DeleteBulkJobResponse|ResponseInterface * @return DeleteBulkJobResponse|ResponseInterface
* *
* @throws Exception * @throws Exception
@ -142,6 +150,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $listId
*
* @return GetBulkJobResponse|ResponseInterface * @return GetBulkJobResponse|ResponseInterface
* *
* @throws Exception * @throws Exception
@ -156,6 +166,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param int $limit
*
* @return GetBulkJobsResponse|ResponseInterface * @return GetBulkJobsResponse|ResponseInterface
* *
* @throws Exception * @throws Exception
@ -172,6 +184,13 @@ class EmailValidationV4 extends HttpApi
return $this->hydrateResponse($response, GetBulkJobsResponse::class); return $this->hydrateResponse($response, GetBulkJobsResponse::class);
} }
/**
* @param int $limit
*
* @return mixed|ResponseInterface
*
* @throws Exception
*/
public function getBulkPreviews(int $limit = 500) public function getBulkPreviews(int $limit = 500)
{ {
Assert::integer($limit); Assert::integer($limit);
@ -185,6 +204,10 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $previewId
*
* @param mixed $filePath
*
* @return mixed|ResponseInterface * @return mixed|ResponseInterface
* *
* @throws Exception * @throws Exception
@ -212,6 +235,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $previewId
*
* @return mixed|ResponseInterface * @return mixed|ResponseInterface
* *
* @throws Exception * @throws Exception
@ -226,6 +251,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $previewId
*
* @return bool * @return bool
*/ */
public function deleteBulkPreview(string $previewId) public function deleteBulkPreview(string $previewId)
@ -238,6 +265,8 @@ class EmailValidationV4 extends HttpApi
} }
/** /**
* @param string $previewId
*
* @return mixed|ResponseInterface * @return mixed|ResponseInterface
* *
* @throws Exception * @throws Exception