[Csmail-patches] CVS: csmail/src/CSMail AddressType.cs,1.1,1.2 ChangeLog,1.27,1.28 ConnectionEventTy
Status: Pre-Alpha
Brought to you by:
mastergaurav
From: Gaurav V. <mas...@us...> - 2002-09-04 09:59:21
|
Update of /cvsroot/csmail/csmail/src/CSMail In directory usw-pr-cvs1:/tmp/cvs-serv5786 Modified Files: AddressType.cs ChangeLog ConnectionEventType.cs FolderEventType.cs FolderOpenMode.cs FolderType.cs MessageDeliveryStatus.cs MessageFlags.cs ProviderSearchType.cs ProviderType.cs RecipientType.cs StoreMessageType.cs StoreSearchType.cs Log Message: 2002-09-04 * AddressType.cs, * ConnectionEventType.cs, * FolderEventType.cs, * FolderOpenStyle.cs, * FolderType.cs, * MessageDeliveryStatus.cs, * MessageFlags.cs, * ProviderSearchType.cs, * ProviderType.cs, * RecipientType.cs, * StoreMessageType.cs, * StoreSearchType.cs : On documentation spree. Index: AddressType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/AddressType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- AddressType.cs 20 Jun 2002 02:43:23 -0000 1.1 +++ AddressType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -11,10 +11,27 @@ namespace CSMail { + /// <summary> + /// Denotes the type of address. + /// </summary> + /// <remarks> + /// Useful during resolution of addresses while dispatching messages. + /// The messages would be dispatched using protocols as set for the + /// respective type. + /// </remarks> public enum AddressType { + /// <summary> + /// Denotes that the address is an email. + /// </summary> EmailAddress, + /// <summary> + /// Denotes that the address is a URL. + /// </summary> InternetAddress, + /// <summary> + /// Denotes that the address is a newsgroup. + /// </summary> NewsAddress } } Index: ChangeLog =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/ChangeLog,v retrieving revision 1.27 retrieving revision 1.28 diff -u -r1.27 -r1.28 --- ChangeLog 4 Sep 2002 07:06:08 -0000 1.27 +++ ChangeLog 4 Sep 2002 09:59:18 -0000 1.28 @@ -1,6 +1,22 @@ 2002-09-04 Gaurav Vaish <mastergaurav AT users DOT sf DOT net> + * AddressType.cs, + * ConnectionEventType.cs, + * FolderEventType.cs, + * FolderOpenStyle.cs, + * FolderType.cs, + * MessageDeliveryStatus.cs, + * MessageFlags.cs, + * ProviderSearchType.cs, + * ProviderType.cs, + * RecipientType.cs, + * StoreMessageType.cs, + * StoreSearchType.cs + : On documentation spree. + +2002-09-04 Gaurav Vaish <mastergaurav AT users DOT sf DOT net> + * BodyPart.cs : ParentProperty - Not virtual, internal * Multipart.cs : Part => Parent : Several methods - Stubbed Index: ConnectionEventType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/ConnectionEventType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ConnectionEventType.cs 20 Jun 2002 02:43:24 -0000 1.1 +++ ConnectionEventType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -12,10 +12,22 @@ namespace CSMail { + /// <summary> + /// Denotes the type of event occured with a connection. + /// </summary> public enum ConnectionEventType { + /// <summary> + /// Denotes that the connection was opened. + /// </summary> Opened, + /// <summary> + /// Denotes that the connection was closed. + /// </summary> Closed, + /// <summary> + /// Denotes that the connection got disconnected (killed or timed-out). + /// </summary> Disconnected } } Index: FolderEventType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/FolderEventType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- FolderEventType.cs 20 Jun 2002 02:43:24 -0000 1.1 +++ FolderEventType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -10,10 +10,25 @@ namespace CSMail { + /// <summary> + /// Denotes the event related to a folder. + /// </summary> + /// <remarks> + /// Useful when handling an folder event. + /// </remarks> public enum FolderEventType { + /// <summary> + /// Specifies that the folder has been created. + /// </summary> Created, + /// <summary> + /// Specifies that the folder has been deleted. + /// </summary> Deleted, + /// <summary> + /// Specifies that the folder has been renamed. + /// </summary> Renamed } } Index: FolderOpenMode.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/FolderOpenMode.cs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- FolderOpenMode.cs 28 Aug 2002 10:17:12 -0000 1.2 +++ FolderOpenMode.cs 4 Sep 2002 09:59:18 -0000 1.3 @@ -10,11 +10,45 @@ namespace CSMail { + /// <summary> + /// Denotes the mode in which folder has been opened + /// </summary> + /// <remarks> + /// Opening folder in a <code>ReadOnly</code> mode and + /// then trying to write on it would raise an exception. + /// </remarks> public enum FolderOpenMode { + /// <summary> + /// Default mode of opening a folder. + /// <summary> + /// <remarks> + /// Though it is implementation dependent, but a + /// <code>ReadOnly</code> mode corresponding to this + /// would be preferred. + /// </remarks> Default, + /// <summary> + /// The mode is indeterminate. + /// </summary> + /// <remarks> + /// As such, trying to read from or write to the folder + /// would raise an exception. + /// </remarks> NotSet, + /// <summary> + /// The folder can not be used for writing. + /// </summary> + /// <remarks> + /// Trying to write to a folder opened using this mode should + /// raise an exception. Also, any changes made to the folder, + /// if the exceptions are caught internally and not allowed to + /// propagate, are lost. + /// </summary> ReadOnly, + /// <summary> + /// The folder can not be used for writing. + /// </summary> ReadWrite } } Index: FolderType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/FolderType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- FolderType.cs 20 Jun 2002 02:43:24 -0000 1.1 +++ FolderType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -10,10 +10,26 @@ namespace CSMail { + /// <summary> + /// Denotes the type of folder. + /// </summary> + /// <remarks> + /// A folder can be used to store messages, other folders + /// or may be even both. Use this to denote what can it hold. + /// </remarks> public enum FolderType { + /// <summary> + /// Folder can hold only other folders. + /// </summary> Folders, + /// <summary> + /// Folder can hold only messages. + /// </summary> Messages, + /// <summary> + /// Folder can hold both messages as well as other folders. + /// </summary> Both } } Index: MessageDeliveryStatus.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/MessageDeliveryStatus.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- MessageDeliveryStatus.cs 3 Sep 2002 04:17:00 -0000 1.1 +++ MessageDeliveryStatus.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -10,11 +10,31 @@ namespace CSMail { + /// <summary> + /// The status of a message after it has been set + /// for delivery. + /// </summary> public enum MessageDeliveryStatus { + /// <summary> + /// The status is unknown! + /// </summary> Unknown, + /// <summary> + /// The message has been delivered. + /// </summary> Delivered, + /// <summary> + /// The message has been delivered partially. + /// </summary> + /// <remarks> + /// The left out part may be the process queue, + /// or something wrong might have happened! + /// </remarks> PartiallyDelivered, + /// <summary> + /// The message has not been delievered. + /// </summary> NotDelivered } } Index: MessageFlags.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/MessageFlags.cs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- MessageFlags.cs 28 Aug 2002 10:17:12 -0000 1.2 +++ MessageFlags.cs 4 Sep 2002 09:59:18 -0000 1.3 @@ -12,16 +12,46 @@ namespace CSMail { + /// <summary> + /// Various flags associated with a message. + /// </summary> [Flags] public enum MessageFlags { + /// <summary> + /// No flag is set. + /// </summary> None = 0x0000, + /// <summary> + /// The message has been answered. + /// </summary> Answered = 0x0001 << 0, + /// <summary> + /// The message has been marked for deletion + /// (but may not be expunged yet). + /// </summary> Deleted = 0x0001 << 1, + /// <summary> + /// The message is a draft. + /// </summary> Draft = 0x0001 << 2, + /// <summary> + /// The message has been flagged. + /// </summary> Flagged = 0x0001 << 3, + /// <summary> + /// The message is a newly arrived message (hence, + /// necessarily not <code>Seen</code>). + /// </summary> Recent = 0x0001 << 4, + /// <summary> + /// The message has been read (hence, necessarily not + /// <code>Recent</code>). + /// </summary> Seen = 0x0001 << 5, + /// <summary> + /// Any user defined flags. + /// </summary> UserDefined = 0x0001 << 15, } } Index: ProviderSearchType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/ProviderSearchType.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ProviderSearchType.cs 30 Aug 2002 10:31:26 -0000 1.3 +++ ProviderSearchType.cs 4 Sep 2002 09:59:18 -0000 1.4 @@ -10,9 +10,18 @@ namespace CSMail { + /// <summary> + /// Criterion while looking up for a provider. + /// </summary> public enum ProviderSearchType { + /// <summary> + /// Search using class-name as the key. + /// </summary> ClassName, + /// <summary> + /// Search using protocol as the key. + /// </summary> Protocol } } Index: ProviderType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/ProviderType.cs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- ProviderType.cs 29 Aug 2002 11:32:31 -0000 1.2 +++ ProviderType.cs 4 Sep 2002 09:59:18 -0000 1.3 @@ -10,10 +10,27 @@ namespace CSMail { + /// <summary> + /// What service are you providing. + /// </summary> public enum ProviderType { + /// <summary> + /// The provider type is not set. + /// </summary> + /// <remarks> + /// As such, the name of the provider cannot be + /// added to the list of the various providers + /// available. + /// </remarks> NotSet, + /// <summary> + /// The provider is a provider for "Store" service. + /// </summary> Store, + /// <summary> + /// The provider is a provider for "Transport" service. + /// </summary> Transport } -} \ No newline at end of file +} Index: RecipientType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/RecipientType.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- RecipientType.cs 20 Jun 2002 03:57:59 -0000 1.3 +++ RecipientType.cs 4 Sep 2002 09:59:18 -0000 1.4 @@ -12,13 +12,36 @@ namespace CSMail { + /// <summary> + /// Where should the recipient's address go. + /// </summary> [Flags] public enum RecipientType: short { + /// <summary> + /// Mark the address(es) to go in the "To" header. + /// </summary> To = 0x0001, + /// <summary> + /// Mark the address(es) to go in to "Cc" header. + /// </summary> Cc = 0x0002, + /// <summary> + /// Mark the address(es) to go in to "Bcc" header. + /// </summary> Bcc = 0x0004, + /// <summary> + /// Mark the address(es) to go be sent to a newsgroup. + /// </summary> NewsGroup = 0x0010, + /// <summary> + /// Address(es) are set for all the types. + /// </summary> + /// <remarks> + /// But wait, how can an email in "To" and a newsgroup be + /// same. I must be wrong. Anyway, if "All" is set, you + /// should know how to parse the recipient list. + /// </remarks> All = To | Cc | Bcc | NewsGroup } } Index: StoreMessageType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/StoreMessageType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- StoreMessageType.cs 30 Aug 2002 11:11:18 -0000 1.1 +++ StoreMessageType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -10,10 +10,28 @@ namespace CSMail { + /// <summary> + /// The type of message emitted by a store. + /// </summary> public enum StoreMessageType { + /// <summary> + /// The type is indeterminate. + /// </summary> + /// <remarks> + /// The implementing class may choose to default + /// it to any of <code>Alert</code> or <code>Notice</code> + /// when actually delivering the message, or optionally + /// raise an exception. + /// </remarks> NotSet, + /// <summary> + /// The message emitted is an alert. + /// </summary> Alert, + /// <summary> + /// The message emitted is a notice. + /// </summary> Notice } } Index: StoreSearchType.cs =================================================================== RCS file: /cvsroot/csmail/csmail/src/CSMail/StoreSearchType.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- StoreSearchType.cs 30 Aug 2002 10:31:27 -0000 1.1 +++ StoreSearchType.cs 4 Sep 2002 09:59:18 -0000 1.2 @@ -10,10 +10,33 @@ namespace CSMail { + /// <summary> + /// Denotes the criterion for a store (class). + /// </summary> + /// <remarks> + /// It is useful when we are trying to look for a class in the + /// list of available stores. This defines what parameter are + /// we looking for during search. + /// </remarks> public enum StoreSearchType { + /// <summary> + /// Search key is the class-name. + /// </summary> ClassName, + /// <summary> + /// Search key is the index. + /// </summary> + /// <remarks> + /// Used very rarely, since you don't know in which order + /// will the classes be read (from the configuration file). + /// <br/> + /// Use this only when you know what you are doing. + /// </remarks> Index, + /// <summary> + /// Search key is the full URL. + /// </summary> URLName } } |