AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiMailAttachment
  • CApiMailAttachmentCollection
  • CApiMailFolder
  • CApiMailFolderCollection
  • CApiMailIcs
  • CApiMailMessage
  • CApiMailMessageCollection
  • CApiMailVcard

Class CApiMailMessageCollection

CApiMailMessageCollection is used for work with mail messages.

MailSo\Base\Collection
Extended by CApiMailMessageCollection
Package: Mail\Classes
Located at mail/classes/message-collection.php

Methods summary

protected
# __construct( )

Initializes collection properties.

Initializes collection properties.

public CApiMailMessageCollection
# clear( )

Removes all messages from the collection.

Removes all messages from the collection.

Returns

CApiMailMessageCollection
public static CApiMailMessageCollection
# createInstance( )

Creates new instance of the object.

Creates new instance of the object.

Returns

CApiMailMessageCollection

Properties summary

public integer $MessageCount

Number of messages in the folder.

Number of messages in the folder.

#
public integer $MessageUnseenCount

Number of unread mails in the folder.

Number of unread mails in the folder.

#
public integer $MessageResultCount

Number of messages returned upon running search.

Number of messages returned upon running search.

#
public string $FolderName

Full name of the folder.

Full name of the folder.

#
public integer $Offset

Along with Limit, denotes a range of message list to retrieve.

Along with Limit, denotes a range of message list to retrieve.

#
public integer $Limit

Along with Offset, denotes a range of message list to retrieve.

Along with Offset, denotes a range of message list to retrieve.

#
public string $Search

Denotes search string.

Denotes search string.

#
public string $Filters

Denotes message lookup type. Typical use case is search in Starred folder.

Denotes message lookup type. Typical use case is search in Starred folder.

#
public array $Uids

List of message UIDs.

List of message UIDs.

#
public string $UidNext

UIDNEXT value for the current folder.

UIDNEXT value for the current folder.

#
public string $FolderHash

Value which changes if any folder parameter, such as message count, was changed.

Value which changes if any folder parameter, such as message count, was changed.

#
public array $New

List of information about new messages. $UidNext is used for obtaining this information.

List of information about new messages. $UidNext is used for obtaining this information.

#
AfterLogic API Documentation API documentation generated by ApiGen