Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElIMAPClient.StatusBox

TElIMAPClient     See also     

Filter: C#  VB.NET  Pascal  C++  PHP  Java  

Requests the status of the specified mailbox.

Declaration

[C#]
    TElIMAPMailBoxState StatusBox(string MailBox, TSBIMAPStatusItems Items);

[VB.NET]
    Function StatusBox(ByVal MailBox As String, ByVal Items As TSBIMAPStatusItems) As TElIMAPMailBoxState

[Pascal]
    function StatusBox(MailBox : TWideString; Items : TSBIMAPStatusItems) : TElIMAPMailBoxState;

[C++]
    TElIMAPMailBoxStateHandle StatusBox(const sb_u16string &MailBox, TSBIMAPStatusItems Items);
    TElIMAPMailBoxStateHandle StatusBox(const std::wstring &MailBox, TSBIMAPStatusItems Items);

[PHP]
    TElIMAPMailBoxState StatusBox(string $MailBox, integer $Items)

[Java]
    TElIMAPMailBoxState statusBox(String MailBox, TSBIMAPStatusItems Items);

Parameters

  • MailBox - the name of the mailbox.
  • Items - the list of status items to check.

TSBIMAPStatusItems values

[.NET][C++] [Pascal] [PHP] Description
f_imapStatusMessages = 1 imapStatusMessages imapStatusMessages = 1 The number of messages in the mailbox.
f_imapStatusUnseen = 2 imapStatusUnseen imapStatusUnseen = 2 The number of messages without the "\Seen" flag.
f_imapStatusRecent = 4 imapStatusRecent imapStatusRecent = 4 The number of messages with the "\Recent" flag.
f_imapStatusUidNext = 8 imapStatusUidNext imapStatusUidNext = 8 The next unique identifier value of the mailbox.
f_imapStatusUidValidity = 16 imapStatusUidValidity imapStatusUidValidity = 16 The unique identifier validity value of the mailbox.

Return value

    Returns current mailbox status.

Description

    Use this method to inspect a mailbox without selecting it.

See also:     CloseBox     ExamineBox     SelectBox    

Discuss this help topic in SecureBlackbox Forum

Copyright (c) 2018, /n software, inc.