| Methods |
public
static
|
NewInstance(): MailClient
|
#
|
public
|
ImapClient(): ImapClient
|
#
|
public
|
Connect(
string $sServerName,
int $iPort = 143,
int $iSecurityType = ConnectionSecurityType::AUTO_DETECT,
bool $bVerifySsl = false,
): MailClient
Parameters
| $iPort |
= 143
|
| $iSecurityType |
= \MailSo\Net\Enumerations\ConnectionSecurityType::AUTO_DETECT
|
| $bVerifySsl |
= false
|
Throws
|
#
|
public
|
Login(
string $sLogin,
string $sPassword,
string $sProxyAuthUser = '',
bool $bUseAuthPlainIfSupported = false,
): MailClient
Parameters
| $sProxyAuthUser |
= ''
|
| $bUseAuthPlainIfSupported |
= false
|
Throws
|
#
|
public
|
LoginWithXOauth2(string $sXOAuth2Token): MailClient
|
#
|
public
|
Logout(): MailClient
|
#
|
public
|
Disconnect(): MailClient
|
#
|
public
|
LogoutAndDisconnect(): MailClient
|
#
|
public
|
IsConnected(): bool
|
#
|
public
|
IsLoggined(): bool
|
#
|
public
|
MessageSetFlagToAll(string $sFolderName, string $sMessageFlag, bool $bSetAction = true)
|
#
|
public
|
MessageSetFlag(
string $sFolderName,
array $aIndexRange,
bool $bIndexIsUid,
string $sMessageFlag,
bool $bSetAction = true,
bool $sSkipUnsupportedFlag = false,
)
Parameters
| $bSetAction |
= true
|
| $sSkipUnsupportedFlag |
= false
|
Throws
|
#
|
public
|
MessageSetFlagged(string $sFolderName, array $aIndexRange, bool $bIndexIsUid, bool $bSetAction = true)
|
#
|
public
|
MessageSetSeenToAll(string $sFolderName, bool $bSetAction = true)
|
#
|
public
|
MessageSetSeen(string $sFolderName, array $aIndexRange, bool $bIndexIsUid, bool $bSetAction = true)
|
#
|
public
|
Message(
string $sFolderName,
int $iIndex,
bool $bIndexIsUid = true,
CacheClient $oCacher = null,
int $iBodyTextLimit = null,
): Message|false
Parameters
| $bIndexIsUid |
= true
|
| $oCacher |
= null
|
| $iBodyTextLimit |
= null
|
Throws
|
#
|
public
|
MessageMimeStream(
mixed $mCallback,
string $sFolderName,
int $iIndex,
bool $bIndexIsUid = true,
string $sMimeIndex = '',
): bool
Parameters
| $bIndexIsUid |
= true,
|
| $sMimeIndex |
= ''
|
Throws
|
#
|
public
|
MessageDelete(
string $sFolder,
array $aIndexRange,
bool $bIndexIsUid,
bool $bUseExpunge = true,
bool $bExpungeAll = false,
): MailClient
Parameters
| $bUseExpunge |
= true
|
| $bExpungeAll |
= false
|
Throws
|
#
|
public
|
MessageMove(
string $sFromFolder,
string $sToFolder,
array $aIndexRange,
bool $bIndexIsUid,
bool $bUseMoveSupported = false,
bool $bExpungeAll = false,
): MailClient
Parameters
| $bUseMoveSupported |
= false
|
| $bExpungeAll |
= false
|
Throws
|
#
|
public
|
MessageCopy(string $sFromFolder, string $sToFolder, array $aIndexRange, bool $bIndexIsUid): MailClient
|
#
|
public
|
MessageAppendStream(
resource $rMessageStream,
int $iMessageStreamSize,
string $sFolderToSave,
array $aAppendFlags = null,
int &$iUid = null,
): MailClient
Parameters
| $aAppendFlags |
= null
|
| $iUid |
= null
|
|
#
|
public
|
MessageAppendFile(
string $sMessageFileName,
string $sFolderToSave,
array $aAppendFlags = null,
int &$iUid = null,
): MailClient
Parameters
| $aAppendFlags |
= null
|
| $iUid |
= null
|
|
#
|
public
static
|
GenerateHash(string $sFolder, int $iCount, int $iUnseenCount, string $sUidNext): string
|
#
|
public
|
FolderInformation(string $sFolderName, string $sPrevUidNext = '', array $aUids = []): string
Parameters
| $sPrevUidNext |
= ''
|
| $aUids |
= ''
|
Throws
|
#
|
public
|
FolderHash(string $sFolderName): string
|
#
|
public
|
IsGmail(): string
|
#
|
public
|
MessageListThreadsMap(
string $sFolderName,
string $sFolderHash,
array $aIndexOrUids,
CacheClient $oCacher,
int $iThreadLimit = 100,
): array
|
#
|
public
|
MessageListByRequestIndexOrUids(MessageCollection &$oMessageCollection, array $aRequestIndexOrUids, bool $bIndexAsUid)
|
#
|
public
|
IsThreadsSupported(): bool
|
#
|
public
|
MessageList(
string $sFolderName,
int $iOffset = 0,
int $iLimit = 10,
string $sSearch = '',
string $sPrevUidNext = '',
CacheClient|null $oCacher = null,
bool $bUseSortIfSupported = false,
bool $bUseThreadSortIfSupported = false,
array $aExpandedThreadsUids = [],
bool $bUseESearchOrESortRequest = false,
): MessageCollection
Parameters
| $iOffset |
= 0
|
| $iLimit |
= 10
|
| $sSearch |
= ''
|
| $sPrevUidNext |
= ''
|
| $oCacher |
= null
|
| $bUseSortIfSupported |
= false
|
| $bUseThreadSortIfSupported |
= false
|
| $aExpandedThreadsUids |
= array()
|
| $bUseESearchOrESortRequest |
= false
|
Throws
|
#
|
public
|
Quota(): array|false
|
#
|
public
|
FindMessageUidByMessageId(string $sFolderName, string $sMessageId): int|null
|
#
|
public
|
Folders(string $sParent = '', string $sListPattern = '*', bool $bUseListSubscribeStatus = true): FolderCollection|false
Parameters
| $sParent |
= ''
|
| $sListPattern |
= '*'
|
| $bUseListSubscribeStatus |
= false
|
|
#
|
public
|
FolderCreate(
string $sFolderNameInUtf,
string $sFolderParentFullNameRaw = '',
bool $bSubscribeOnCreation = true,
): MailClient
Parameters
| $sFolderParentFullNameRaw |
= ''
|
| $bSubscribeOnCreation |
= true
|
Throws
|
#
|
public
|
FolderMove(string $sPrevFolderFullNameRaw, string $sNextFolderFullNameInUtf, $bSubscribeOnRename = true): MailClient
|
#
|
public
|
FolderRename(
string $sPrevFolderFullNameRaw,
string $sNewTopFolderNameInUtf,
bool $bSubscribeOnRename = true,
): MailClient
Parameters
| $bSubscribeOnRename |
= true
|
Throws
|
#
|
public
|
folderModify(
string $sPrevFolderFullNameRaw,
string $sNextFolderNameInUtf,
bool $bRenameOrMove,
bool $bSubscribeOnModify,
): MailClient
|
#
|
public
|
FolderDelete(string $sFolderFullNameRaw, bool $bUnsubscribeOnDeletion = true): MailClient
Parameters
| $bUnsubscribeOnDeletion |
= true
|
Throws
|
#
|
public
|
FolderClear(string $sFolderFullNameRaw): MailClient
|
#
|
public
|
FolderSubscribe(string $sFolderFullNameRaw, bool $bSubscribe): MailClient
|
#
|
public
|
SetLogger(Logger $oLogger): MailClient
|
#
|