Documentation

PlainAuthenticator
in package
implements AuthInterface

PLAIN Auth class

Tags
category

Pop

author

Chris Corbyn, from the SwiftMailer library https://github.com/swiftmailer/swiftmailer

version
3.6.0

Interfaces, Classes and Traits

AuthInterface
SMTP authenticator interface

Table of Contents

authenticate()  : bool
Try to authenticate the user with $username and $password
getAuthKeyword()  : string
Get the name of the AUTH mechanism this Authenticator handles

Methods

authenticate()

Try to authenticate the user with $username and $password

public authenticate(AgentInterface $agent, string $username, string $password) : bool
Parameters
$agent : AgentInterface
$username : string
$password : string
Return values
bool

getAuthKeyword()

Get the name of the AUTH mechanism this Authenticator handles

public getAuthKeyword() : string
Return values
string

Search results