class Emails in Auth0 Single Sign On 8.2

Hierarchy

• class \Auth0\SDK\API\Management\GenericResource
  • class \Auth0\SDK\API\Management\Emails

1 file declares its use of Emails

Management.php in vendor/auth0/auth0-php/src/API/Management.php

File

vendor/auth0/auth0-php/src/API/Management/Emails.php, line 5

Namespace

Auth0\SDK\API\Management

class Emails extends GenericResource {

  /**
   *
   * @param  null|string|array $fields
   * @param  null|string|array $include_fields
   * @return mixed
   */
  public function getEmailProvider($fields = null, $include_fields = null) {
    $request = $this->apiClient
      ->method('get')
      ->addPath('emails')
      ->addPath('provider');
    if ($fields !== null) {
      if (is_array($fields)) {
        $fields = implode(',', $fields);
      }
      $request
        ->withParam('fields', $fields);
    }
    if ($include_fields !== null) {
      $request
        ->withParam('include_fields', $include_fields);
    }
    return $request
      ->call();
  }

  /**
   *
   * @param  array $data
   * @return mixed
   */
  public function configureEmailProvider($data) {
    return $this->apiClient
      ->method('post')
      ->addPath('emails')
      ->addPath('provider')
      ->withBody(json_encode($data))
      ->call();
  }

  /**
   *
   * @param  array $data
   * @return mixed
   */
  public function updateEmailProvider($data) {
    return $this->apiClient
      ->method('patch')
      ->addPath('emails')
      ->addPath('provider')
      ->withBody(json_encode($data))
      ->call();
  }

  /**
   *
   * @return mixed
   */
  public function deleteEmailProvider() {
    return $this->apiClient
      ->method('delete')
      ->addPath('emails')
      ->addPath('provider')
      ->call();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Emails::configureEmailProvider	public	function
Emails::deleteEmailProvider	public	function
Emails::getEmailProvider	public	function
Emails::updateEmailProvider	public	function
GenericResource::$apiClient	protected	property	Injected ApiClient instance to use.
GenericResource::checkEmptyOrInvalidString	protected	function	Check that a variable is a string and is not empty.
GenericResource::checkInvalidPermissions	protected	function	Check for invalid permissions with an array of permissions.
GenericResource::getApiClient	public	function	Get the injected ApiClient instance.
GenericResource::normalizeIncludeTotals	protected	function	Normalize include_totals parameter.
GenericResource::normalizePagination	protected	function	Normalize pagination parameters.
GenericResource::__construct	public	function	GenericResource constructor.