API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\Mail\Transport\Smtp\AuthPlainAuthenticator

PLAIN Auth class

Summary

Methods
Properties
Constants
getAuthKeyword()
authenticate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getAuthKeyword()

getAuthKeyword() : string

Get the name of the AUTH mechanism this Authenticator handles

Returns

string

authenticate()

authenticate(\Pop\Mail\Transport\Smtp\AgentInterface  $agent, string  $username, string  $password) : boolean

Try to authenticate the user with $username and $password

Parameters

\Pop\Mail\Transport\Smtp\AgentInterface $agent
string $username
string $password

Returns

boolean