PHP Class Mailgun\RequestBuilder

Author: Tobias Nyholm ([email protected])
Show file Open project: mailgun/mailgun-php Class Usage Examples

Public Methods

Method Description
create ( string $method, string $uri, array $headers = [], array | string | null $body = null ) : Psr\Http\Message\RequestInterface Creates a new PSR-7 request.
setMultipartStreamBuilder ( Http\Message\MultipartStream\MultipartStreamBuilder $multipartStreamBuilder ) : RequestBuilder
setRequestFactory ( Http\Message\RequestFactory $requestFactory ) : RequestBuilder

Private Methods

Method Description
getMultipartStreamBuilder ( ) : Http\Message\MultipartStream\MultipartStreamBuilder
getRequestFactory ( ) : Http\Message\RequestFactory

Method Details

create() public method

Creates a new PSR-7 request.
public create ( string $method, string $uri, array $headers = [], array | string | null $body = null ) : Psr\Http\Message\RequestInterface
$method string
$uri string
$headers array
$body array | string | null Request body. If body is an array we will send a as multipart stream request. If array, each array *item* MUST look like: array ( 'content' => string|resource|StreamInterface, 'name' => string, 'filename'=> string (optional) 'headers' => array (optinal) ['header-name' => 'header-value'] )
return Psr\Http\Message\RequestInterface

setMultipartStreamBuilder() public method

public setMultipartStreamBuilder ( Http\Message\MultipartStream\MultipartStreamBuilder $multipartStreamBuilder ) : RequestBuilder
$multipartStreamBuilder Http\Message\MultipartStream\MultipartStreamBuilder
return RequestBuilder

setRequestFactory() public method

public setRequestFactory ( Http\Message\RequestFactory $requestFactory ) : RequestBuilder
$requestFactory Http\Message\RequestFactory
return RequestBuilder