[This is preliminary documentation and is subject to change.]
Gets all the information for all the email accounts for the currently logged in user.
Namespace:
OfficeClip.DBLayer.DesktopAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public DataTable GetEmailAccounts( int userId, bool isSendOnly ) |
Visual Basic (Declaration) |
---|
Public Function GetEmailAccounts ( _ userId As Integer, _ isSendOnly As Boolean _ ) As DataTable |
Visual C++ |
---|
public: DataTable^ GetEmailAccounts( int userId, bool isSendOnly ) |
Parameters
- userId
- Type: System..::.Int32
- isSendOnly
- Type: System..::.Boolean
Return Value
DataSet containing all the information related to all the email accounts for the Current user. DataSet consists of a single DataTable with the following columns.- emailAccountId (System.Int32) Id of the email account.
- UserId (System.Int32) Id of the user to which this particular email account belongs. (Always the currently logged in user).
- EmailAccountName (System.String) Name of the email account.
- serverName (System.String) Name of the POP email server.
- UserName (System.String) User's login name on the POP email server.
- UserPassword (System.String) User's password on the POP email server.
- PortNumber (System.Int32) The port number to which to connect to on the POP email server. (Usually this value is 110).
- ServerTimeout (System.Int32) Time (in seconds) for which to wait while trying to connecting to the POP email server.
- LeaveCopyOnServer (System.String) Flag (Y/N) indicating whether while downloading new mails, a copy should be left on the email server.
- ColorScheme (System.String) Name of the color to be used to highlight emails from a particular POP email server.
- ServerType (System.String) Type of the server, POP, IMAP, etc. (This field is not yet used. It has been kept for future enhancements for providing integration with different types of mail servers.)
- OutgoingServerSameAsIncoming (System.String) Flag (Y/N) indicating whether the outgoing (SMTP) server is same as the POP email server specified above.
- OutgoingServerName (System.String) Name of the outgoing (SMTP) mail server to send outgoing emails.
- OutgoingServerNeedsAuthentication (System.String) Flag (Y/N) indicating whether the outgoing (SMTP) mail server needs authentication i.e. whether a user id and password needs to be specified while connecting to the SMTP server.
- OutgoingServerType (System.String) Type of the outgoing mail server. (This field is not yet used. It has been kept for future enhancements for providing integration with different types of mail servers.)
- OutgoingServerUserName (System.String) The user id on the outgoing email server. This field is only present if outgoing server needs authentication.
- OutgoingServerUserPassword (System.String) password corresponding to the user id on the outgoing email server. This field is only present if outgoing server needs authentication.