[This is preliminary documentation and is subject to change.]

Gets all the stored emails and their related information in the OfficeClip database for the currently logged in user.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public DataSet GetEmails(
	int userId
)
Visual Basic (Declaration)
Public Function GetEmails ( _
	userId As Integer _
) As DataSet
Visual C++
public:
DataSet^ GetEmails(
	int userId
)

Parameters

userId
Type: System..::.Int32
the unique id of the user

Return Value

DataSet containing all information related to the emails stored in the OfficeClip database which were retrieved earlier. The DataSet consists of a single DataTable with the following columns.
  • emailId (System.Int32)Id of the email.
  • emailFolderId (System.Int32)Id of the folder in which this particular email is stored.
  • EmailFolderTypeId (System.Int32)Type of the folder in which this particular email is stored. 1 = Inbox 2 = Sent Messages 3 = Drafts 4 = Delete 10 = User Defined.
  • UserId (System.Int32)Id of the user for whom the emails are being retrieved. (The currenly logged in user.)
  • emailAccountId (System.Int32)Id of the email account corresponding to the Email server from which this particular email has been downloaded.
  • ReceivedTimestamp (System.DateTime)Date and Time at which this email was received on the email server.
  • RepliedTimestamp (System.DateTime)Date and Time when the user replied to this particular email.
  • ReplyToEmailId (System.Int32)Id of the email if this email was sent as a reply to an email.
  • ForwardedTimestamp (System.DateTime)Date and Time when the user forwarded this particular email
  • ForwardFromEmailId (System.Int32)Id of the email if this email was sent as a forward to an email.
  • SentTimestamp (System.Int32)Date and Time when this mail was sent by this user.
  • EmailStatus (System.Int32) Numeric value corresponding to the EmailStatus enumerated type indicating the Current status of this particular email. OfficeClip.Utils..::.EmailStatus
  • messageId (System.String)Unique ID assigned by the email server to each email message.
  • fromEmailAddress (System.String)The from email address of the email message.
  • toEmailAddress (System.String)The to email address of the email message.
  • subject (System.String)The subject of the email message.
  • size (System.Int32)The size of the email message.
  • isAttachmentPresent (System.Boolean)Whether an attachment is present with the email message.
  • priority (System.String)The priority of the email email message.
  • EmailAccountName (System.String)Name of the email account corresponding to the email server from which this email was downloaded.
  • accountColorScheme (System.String)Name of the color scheme to be used to highlight this email to signify that it has been downloaded from a particular email server.

See Also