Class MailSo\Imap\ImapClient

`extends`	`NetClient`


					
	public
					static

NewInstance(): ImapClient

#


					
	public

GetLogginedUser(): string

#


					
	public

Connect(
	string $sServerName,
	int $iPort = 143,
	int $iSecurityType = ConnectionSecurityType::AUTO_DETECT,
	bool $bVerifySsl = false,
): ImapClient

Parameters

`$iPort`	= 143
`$iSecurityType`	= \MailSo\Net\Enumerations\ConnectionSecurityType::AUTO_DETECT
`$bVerifySsl`	= false

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

Overrides

MailSo\Net\NetClient::Connect()

#


					
	public

Login(
	string $sLogin,
	string $sPassword,
	string $sProxyAuthUser = '',
	bool $bUseAuthPlainIfSupported = false,
): ImapClient

Parameters

`$sProxyAuthUser`	= ''
`$bUseAuthPlainIfSupported`	= false

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public
					static

GetXOAuthKeyStatic($sEmail, $sAccessToken)

#


					
	public

LoginWithXOauth2(string $sXOAuth2Token): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

Logout(): ImapClient

Throws

MailSo\Net\Exceptions\Exception

Overrides

MailSo\Net\NetClient::Logout()

#


					
	public

ForceCloseConnection(): ImapClient

#


					
	public

IsLoggined(): bool

#


					
	public

IsSelected(): bool

#


					
	public

Capability(): array|null

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

IsSupported(string $sExtentionName): bool

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

GetNamespace(): NamespaceResult|null

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

Noop(): ImapClient

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderCreate(string $sFolderName): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderDelete(string $sFolderName): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderSubscribe(string $sFolderName): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderUnSubscribe(string $sFolderName): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderRename(string $sOldFolderName, string $sNewFolderName): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderStatus(string $sFolderName, array $aStatusItems): array|bool

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderList(string $sParentFolderName = '', string $sListPattern = '*'): array

Parameters

`$sParentFolderName`	= ''
`$sListPattern`	= '*'

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderSubscribeList(string $sParentFolderName = '', string $sListPattern = '*'): array

Parameters

`$sParentFolderName`	= ''
`$sListPattern`	= '*'

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderStatusList(string $sParentFolderName = '', string $sListPattern = '*'): array

Parameters

`$sParentFolderName`	= ''
`$sListPattern`	= '*'

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderSelect(string $sFolderName, bool $bReSelectSameFolders = false): ImapClient

Parameters

$bReSelectSameFolders

= false

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderExamine(string $sFolderName, bool $bReSelectSameFolders = false): ImapClient

Parameters

$bReSelectSameFolders

= false

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

Fetch(array $aInputFetchItems, string $sIndexRange, bool $bIndexIsUid): array

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

Quota(): array|false

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageSimpleSort(array $aSortTypes, string $sSearchCriterias = 'ALL', bool $bReturnUid = true): array

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageSimpleESearch(
	string $sSearchCriterias = 'ALL',
	array $aSearchReturn = null,
	bool $bReturnUid = true,
	string $sLimit = '',
	string $sCharset = '',
): array

Parameters

`$sSearchCriterias`	= 'ALL'
`$aSearchReturn`	= null
`$bReturnUid`	= true
`$sLimit`	= ''
`$sCharset`	= ''

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageSimpleESort(
	array $aSortTypes,
	string $sSearchCriterias = 'ALL',
	array $aSearchReturn = null,
	bool $bReturnUid = true,
	string $sLimit = '',
): array

Parameters

`$sSearchCriterias`	= 'ALL'
`$aSearchReturn`	= null
`$bReturnUid`	= true
`$sLimit`	= ''

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageSimpleSearch(string $sSearchCriterias = 'ALL', bool $bReturnUid = true, string $sCharset = ''): array

Parameters

`$bReturnUid`	= true
`$sCharset`	= ''

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageSimpleThread(string $sSearchCriterias = 'ALL', bool $bReturnUid = true, string $sCharset = Charset::UTF_8): array

Parameters

`$sSearchCriterias`	= 'ALL'
`$bReturnUid`	= true
`$sCharset`	= \MailSo\Base\Enumerations\Charset::UTF_8

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageCopy(string $sToFolder, string $sIndexRange, bool $bIndexIsUid): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageMove(string $sToFolder, string $sIndexRange, bool $bIndexIsUid): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageExpunge(string $sUidRangeIfSupported = '', bool $bForceUidExpunge = false, bool $bExpungeAll = false): ImapClient

Parameters

`$sUidRangeIfSupported`	= ''
`$bForceUidExpunge`	= false
`$bExpungeAll`	= false

Throws

`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageStoreFlag(string $sIndexRange, bool $bIndexIsUid, array $aInputStoreItems, string $sStoreAction): ImapClient

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

MessageAppendFile(
	string $sMessageFileName,
	string $sFolderToSave,
	array $aAppendFlags = null,
	int &$iUid = null,
): MailClient

Parameters

`$aAppendFlags`	= null
`$iUid`	= null

#


					
	public

MessageAppendStream(
	string $sFolderName,
	resource $rMessageAppendStream,
	int $iStreamSize,
	array $aAppendFlags = null,
	int &$iUid = null,
	int $sDateTime = 0,
): ImapClient

Parameters

`$aAppendFlags`	= null
`$iUid`	= null
`$sDateTime`	= 0

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

FolderCurrentInformation(): FolderInformation

#


					
	public

SendRequest(string $sCommand, array $aParams = []): void

Parameters

$aParams

= array()

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`

#


					
	public

SendRequestWithCheck(string $sCommand, array $aParams = [], bool $bFindCapa = false): ImapClient

Parameters

`$aParams`	= array()
`$bFindCapa`	= false

Throws

`MailSo\Base\Exceptions\InvalidArgumentException`
`MailSo\Net\Exceptions\Exception`
`MailSo\Imap\Exceptions\Exception`

#


					
	public

GetLastResponse(): array

#


					
	public

EscapeString(string $sStringForEscape): string

#


					
	public

SetLogger(Logger $oLogger): ImapClient

Throws

MailSo\Base\Exceptions\InvalidArgumentException

Overrides

MailSo\Net\NetClient::SetLogger()

#


					
	public

TestSetValues(resource $rConnect, array $aCapabilityItems = []): ImapClient

Parameters

$aCapabilityItems

= array()

#


					
	public

TestParseResponseWithValidationProxy(string $sEndTag = null, string $bFindCapa = false): array

Parameters

`$sEndTag`	= null
`$bFindCapa`	= false

#

Namespaces

Classes

Parameters

Throws

Overrides

Parameters

Throws

Throws

Throws

Overrides

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Throws

Throws

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Throws

Throws

Parameters

Throws

Throws

Parameters

Parameters

Throws

Parameters

Throws

Parameters

Throws

Throws

Overrides

Parameters

Parameters