Aspose::Email::Clients::Imap::ImapMessageFlags Class Reference

Represents the flags associated with the message. More...

Inherits IEquatable< System::SharedPtr< Aspose::Email::Clients::Imap::ImapMessageFlags > >.

Public Member Functions

 ImapMessageFlags (System::String value)
 
bool IsEmpty ()
 Determines whether this instance is empty. More...
 
System::ArrayPtr< System::SharedPtr< ImapMessageFlags > > Split ()
 Split to Array. More...
 
int32_t GetHashCode () const override
 Returns a hash code for this instance. More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Determines whether the specified System::Object is equal to this instance. More...
 
bool HasFlag (System::SharedPtr< ImapMessageFlags > what)
 Returns true if "who" contains the "flag" More...
 
bool Equals (System::SharedPtr< ImapMessageFlags > other) override
 Determines whether the specified object is equal to the current object. More...
 
System::String ToCommandString ()
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< ImapMessageFlags > > > GetPredefinedValues ()
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< ImapMessageFlags > > > GetCustomValues ()
 
System::String ToString () const override
 Returns a System::String that represents this instance. More...
 

Static Public Member Functions

static System::SharedPtr< ImapMessageFlagsget_Answered ()
 Message has been answered. More...
 
static System::SharedPtr< ImapMessageFlagsget_Deleted ()
 Message is "deleted" for removal by later EXPUNGE. More...
 
static System::SharedPtr< ImapMessageFlagsget_Draft ()
 Message has been marked as a draft. More...
 
static System::SharedPtr< ImapMessageFlagsget_Flagged ()
 Message is "flagged" for urgent/special attention. More...
 
static System::SharedPtr< ImapMessageFlagsget_Recent ()
 Message is "recently" arrived in this mailbox. More...
 
static System::SharedPtr< ImapMessageFlagsget_IsRead ()
 Message has been read. More...
 
static System::SharedPtr< ImapMessageFlagsget_Empty ()
 Flags are not set More...
 
static System::SharedPtr< ImapMessageFlagsKeyword (System::String flag)
 Message has been marked by custom flag. More...
 
static System::SharedPtr< ImapMessageFlagsto_ImapMessageFlags (System::String type)
 
static System::SharedPtr< ImapMessageFlagsBitwiseOr (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 Implements the operator |. More...
 
static System::SharedPtr< ImapMessageFlagsBitwiseOr (System::SharedPtr< ImapMessageFlags > a, System::String b)
 Implements the operator |. More...
 
static System::SharedPtr< ImapMessageFlagsBitwiseOr (System::String a, System::SharedPtr< ImapMessageFlags > b)
 Implements the operator |. More...
 
static System::SharedPtr< ImapMessageFlagsBitwiseAnd (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 Implements the operator &. More...
 

Friends

class Aspose::Email::Clients::Imap::Commands::AppendCommand
 
class Aspose::Email::Clients::Imap::Commands::StoreCommand
 
class Aspose::Email::Clients::Imap::Commands::UidStoreCommand
 
class Aspose::Email::Clients::Imap::ImapQueryBuilder
 
System::SharedPtr< ImapMessageFlagsoperator| (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 
System::SharedPtr< ImapMessageFlagsoperator| (System::SharedPtr< ImapMessageFlags > a, System::String b)
 
System::SharedPtr< ImapMessageFlagsoperator| (System::String a, System::SharedPtr< ImapMessageFlags > b)
 
System::SharedPtr< ImapMessageFlagsoperator& (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 
bool operator!= (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 
bool operator== (System::SharedPtr< ImapMessageFlags > a, System::SharedPtr< ImapMessageFlags > b)
 

Detailed Description

Represents the flags associated with the message.

Constructor & Destructor Documentation

◆ ImapMessageFlags()

Aspose::Email::Clients::Imap::ImapMessageFlags::ImapMessageFlags ( System::String  value)

Member Function Documentation

◆ BitwiseAnd()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::BitwiseAnd ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
static

Implements the operator &.

Parameters
aFirst set of imap message flags.
bSecond set of imap message flags.
Returns
The result of the operator.

◆ BitwiseOr() [1/3]

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::BitwiseOr ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
static

Implements the operator |.

Parameters
aFirst set of imap message flags.
bSecond set of imap message flags.
Returns
The result of the operator.

◆ BitwiseOr() [2/3]

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::BitwiseOr ( System::SharedPtr< ImapMessageFlags a,
System::String  b 
)
static

Implements the operator |.

Parameters
aFirst set of imap message flags.
bSecond set of imap message flags.
Returns
The result of the operator.

◆ BitwiseOr() [3/3]

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::BitwiseOr ( System::String  a,
System::SharedPtr< ImapMessageFlags b 
)
static

Implements the operator |.

Parameters
aFirst set of imap message flags.
bSecond set of imap message flags.
Returns
The result of the operator.

◆ Equals() [1/2]

bool Aspose::Email::Clients::Imap::ImapMessageFlags::Equals ( System::SharedPtr< ImapMessageFlags other)
override

Determines whether the specified object is equal to the current object.

Parameters
otherThe object to compare with the current object.
Returns
true if the specified object is equal to the current object; otherwise, false.

◆ Equals() [2/2]

bool Aspose::Email::Clients::Imap::ImapMessageFlags::Equals ( System::SharedPtr< System::Object >  obj)
override

Determines whether the specified System::Object is equal to this instance.

Parameters
objThe System::Object to compare with this instance.
Returns
true if the specified System::Object is equal to this instance; otherwise, false.
Exceptions
T:System::NullReferenceExceptionThe obj parameter is null.

◆ get_Answered()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Answered ( )
static

Message has been answered.

◆ get_Deleted()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Deleted ( )
static

Message is "deleted" for removal by later EXPUNGE.

◆ get_Draft()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Draft ( )
static

Message has been marked as a draft.

◆ get_Empty()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Empty ( )
static

Flags are not set

◆ get_Flagged()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Flagged ( )
static

Message is "flagged" for urgent/special attention.

◆ get_IsRead()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_IsRead ( )
static

Message has been read.

◆ get_Recent()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::get_Recent ( )
static

Message is "recently" arrived in this mailbox.

◆ GetCustomValues()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<ImapMessageFlags> > > Aspose::Email::Clients::Imap::ImapMessageFlags::GetCustomValues ( )

◆ GetHashCode()

int32_t Aspose::Email::Clients::Imap::ImapMessageFlags::GetHashCode ( ) const
override

Returns a hash code for this instance.

Returns
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

◆ GetPredefinedValues()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<ImapMessageFlags> > > Aspose::Email::Clients::Imap::ImapMessageFlags::GetPredefinedValues ( )

◆ HasFlag()

bool Aspose::Email::Clients::Imap::ImapMessageFlags::HasFlag ( System::SharedPtr< ImapMessageFlags what)

Returns true if "who" contains the "flag"

Parameters
whatImap message flags
Returns

◆ IsEmpty()

bool Aspose::Email::Clients::Imap::ImapMessageFlags::IsEmpty ( )

Determines whether this instance is empty.

Returns
true if this instance is empty; otherwise, false.

◆ Keyword()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::Keyword ( System::String  flag)
static

Message has been marked by custom flag.

◆ Split()

System::ArrayPtr<System::SharedPtr<ImapMessageFlags> > Aspose::Email::Clients::Imap::ImapMessageFlags::Split ( )

Split to Array.

◆ to_ImapMessageFlags()

static System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageFlags::to_ImapMessageFlags ( System::String  type)
static

◆ ToCommandString()

System::String Aspose::Email::Clients::Imap::ImapMessageFlags::ToCommandString ( )

◆ ToString()

System::String Aspose::Email::Clients::Imap::ImapMessageFlags::ToString ( ) const
override

Returns a System::String that represents this instance.

Returns
A System::String that represents this instance.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::AppendCommand

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

◆ Aspose::Email::Clients::Imap::Commands::StoreCommand

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

◆ Aspose::Email::Clients::Imap::Commands::UidStoreCommand

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

◆ Aspose::Email::Clients::Imap::ImapQueryBuilder

◆ operator!=

bool operator!= ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
friend

◆ operator&

System::SharedPtr<ImapMessageFlags> operator& ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
friend

◆ operator==

bool operator== ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
friend

◆ operator| [1/3]

System::SharedPtr<ImapMessageFlags> operator| ( System::SharedPtr< ImapMessageFlags a,
System::SharedPtr< ImapMessageFlags b 
)
friend

◆ operator| [2/3]

System::SharedPtr<ImapMessageFlags> operator| ( System::SharedPtr< ImapMessageFlags a,
System::String  b 
)
friend

◆ operator| [3/3]

System::SharedPtr<ImapMessageFlags> operator| ( System::String  a,
System::SharedPtr< ImapMessageFlags b 
)
friend