Flag Class

Represents flag used by IMAP protocol to mark email messages. Static fields represent most common, system flags. You can use FlagMessageByNumber(Int64, Flag) and UnflagMessageByNumber(Int64, Flag) to set or remove a flag.

Inheritance Hierarchy

SystemObject
Limilabs.Client.IMAPFlag

Namespace: Limilabs.Client.IMAP
Assembly: Mail (in Mail.dll) Version: 3.0.23341.1754

Syntax

C++

Copy

[SerializableAttribute]
public class Flag

<SerializableAttribute>
Public Class Flag

[SerializableAttribute]
public ref class Flag

[<SerializableAttribute>]
type Flag =  class end

The Flag type exposes the following members.

Constructors

	Name	Description
	Flag	Creates new instance of the Flag object with specified name.

Top

Properties

	Name	Description
	FullName	Gets the full name of this flag. This property includes backslash for system flags E.g. \SEEN, \UNFLAGGED, MYFLAG.
	IsSystemFlag	Gets information if this is a system flag. All system flags begin with "\" character.
	Name	Gets the name of this flag. E.g. SEEN, UNFLAGGED.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. Names are compared case insensitive. (Overrides ObjectEquals(Object).)
	Equals(Flag)	Determines whether the specified Flag object is equal to the current one. Names are compared case insensitive.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns FullName property. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	Equality	Determines whether two Flag objects are equal.
	Inequality	Determines whether two Flag objects are not equal.

Top

Fields

	Name	Description
	All	Gets \ALL flag. It repesents all messages in the mailbox.
	Answered	Gets \ANSWERED flag. Message has been answered.
	Deleted	Gets \DELETED flag. Message is "deleted" for removal by later EXPUNGE.
	Draft	Gets \DRAFT flag. Message has not completed composition (marked as a draft).
	Flagged	Gets \FLAGGED flag. Message is "flagged" for urgent/special attention.
	Forwarded	Gets the keyword that specifies that the message was resent to another email address, embedded within or attached to a new message. This keyword is set by the mail client when it successfully forwards the message to another email address.
	MDNSent	Gets $MDNSent flag. It indicates if Message Disposition Notification (MDN) was sent for particular message. You can use SupportsMDNSent to check if server supports $MDNSent.
	New	Gets \NEW flag. It represents messages that have the Recent flag set but not the Seen flag. This is functionally equivalent to "(\RECENT \UNSEEN)".
	Old	Gets \OLD flag. It represents messages that do not have the Recent flag set. This is functionally equivalent to "NOT \RECENT" (as opposed to "NOT \NEW").
	Recent	Gets \RECENT flag (don't confuse it with Unseen). Message is "recently" arrived in this mailbox.
	Seen	Gets \SEEN flag. Message has been read.
	Star	Gets \* flag. It indicates, that it is possible to create new keywords by attempting to store those flags in the mailbox (SupportsCustomFlags). You can use FlagMessageByUID(Int64, Flag) or FlagMessageByNumber(Int64, Flag) to do so.
	SubmitPending	Gets the keyword that designates the message as awaiting to be submitted. This keyword allows storing messages waiting to be submitted in the same mailbox where messages that were already submitted and/or are being edited are stored.
	Submitted	Gets the keyword that designates the message as being sent out.
	Unanswered	Gets \UNANSWERED flag. It represents messages that do not have the Answered flag set.
	Undeleted	Gets \UNDELETED flag. It represents messages that do not have the Deleted flag set.
	Undraft	Gets \UNDRAFT flag. It represents messages that do not have the Draft flag set.
	Unflagged	Gets \UNFLAGGED flag. It represents messages that do not have the Flagged flag set.
	Unseen	Gets \UNSEEN flag. It represents messages that do not have the Seen flag set.

Top

Remarks

Exchange 2007 and 2010 do not support custom flags (keywords).

Reference

Limilabs.Client.IMAP Namespace

ImapFlagMessageByUID(Int64, Flag)

ImapUnflagMessageByUID(Int64, Flag)

ImapMarkMessageSeenByNumber(Int64)

ImapMarkMessageUnseenByNumber(Int64)

ImapMarkMessageSeenByUID(Int64)

ImapMarkMessageUnseenByUID(Int64)