Represents an IMAP folder. More...

Inherits Object.

Public Member Functions
bool	get_Selectable () const
	Gets a value indicating whether it is possible to select this folder. More...

void	set_Selectable (bool value)
	Gets a value indicating whether it is possible to select this folder. More...

bool	get_Marked () const
	Gets a value indicating whether it is marked this folder. More...

void	set_Marked (bool value)
	Gets a value indicating whether it is marked this folder. More...

bool	get_HasChildren () const
	Gets value indicating whether folder contains subfolders. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 If value is `true`, it indicates that the folder has child sub-folders that are accessible to the currently authenticated user, otherwise false. More...

void	set_HasChildren (bool value)
	Gets value indicating whether folder contains subfolders. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 If value is `true`, it indicates that the folder has child sub-folders that are accessible to the currently authenticated user, otherwise false. More...

ImapSpecialFolderTypes	get_FolderType () const
	Gets information about folder purpose in case if it is used as special folder. This option is accessible only in case if server supports IMAP LIST: Special-Use Mailboxes (rfc6154) See more: http://tools.ietf.org/html/rfc6154 More...

void	set_FolderType (ImapSpecialFolderTypes value)
	Gets information about folder purpose in case if it is used as special folder. This option is accessible only in case if server supports IMAP LIST: Special-Use Mailboxes (rfc6154) See more: http://tools.ietf.org/html/rfc6154 More...

bool	get_Remote () const
	Gets value indicating that a folder is a remote mailbox. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 More...

void	set_Remote (bool value)
	Gets value indicating that a folder is a remote mailbox. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 More...

bool	get_Subscribed () const
	Gets value that indicates that a folder name is subscribed to. See more: http://tools.ietf.org/html/rfc5258 More...

void	set_Subscribed (bool value)
	Gets value that indicates that a folder name is subscribed to. See more: http://tools.ietf.org/html/rfc5258 More...

bool	get_NonExistent () const
	Gets value indicating whether a folder name is referred to an existing folder. See more: http://tools.ietf.org/html/rfc5258 More...

void	set_NonExistent (bool value)
	Gets value indicating whether a folder name is referred to an existing folder. See more: http://tools.ietf.org/html/rfc5258 More...

bool	get_NoInferiors () const
	Gets a value indicating whether this folder can have child levels. If it is `True`, then no child levels exist now and none can be created in the future More...

void	set_NoInferiors (bool value)
	Gets a value indicating whether this folder can have child levels. If it is `True`, then no child levels exist now and none can be created in the future More...

System::String	get_Name () const
	Gets the name of the folder. More...

void	set_Name (System::String value)
	Gets the name of the folder. More...

int32_t	get_NewMessageCount () const
	Gets the number of the new messages. More...

void	set_NewMessageCount (int32_t value)
	Gets the number of the new messages. More...

bool	get_ReadOnly () const
	Gets a value indicating whether the folder is read-only. More...

void	set_ReadOnly (bool value)
	Gets a value indicating whether the folder is read-only. More...

int32_t	get_RecentMessageCount ()
	Gets the number of messages that arrived recently. More...

void	set_RecentMessageCount (int32_t value)
	Gets the number of messages that arrived recently. More...

int32_t	get_TotalMessageCount () const
	Gets the number of messages in the folder. More...

void	set_TotalMessageCount (int32_t value)
	Gets the number of messages in the folder. More...

int64_t	get_ValidityId () const
	Gets the validity ID of the mailbox. More...

void	set_ValidityId (int64_t value)
	Gets the validity ID of the mailbox. More...

bool	get_UidNotSticky () const
	Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315 More...

void	set_UidNotSticky (bool value)
	Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315 More...

bool	get_NoModSeq () const
	Gets value which indicates if mailbox supports mod-sequences. This property works only if server supports CONDSTORE extension. Please, read more https://tools.ietf.org/html/rfc4551#section-3.1.2 More...

void	set_NoModSeq (bool value)
	Gets value which indicates if mailbox supports mod-sequences. This property works only if server supports CONDSTORE extension. Please, read more https://tools.ietf.org/html/rfc4551#section-3.1.2 More...

int64_t	get_HighestModSequence () const
	Gets value of all messages in the mailbox. See more: https://tools.ietf.org/html/rfc7162 More...

void	set_HighestModSequence (int64_t value)
	Gets value of all messages in the mailbox. See more: https://tools.ietf.org/html/rfc7162 More...

int64_t	get_UIDNext () const
	Gets the validity ID of the mailbox. More...

void	set_UIDNext (int64_t value)
	Gets the validity ID of the mailbox. More...

System::String	get_Delimiter () const
	Gets a string that is used to delimit levels of hieararchy under this folder. It usually contains either '/' or '.'. This value is only set for folders returned by a call to GetFolderList methods. For GetFolderInfo method and CurrentFolder property, this will throw an exception More...

void	set_Delimiter (System::String value)
	Gets a string that is used to delimit levels of hieararchy under this folder. It usually contains either '/' or '.'. This value is only set for folders returned by a call to GetFolderList methods. For GetFolderInfo method and CurrentFolder property, this will throw an exception More...

System::SharedPtr< System::Collections::Specialized::StringCollection >	get_Flags () const
	Gets flags that are applicable for this mailbox More...

void	set_Flags (System::SharedPtr< System::Collections::Specialized::StringCollection > value)
	Sets flags that are applicable for this mailbox More...

System::SharedPtr< System::Collections::Specialized::StringCollection >	get_PermanentFlags () const
	Gets message flags which can be changed permanently. NOTE: If this is empty, then all flags can be changed permanently. More...

void	set_PermanentFlags (System::SharedPtr< System::Collections::Specialized::StringCollection > value)
	Sets message flags which can be changed permanently. NOTE: If this is empty, then all flags can be changed permanently. More...

	ImapFolderInfo (System::String folder)
	Initializes a new instance of ImapFolderInfo class More...

	ImapFolderInfo (System::String folder, bool readOnly, bool hasFlags)
	Initializes a new instance of ImapFolderInfo class More...

System::String	ToString () const override
	Returns a string that represents the current object. More...

Static Public Attributes
static const System::String	InBox
	Gets inbox name. More...

Friends
class	Aspose::Email::Clients::Imap::Commands::DeleteCommand

class	Aspose::Email::Clients::Imap::Commands::SelectCommand

class	Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand

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

class	Aspose::Email::Clients::Imap::Commands::StatusCommand

class	Aspose::Email::Clients::Imap::Commands::AppendMessagesGrCommand

class	Aspose::Email::Clients::Imap::Commands::BackupGrCommand

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

class	Aspose::Email::Clients::Imap::Commands::ListFoldersGrCommand

class	Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand

class	Aspose::Email::Clients::Imap::Commands::ListMessagesGrCommand

class	Aspose::Email::Clients::Imap::Commands::MoveFolderGrCommand

class	Aspose::Email::Clients::Imap::Commands::RestoreGrCommand

class	Aspose::Email::Clients::Imap::Commands::SelectFolderGrCommand

class	Aspose::Email::Clients::Imap::ImapConnection

Detailed Description

Represents an IMAP folder.

Constructor & Destructor Documentation

◆ ImapFolderInfo() [1/2]

Aspose::Email::Clients::Imap::ImapFolderInfo::ImapFolderInfo ( System::String folder )

Initializes a new instance of ImapFolderInfo class

Parameters

folder A mailbox folder

◆ ImapFolderInfo() [2/2]

Aspose::Email::Clients::Imap::ImapFolderInfo::ImapFolderInfo	(	System::String	folder,
		bool	readOnly,
		bool	hasFlags
	)

Initializes a new instance of ImapFolderInfo class

Parameters

folder	A mailbox folder
readOnly	A value indicating whether the folder is readonly
hasFlags	Indicates whether the folder has flags

Member Function Documentation

◆ get_Delimiter()

System::String Aspose::Email::Clients::Imap::ImapFolderInfo::get_Delimiter ( ) const

Gets a string that is used to delimit levels of hieararchy under this folder. It usually contains either '/' or '.'. This value is only set for folders returned by a call to GetFolderList methods. For GetFolderInfo method and CurrentFolder property, this will throw an exception

◆ get_Flags()

System::SharedPtr<System::Collections::Specialized::StringCollection> Aspose::Email::Clients::Imap::ImapFolderInfo::get_Flags ( ) const

Gets flags that are applicable for this mailbox

Exceptions

ArgumentNullException value is null

◆ get_FolderType()

ImapSpecialFolderTypes Aspose::Email::Clients::Imap::ImapFolderInfo::get_FolderType ( ) const

Gets information about folder purpose in case if it is used as special folder. This option is accessible only in case if server supports IMAP LIST: Special-Use Mailboxes (rfc6154) See more: http://tools.ietf.org/html/rfc6154

◆ get_HasChildren()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_HasChildren ( ) const

Gets value indicating whether folder contains subfolders. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 If value is true, it indicates that the folder has child sub-folders that are accessible to the currently authenticated user, otherwise false.

◆ get_HighestModSequence()

int64_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_HighestModSequence ( ) const

Gets value of all messages in the mailbox. See more: https://tools.ietf.org/html/rfc7162

◆ get_Marked()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_Marked ( ) const

Gets a value indicating whether it is marked this folder.

◆ get_Name()

System::String Aspose::Email::Clients::Imap::ImapFolderInfo::get_Name ( ) const

Gets the name of the folder.

◆ get_NewMessageCount()

int32_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_NewMessageCount ( ) const

Gets the number of the new messages.

◆ get_NoInferiors()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_NoInferiors ( ) const

Gets a value indicating whether this folder can have child levels. If it is True, then no child levels exist now and none can be created in the future

◆ get_NoModSeq()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_NoModSeq ( ) const

Gets value which indicates if mailbox supports mod-sequences. This property works only if server supports CONDSTORE extension. Please, read more https://tools.ietf.org/html/rfc4551#section-3.1.2

◆ get_NonExistent()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_NonExistent ( ) const

Gets value indicating whether a folder name is referred to an existing folder. See more: http://tools.ietf.org/html/rfc5258

◆ get_PermanentFlags()

System::SharedPtr<System::Collections::Specialized::StringCollection> Aspose::Email::Clients::Imap::ImapFolderInfo::get_PermanentFlags ( ) const

Gets message flags which can be changed permanently. NOTE: If this is empty, then all flags can be changed permanently.

Exceptions

ArgumentNullException value is null

◆ get_ReadOnly()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_ReadOnly ( ) const

Gets a value indicating whether the folder is read-only.

◆ get_RecentMessageCount()

int32_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_RecentMessageCount ( )

Gets the number of messages that arrived recently.

◆ get_Remote()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_Remote ( ) const

Gets value indicating that a folder is a remote mailbox. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258

◆ get_Selectable()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_Selectable ( ) const

Gets a value indicating whether it is possible to select this folder.

◆ get_Subscribed()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_Subscribed ( ) const

Gets value that indicates that a folder name is subscribed to. See more: http://tools.ietf.org/html/rfc5258

◆ get_TotalMessageCount()

int32_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_TotalMessageCount ( ) const

Gets the number of messages in the folder.

◆ get_UIDNext()

int64_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_UIDNext ( ) const

Gets the validity ID of the mailbox.

◆ get_UidNotSticky()

bool Aspose::Email::Clients::Imap::ImapFolderInfo::get_UidNotSticky ( ) const

Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315

◆ get_ValidityId()

int64_t Aspose::Email::Clients::Imap::ImapFolderInfo::get_ValidityId ( ) const

Gets the validity ID of the mailbox.

◆ set_Delimiter()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Delimiter ( System::String value )

Gets a string that is used to delimit levels of hieararchy under this folder. It usually contains either '/' or '.'. This value is only set for folders returned by a call to GetFolderList methods. For GetFolderInfo method and CurrentFolder property, this will throw an exception

◆ set_Flags()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Flags ( System::SharedPtr< System::Collections::Specialized::StringCollection > value )

Sets flags that are applicable for this mailbox

Exceptions

ArgumentNullException value is null

◆ set_FolderType()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_FolderType ( ImapSpecialFolderTypes value )

Gets information about folder purpose in case if it is used as special folder. This option is accessible only in case if server supports IMAP LIST: Special-Use Mailboxes (rfc6154) See more: http://tools.ietf.org/html/rfc6154

◆ set_HasChildren()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_HasChildren ( bool value )

Gets value indicating whether folder contains subfolders. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258 If value is true, it indicates that the folder has child sub-folders that are accessible to the currently authenticated user, otherwise false.

◆ set_HighestModSequence()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_HighestModSequence ( int64_t value )

Gets value of all messages in the mailbox. See more: https://tools.ietf.org/html/rfc7162

◆ set_Marked()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Marked ( bool value )

Gets a value indicating whether it is marked this folder.

◆ set_Name()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Name ( System::String value )

Gets the name of the folder.

◆ set_NewMessageCount()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_NewMessageCount ( int32_t value )

Gets the number of the new messages.

◆ set_NoInferiors()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_NoInferiors ( bool value )

Gets a value indicating whether this folder can have child levels. If it is True, then no child levels exist now and none can be created in the future

◆ set_NoModSeq()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_NoModSeq ( bool value )

Gets value which indicates if mailbox supports mod-sequences. This property works only if server supports CONDSTORE extension. Please, read more https://tools.ietf.org/html/rfc4551#section-3.1.2

◆ set_NonExistent()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_NonExistent ( bool value )

Gets value indicating whether a folder name is referred to an existing folder. See more: http://tools.ietf.org/html/rfc5258

◆ set_PermanentFlags()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_PermanentFlags ( System::SharedPtr< System::Collections::Specialized::StringCollection > value )

Sets message flags which can be changed permanently. NOTE: If this is empty, then all flags can be changed permanently.

Exceptions

ArgumentNullException value is null

◆ set_ReadOnly()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_ReadOnly ( bool value )

Gets a value indicating whether the folder is read-only.

◆ set_RecentMessageCount()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_RecentMessageCount ( int32_t value )

Gets the number of messages that arrived recently.

◆ set_Remote()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Remote ( bool value )

Gets value indicating that a folder is a remote mailbox. This option is accessible only in case if server supports IMAP4 LIST Command Extensions (rfc5258) See more: http://tools.ietf.org/html/rfc5258

◆ set_Selectable()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Selectable ( bool value )

Gets a value indicating whether it is possible to select this folder.

◆ set_Subscribed()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_Subscribed ( bool value )

Gets value that indicates that a folder name is subscribed to. See more: http://tools.ietf.org/html/rfc5258

◆ set_TotalMessageCount()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_TotalMessageCount ( int32_t value )

Gets the number of messages in the folder.

◆ set_UIDNext()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_UIDNext ( int64_t value )

Gets the validity ID of the mailbox.

◆ set_UidNotSticky()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_UidNotSticky ( bool value )

Gets value which indicates if mail store does not support persistent UIDs This property works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315

◆ set_ValidityId()

void Aspose::Email::Clients::Imap::ImapFolderInfo::set_ValidityId ( int64_t value )

Gets the validity ID of the mailbox.

◆ ToString()

System::String Aspose::Email::Clients::Imap::ImapFolderInfo::ToString ( ) const

override

Returns a string that represents the current object.

Returns: A string that represents the current object.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::AppendMessagesGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::BackupGrCommand

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

friend

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

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

friend

◆ Aspose::Email::Clients::Imap::Commands::DeleteCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand

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

friend

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

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

friend

◆ Aspose::Email::Clients::Imap::Commands::ListFoldersGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::ListMessagesGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::MoveFolderGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::RestoreGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::SelectCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::SelectFolderGrCommand

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

friend

◆ Aspose::Email::Clients::Imap::Commands::StatusCommand

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

friend

◆ Aspose::Email::Clients::Imap::ImapConnection

friend class Aspose::Email::Clients::Imap::ImapConnection

friend

Member Data Documentation

◆ InBox

const System::String Aspose::Email::Clients::Imap::ImapFolderInfo::InBox

static

Gets inbox name.

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ImapFolderInfo() [1/2]

◆ ImapFolderInfo() [2/2]

Member Function Documentation

◆ get_Delimiter()

◆ get_Flags()

◆ get_FolderType()

◆ get_HasChildren()

◆ get_HighestModSequence()

◆ get_Marked()

◆ get_Name()

◆ get_NewMessageCount()

◆ get_NoInferiors()

◆ get_NoModSeq()

◆ get_NonExistent()

◆ get_PermanentFlags()

◆ get_ReadOnly()

◆ get_RecentMessageCount()

◆ get_Remote()

◆ get_Selectable()

◆ get_Subscribed()

◆ get_TotalMessageCount()

◆ get_UIDNext()

◆ get_UidNotSticky()

◆ get_ValidityId()

◆ set_Delimiter()

◆ set_Flags()

◆ set_FolderType()

◆ set_HasChildren()

◆ set_HighestModSequence()

◆ set_Marked()

◆ set_Name()

◆ set_NewMessageCount()

◆ set_NoInferiors()

◆ set_NoModSeq()

◆ set_NonExistent()

◆ set_PermanentFlags()

◆ set_ReadOnly()

◆ set_RecentMessageCount()

◆ set_Remote()

◆ set_Selectable()

◆ set_Subscribed()

◆ set_TotalMessageCount()

◆ set_UIDNext()

◆ set_UidNotSticky()

◆ set_ValidityId()

◆ ToString()

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::AppendMessagesGrCommand

◆ Aspose::Email::Clients::Imap::Commands::BackupGrCommand

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

◆ Aspose::Email::Clients::Imap::Commands::DeleteCommand

◆ Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand

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

◆ Aspose::Email::Clients::Imap::Commands::ListFoldersGrCommand

◆ Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand

◆ Aspose::Email::Clients::Imap::Commands::ListMessagesGrCommand

◆ Aspose::Email::Clients::Imap::Commands::MoveFolderGrCommand

◆ Aspose::Email::Clients::Imap::Commands::RestoreGrCommand

◆ Aspose::Email::Clients::Imap::Commands::SelectCommand

◆ Aspose::Email::Clients::Imap::Commands::SelectFolderGrCommand

◆ Aspose::Email::Clients::Imap::Commands::StatusCommand

◆ Aspose::Email::Clients::Imap::ImapConnection

Member Data Documentation

◆ InBox