Aspose::Email::Clients::Imap::ImapMessageInfo Class Referencefinal

Represents a Imap message object. More...

Inherits Aspose::Email::Clients::MessageInfoBase.

Public Member Functions

System::String get_ParentFolder () const
 Gets parent folder for message More...
 
void set_ParentFolder (System::String value)
 Gets parent folder for message More...
 
System::DateTime get_InternalDate ()
 The internal date and time of the message on the server. This is not the date and time in the [RFC-2822] header, but rather a date and time which reflects when the message was received.
More...
 
void set_InternalDate (System::DateTime value)
 The internal date and time of the message on the server. This is not the date and time in the [RFC-2822] header, but rather a date and time which reflects when the message was received.
More...
 
int64_t get_ModificationSequence () const
 Gets the modification sequence of this message. See more: https://tools.ietf.org/html/rfc7162 More...
 
void set_ModificationSequence (int64_t value)
 Gets the modification sequence of this message. See more: https://tools.ietf.org/html/rfc7162 More...
 
System::SharedPtr< ImapMessageFlagsget_Flags () const
 Gets the message flags. More...
 
void set_Flags (System::SharedPtr< ImapMessageFlags > value)
 Gets the message flags. More...
 
bool get_Answered ()
 Gets a value indicating whether Flags property contains the Answered flag. More...
 
bool get_Deleted ()
 Gets a value indicating whether Flags property contains the Deleted flag. More...
 
bool get_Draft ()
 Gets a value indicating whether Flags property contains the Draft flag. More...
 
bool get_Flagged ()
 Gets a value indicating whether Flags property contains the Flagged flag. More...
 
bool get_Recent ()
 Gets a value indicating whether Flags property contains the Recent flag. More...
 
bool get_IsRead ()
 Gets a value indicating whether Flags property contains the Read flag. More...
 
void set_IsRead (bool value)
 Gets a value indicating whether Flags property contains the Read flag. More...
 
System::String get_ConversationId ()
 Gets a value indicating conversation id. More...
 
void set_ConversationId (System::String value)
 Gets a value indicating conversation id. More...
 
int32_t get_SequenceNumber () const
 Gets the message sequence number. More...
 
System::String get_UniqueId () const
 Gets the message unique ID. More...
 
System::SharedPtr< System::Collections::Generic::IDictionary< System::String, System::String > > get_ExtraParameters () const
 Gets extra parameters of a message. More...
 
 ImapMessageInfo (int32_t sequenceNumber)
 Initializes a new instance of the ImapMessageInfo class. More...
 
bool ContainsKeyword (System::String flag)
 Gets a value indicating whether Flags property contains the Keyword flag. More...
 
System::String ToString () const override
 Returns a string that represents the current object. More...
 
- Public Member Functions inherited from Aspose::Email::Clients::MessageInfoBase
System::SharedPtr< Aspose::Email::Mime::HeaderCollectionget_Headers ()
 Gets the Headers of the E-Mail message. More...
 
System::String get_Subject ()
 Gets the Subject of the E-Mail message. More...
 
void set_Subject (System::String value)
 Gets the Subject of the E-Mail message. More...
 
System::String get_MessageId ()
 Gets the message ID. More...
 
void set_MessageId (System::String value)
 Gets the message ID. More...
 
virtual System::SharedPtr< MailAddressCollectionget_To ()
 Gets the receiptants of the E-Mail message. More...
 
virtual void set_To (System::SharedPtr< MailAddressCollection > value)
 Gets the receiptants of the E-Mail message. More...
 
virtual System::SharedPtr< MailAddressCollectionget_CC ()
 Gets CC of the E-Mail message. More...
 
virtual void set_CC (System::SharedPtr< MailAddressCollection > value)
 Gets CC of the E-Mail message. More...
 
virtual System::SharedPtr< MailAddressCollectionget_Bcc ()
 Gets blind carbon copy of the E-Mail message. More...
 
virtual void set_Bcc (System::SharedPtr< MailAddressCollection > value)
 Gets blind carbon copy of the E-Mail message. More...
 
System::SharedPtr< MailAddressCollectionget_ReplyTo ()
 Gets the list of addresses that should receive replies to this message. More...
 
void set_ReplyTo (System::SharedPtr< MailAddressCollection > value)
 Gets the list of addresses that should receive replies to this message. More...
 
System::SharedPtr< MailAddressget_From ()
 Gets the list of authors of this message. More...
 
void set_From (System::SharedPtr< MailAddress > value)
 Gets the list of authors of this message. More...
 
System::SharedPtr< MailAddressget_Sender ()
 Gets the sender of this message. More...
 
void set_Sender (System::SharedPtr< MailAddress > value)
 Gets the sender of this message. More...
 
void set_Size (int64_t value)
 Gets the size of the E-Mail message. More...
 
virtual System::DateTime get_Date ()
 The origination date specifies the date and time at which the creator of the message indicated that the message was complete and ready to enter the mail delivery system. For instance, this might be the time that a user pushes the "send" or "submit" button in an application program. In any case, it is specifically not intended to convey the time that the message is actually transported, but rather the time at which the human or other creator of the message has put the message into its final form, ready for transport. (For example, a portable computer user who is not connected to a network might queue a message for delivery. The origination date is intended to contain the date and time that the user queued the message, not the time when the user connected to the network to send the message.) More...
 
virtual void set_Date (System::DateTime value)
 The origination date specifies the date and time at which the creator of the message indicated that the message was complete and ready to enter the mail delivery system. For instance, this might be the time that a user pushes the "send" or "submit" button in an application program. In any case, it is specifically not intended to convey the time that the message is actually transported, but rather the time at which the human or other creator of the message has put the message into its final form, ready for transport. (For example, a portable computer user who is not connected to a network might queue a message for delivery. The origination date is intended to contain the date and time that the user queued the message, not the time when the user connected to the network to send the message.) More...
 
System::String get_ListUnsubscribe ()
 The List-Unsubscribe field describes the command (preferably using mail) to directly unsubscribe the user(removing them from the list). For more details please see https://tools.ietf.org/html/rfc2369 More...
 
void set_ListUnsubscribe (System::String value)
 The List-Unsubscribe field describes the command (preferably using mail) to directly unsubscribe the user(removing them from the list). For more details please see https://tools.ietf.org/html/rfc2369 More...
 
virtual System::SharedPtr< Aspose::Email::Mapi::MapiPropertyCollectionget_Properties ()
 Gets a mapi properties. More...
 
 MessageInfoBase ()
 Initializes a new instance of the MessageInfoBase class. More...
 
 MessageInfoBase (System::SharedPtr< Aspose::Email::Mapi::MapiPropertyCollection > properties)
 Initializes a new instance of the MessageInfoBase class. More...
 
void SetMessage (System::SharedPtr< MailMessage > m)
 Applies the message data. More...
 
void Dispose () override
 Performs tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
int64_t get_Size () const
 Gets the size of the E-Mail message. More...
 
System::String ToString () const override
 A string that represents the current object. More...
 

Public Attributes

System::String uid
 
- Public Attributes inherited from Aspose::Email::Clients::MessageInfoBase
System::SharedPtr< Aspose::Email::Mime::HeaderCollectionInternalHeaders
 

Friends

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

Detailed Description

Represents a Imap message object.

Constructor & Destructor Documentation

◆ ImapMessageInfo()

Aspose::Email::Clients::Imap::ImapMessageInfo::ImapMessageInfo ( int32_t  sequenceNumber)

Initializes a new instance of the ImapMessageInfo class.

Parameters
sequenceNumberThe sequence number.

Member Function Documentation

◆ ContainsKeyword()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::ContainsKeyword ( System::String  flag)

Gets a value indicating whether Flags property contains the Keyword flag.

Parameters
flagThe Keyword flag.

◆ get_Answered()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_Answered ( )

Gets a value indicating whether Flags property contains the Answered flag.

The answered flag.

◆ get_ConversationId()

System::String Aspose::Email::Clients::Imap::ImapMessageInfo::get_ConversationId ( )

Gets a value indicating conversation id.

◆ get_Deleted()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_Deleted ( )

Gets a value indicating whether Flags property contains the Deleted flag.

The deleted flag.

◆ get_Draft()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_Draft ( )

Gets a value indicating whether Flags property contains the Draft flag.

The draft flag.

◆ get_ExtraParameters()

System::SharedPtr<System::Collections::Generic::IDictionary<System::String, System::String> > Aspose::Email::Clients::Imap::ImapMessageInfo::get_ExtraParameters ( ) const

Gets extra parameters of a message.

◆ get_Flagged()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_Flagged ( )

Gets a value indicating whether Flags property contains the Flagged flag.

The flagged flag.

◆ get_Flags()

System::SharedPtr<ImapMessageFlags> Aspose::Email::Clients::Imap::ImapMessageInfo::get_Flags ( ) const

Gets the message flags.

The message flags.

◆ get_InternalDate()

System::DateTime Aspose::Email::Clients::Imap::ImapMessageInfo::get_InternalDate ( )

The internal date and time of the message on the server. This is not the date and time in the [RFC-2822] header, but rather a date and time which reflects when the message was received.

  • In the case of messages delivered via [SMTP], this SHOULD be the date and time of final delivery of the message as defined by[SMTP].
  • In the case of messages delivered by the IMAP4rev1 COPY command, this SHOULD be the internal date and time of the source message.
  • In the case of messages delivered by the IMAP4rev1 APPEND command, this SHOULD be the date and time as specified in the APPEND command description.
  • All other cases are implementation defined.

◆ get_IsRead()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_IsRead ( )

Gets a value indicating whether Flags property contains the Read flag.

The read flag.

◆ get_ModificationSequence()

int64_t Aspose::Email::Clients::Imap::ImapMessageInfo::get_ModificationSequence ( ) const

Gets the modification sequence of this message. See more: https://tools.ietf.org/html/rfc7162

◆ get_ParentFolder()

System::String Aspose::Email::Clients::Imap::ImapMessageInfo::get_ParentFolder ( ) const

Gets parent folder for message

◆ get_Recent()

bool Aspose::Email::Clients::Imap::ImapMessageInfo::get_Recent ( )

Gets a value indicating whether Flags property contains the Recent flag.

The recent flag.

◆ get_SequenceNumber()

int32_t Aspose::Email::Clients::Imap::ImapMessageInfo::get_SequenceNumber ( ) const

Gets the message sequence number.

The sequence number.

◆ get_UniqueId()

System::String Aspose::Email::Clients::Imap::ImapMessageInfo::get_UniqueId ( ) const

Gets the message unique ID.

The unique id string.

◆ set_ConversationId()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_ConversationId ( System::String  value)

Gets a value indicating conversation id.

◆ set_Flags()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_Flags ( System::SharedPtr< ImapMessageFlags value)

Gets the message flags.

The message flags.

◆ set_InternalDate()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_InternalDate ( System::DateTime  value)

The internal date and time of the message on the server. This is not the date and time in the [RFC-2822] header, but rather a date and time which reflects when the message was received.

  • In the case of messages delivered via [SMTP], this SHOULD be the date and time of final delivery of the message as defined by[SMTP].
  • In the case of messages delivered by the IMAP4rev1 COPY command, this SHOULD be the internal date and time of the source message.
  • In the case of messages delivered by the IMAP4rev1 APPEND command, this SHOULD be the date and time as specified in the APPEND command description.
  • All other cases are implementation defined.

◆ set_IsRead()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_IsRead ( bool  value)

Gets a value indicating whether Flags property contains the Read flag.

The read flag.

◆ set_ModificationSequence()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_ModificationSequence ( int64_t  value)

Gets the modification sequence of this message. See more: https://tools.ietf.org/html/rfc7162

◆ set_ParentFolder()

void Aspose::Email::Clients::Imap::ImapMessageInfo::set_ParentFolder ( System::String  value)

Gets parent folder for message

◆ ToString()

System::String Aspose::Email::Clients::Imap::ImapMessageInfo::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::FetchMessageInfoCollectionCommand

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

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

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

◆ Aspose::Email::Clients::Imap::Commands::ThreadGrCommand

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

Member Data Documentation

◆ uid

System::String Aspose::Email::Clients::Imap::ImapMessageInfo::uid