Aspose::Email::Clients::Imap::ImapMailboxInfo Class Reference

Contains set of special-use mailboxes More...

Inherits Object.

Public Member Functions

System::SharedPtr< ImapFolderInfoget_AllMessages () const
 Gets mailbox presents all messages in the user's message store. Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_AllMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox presents all messages in the user's message store. Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_ArchivedMessages () const
 Gets mailbox is used to archive messages.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_ArchivedMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to archive messages.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_DraftMessages () const
 Gets mailbox is used to hold draft messages typically, messages that are being composed but have not yet been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_DraftMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to hold draft messages typically, messages that are being composed but have not yet been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_FlaggedMessages () const
 Gets mailbox presents all messages marked in some way as "important".
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_FlaggedMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox presents all messages marked in some way as "important".
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_JunkMessages () const
 Gets mailbox is where messages deemed to be junk mail are held. Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_JunkMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is where messages deemed to be junk mail are held. Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_SentMessages () const
 Gets mailbox is used to hold copies of messages that have been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_SentMessages (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to hold copies of messages that have been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_Trash () const
 Gets mailbox is used to hold messages that have been deleted or marked for deletion.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
void set_Trash (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to hold messages that have been deleted or marked for deletion.
Please note, this value may be null if server does not support rfc6154 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_Important () const
 Gets mailbox is used to hold messages that have been marked as important. Please note, this value may be null if server does not support rfc8457 or folder has not been created. More...
 
void set_Important (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to hold messages that have been marked as important. Please note, this value may be null if server does not support rfc8457 or folder has not been created. More...
 
System::SharedPtr< ImapFolderInfoget_Inbox () const
 Gets mailbox is used to hold incoming messages. More...
 
void set_Inbox (System::SharedPtr< ImapFolderInfo > value)
 Gets mailbox is used to hold incoming messages. More...
 
 ImapMailboxInfo (System::SharedPtr< ImapFolderInfo > allMessages, System::SharedPtr< ImapFolderInfo > archivedMessages, System::SharedPtr< ImapFolderInfo > draftMessages, System::SharedPtr< ImapFolderInfo > flaggedMessages, System::SharedPtr< ImapFolderInfo > junkMessages, System::SharedPtr< ImapFolderInfo > sentMessages, System::SharedPtr< ImapFolderInfo > trash, System::SharedPtr< ImapFolderInfo > important, System::SharedPtr< ImapFolderInfo > inbox)
 Initializes a new instance of ImapMailboxInfo class More...
 
System::ArrayPtr< System::SharedPtr< ImapFolderInfo > > ToArray ()
 Gets array of existed well-known folders. If well-known folder is null, it won't be included in array. More...
 

Friends

class Aspose::Email::Clients::Imap::Commands::ListCommand
 
class Aspose::Email::Clients::Imap::Commands::ConnectGrCommand
 

Detailed Description

Contains set of special-use mailboxes

Constructor & Destructor Documentation

◆ ImapMailboxInfo()

Aspose::Email::Clients::Imap::ImapMailboxInfo::ImapMailboxInfo ( System::SharedPtr< ImapFolderInfo allMessages,
System::SharedPtr< ImapFolderInfo archivedMessages,
System::SharedPtr< ImapFolderInfo draftMessages,
System::SharedPtr< ImapFolderInfo flaggedMessages,
System::SharedPtr< ImapFolderInfo junkMessages,
System::SharedPtr< ImapFolderInfo sentMessages,
System::SharedPtr< ImapFolderInfo trash,
System::SharedPtr< ImapFolderInfo important,
System::SharedPtr< ImapFolderInfo inbox 
)

Initializes a new instance of ImapMailboxInfo class

Parameters
allMessagesThis mailbox presents all messages in the user's message store.
archivedMessagesThis mailbox is used to archive messages.
draftMessagesThis mailbox is used to hold draft messages typically, messages that are being composed but have not yet been sent.
flaggedMessagesThis mailbox presents all messages marked in some way as "important".
junkMessagesThis mailbox is where messages deemed to be junk mail are held.
sentMessagesThis mailbox is used to hold copies of messages that have been sent.
trashThis mailbox is used to hold messages that have been deleted or marked for deletion.
importantThis mailbox is used to hold messages that have been marked as important.
inboxThis mailbox is used to hold incoming messages.

Member Function Documentation

◆ get_AllMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_AllMessages ( ) const

Gets mailbox presents all messages in the user's message store. Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_ArchivedMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_ArchivedMessages ( ) const

Gets mailbox is used to archive messages.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_DraftMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_DraftMessages ( ) const

Gets mailbox is used to hold draft messages typically, messages that are being composed but have not yet been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_FlaggedMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_FlaggedMessages ( ) const

Gets mailbox presents all messages marked in some way as "important".
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_Important()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_Important ( ) const

Gets mailbox is used to hold messages that have been marked as important. Please note, this value may be null if server does not support rfc8457 or folder has not been created.

◆ get_Inbox()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_Inbox ( ) const

Gets mailbox is used to hold incoming messages.

◆ get_JunkMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_JunkMessages ( ) const

Gets mailbox is where messages deemed to be junk mail are held. Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_SentMessages()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_SentMessages ( ) const

Gets mailbox is used to hold copies of messages that have been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ get_Trash()

System::SharedPtr<ImapFolderInfo> Aspose::Email::Clients::Imap::ImapMailboxInfo::get_Trash ( ) const

Gets mailbox is used to hold messages that have been deleted or marked for deletion.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_AllMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_AllMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox presents all messages in the user's message store. Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_ArchivedMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_ArchivedMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to archive messages.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_DraftMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_DraftMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to hold draft messages typically, messages that are being composed but have not yet been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_FlaggedMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_FlaggedMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox presents all messages marked in some way as "important".
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_Important()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_Important ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to hold messages that have been marked as important. Please note, this value may be null if server does not support rfc8457 or folder has not been created.

◆ set_Inbox()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_Inbox ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to hold incoming messages.

◆ set_JunkMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_JunkMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is where messages deemed to be junk mail are held. Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_SentMessages()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_SentMessages ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to hold copies of messages that have been sent.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ set_Trash()

void Aspose::Email::Clients::Imap::ImapMailboxInfo::set_Trash ( System::SharedPtr< ImapFolderInfo value)

Gets mailbox is used to hold messages that have been deleted or marked for deletion.
Please note, this value may be null if server does not support rfc6154 or folder has not been created.

◆ ToArray()

System::ArrayPtr<System::SharedPtr<ImapFolderInfo> > Aspose::Email::Clients::Imap::ImapMailboxInfo::ToArray ( )

Gets array of existed well-known folders. If well-known folder is null, it won't be included in array.

Returns
Array of ImapFolderInfo objects

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::ConnectGrCommand

friend class Aspose::Email::Clients::Imap::Commands::ConnectGrCommand
friend

◆ Aspose::Email::Clients::Imap::Commands::ListCommand

friend class Aspose::Email::Clients::Imap::Commands::ListCommand
friend