PHP Класс Mailgun\Api\Domain

Автор: Sean Johnson ([email protected])
Наследование: extends HttpApi
Показать файл Открыть проект

Открытые методы

Метод Описание
connection ( string $domain ) : ConnectionResponse | array | Psr\Http\Message\ResponseInterface Returns delivery connection settings for the specified domain.
create ( string $domain, string $smtpPass, string $spamAction, boolean $wildcard ) : CreateResponse | array | Psr\Http\Message\ResponseInterface Creates a new domain for the account.
createCredential ( string $domain, string $login, string $password ) : CreateCredentialResponse | array | Psr\Http\Message\ResponseInterface Create a new SMTP credential pair for the specified domain.
credentials ( string $domain, integer $limit = 100, integer $skip ) : CredentialResponse Returns a list of SMTP credentials for the specified domain.
delete ( string $domain ) : DeleteResponse | array | Psr\Http\Message\ResponseInterface Removes a domain from the account.
deleteCredential ( string $domain, string $login ) : DeleteCredentialResponse | array | Psr\Http\Message\ResponseInterface Remove a set of SMTP credentials from the specified domain.
index ( integer $limit = 100, integer $skip ) : IndexResponse Returns a list of domains on the account.
show ( string $domain ) : ShowResponse | array | Psr\Http\Message\ResponseInterface Returns a single domain.
updateConnection ( string $domain, boolean | null $requireTLS, boolean | null $noVerify ) : UpdateConnectionResponse | array | Psr\Http\Message\ResponseInterface Updates the specified delivery connection settings for the specified domain.
updateCredential ( string $domain, string $login, string $pass ) : UpdateCredentialResponse | array | Psr\Http\Message\ResponseInterface Update a set of SMTP credentials for the specified domain.

Описание методов

connection() публичный Метод

Returns delivery connection settings for the specified domain.
public connection ( string $domain ) : ConnectionResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
Результат Mailgun\Resource\Api\Domain\ConnectionResponse | array | Psr\Http\Message\ResponseInterface

create() публичный Метод

See below for spam filtering parameter information. {@link https://documentation.mailgun.com/user_manual.html#um-spam-filter}.
public create ( string $domain, string $smtpPass, string $spamAction, boolean $wildcard ) : CreateResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
$smtpPass string Password for SMTP authentication.
$spamAction string `disable` or `tag` - inbound spam filtering.
$wildcard boolean Domain will accept email for subdomains.
Результат Mailgun\Resource\Api\Domain\CreateResponse | array | Psr\Http\Message\ResponseInterface

createCredential() публичный Метод

Create a new SMTP credential pair for the specified domain.
public createCredential ( string $domain, string $login, string $password ) : CreateCredentialResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
$login string SMTP Username.
$password string SMTP Password. Length min 5, max 32.
Результат Mailgun\Resource\Api\Domain\CreateCredentialResponse | array | Psr\Http\Message\ResponseInterface

credentials() публичный Метод

Returns a list of SMTP credentials for the specified domain.
public credentials ( string $domain, integer $limit = 100, integer $skip ) : CredentialResponse
$domain string Name of the domain.
$limit integer Number of credentials to return
$skip integer Number of credentials to omit from the list
Результат Mailgun\Resource\Api\Domain\CredentialResponse

delete() публичный Метод

WARNING: This action is irreversible! Be cautious!
public delete ( string $domain ) : DeleteResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
Результат Mailgun\Resource\Api\Domain\DeleteResponse | array | Psr\Http\Message\ResponseInterface

deleteCredential() публичный Метод

Remove a set of SMTP credentials from the specified domain.
public deleteCredential ( string $domain, string $login ) : DeleteCredentialResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
$login string SMTP Username.
Результат Mailgun\Resource\Api\Domain\DeleteCredentialResponse | array | Psr\Http\Message\ResponseInterface

index() публичный Метод

Returns a list of domains on the account.
public index ( integer $limit = 100, integer $skip ) : IndexResponse
$limit integer
$skip integer
Результат Mailgun\Resource\Api\Domain\IndexResponse

show() публичный Метод

Returns a single domain.
public show ( string $domain ) : ShowResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
Результат Mailgun\Resource\Api\Domain\ShowResponse | array | Psr\Http\Message\ResponseInterface

updateConnection() публичный Метод

If a parameter is passed in as null, it will not be updated.
public updateConnection ( string $domain, boolean | null $requireTLS, boolean | null $noVerify ) : UpdateConnectionResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
$requireTLS boolean | null Enforces that messages are sent only over a TLS connection.
$noVerify boolean | null Disables TLS certificate and hostname verification.
Результат Mailgun\Resource\Api\Domain\UpdateConnectionResponse | array | Psr\Http\Message\ResponseInterface

updateCredential() публичный Метод

Update a set of SMTP credentials for the specified domain.
public updateCredential ( string $domain, string $login, string $pass ) : UpdateCredentialResponse | array | Psr\Http\Message\ResponseInterface
$domain string Name of the domain.
$login string SMTP Username.
$pass string New SMTP Password. Length min 5, max 32.
Результат Mailgun\Resource\Api\Domain\UpdateCredentialResponse | array | Psr\Http\Message\ResponseInterface