Definition for various different EventType's. See description for
each event for more detail on when these are generated.
Namespace: MailAttachmentDownloaderApiAssembly: MailAttachmentDownloaderApi (in MailAttachmentDownloaderApi.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# |
|---|
public enum ProcessMailEventType |
Members
| Member name | Value | Description | |
|---|---|---|---|
| MailNotConnected | 0 | This is the default state when the platform is not connected to the mail server before the platform establishes the connection to the mail server. | |
| MailLoggingIn | 1 | This event is generated when the platform is logging you in to the mail account using the username and password. | |
| MailLoggedIn | 2 | This event is generated when the platform has successfully logged into the mail account. | |
| MailLoginError | 3 | This event is generated when the platform is not successful with logging you in to the server. | |
| MailLoginErrorNonFatal | 4 | This event is generated when the platform is not successful with logging one of the worker threads (likely due to server rejecting many simultaneous connections). | |
| MailLoadingStarted | 5 | This event is used internally. It will not be generated by this API. | |
| MailLoadingComplete | 6 | This event is used internally. It will not be generated by this API. | |
| MailFolderListStarting | 7 | This event is generated when the StartListFolders()()()() is called and the listing process has started. | |
| MailFolderListComplete | 8 | This event is generated when the StartListFolders()()()() is called and the listing process is complete. The resulting root IFolder can be obtained from RootFolder. Child folders can be obtained by walking through the list of child folders, see IFolder interface for more details. | |
| MailFolderListError | 9 | This event is generated when the StartListFolders()()()() is called and the listing process finished with an error. | |
| MailFolderDownloadStarted | 10 | This event is generated when the StartDownloadingAttachments()()()() is called and the folder download has started for a given folder. The name of the folder that has started downloading can be obtained from FilenameOrFolder property. | |
| MailFolderDownloadCompleteWithFiles | 11 | This event is generated when the StartDownloadingAttachments()()()() is called and the folder download has completed for a given folder with some files downloaded. The name of the folder that has completed downloading can be obtained from FilenameOrFolder property. To obtain the total number of files downloaded successfully or with errors across all folders thus far, see IDownloadStats. | |
| MailFolderDownloadCompleteWithNoFiles | 12 | This event is generated when the StartDownloadingAttachments()()()() is called and the folder download has completed for a given folder without any files downloaded. The name of the folder that has completed downloading can be obtained from FilenameOrFolder property. To obtain the total number of files downloaded successfully or with errors across all folders thus far, see IDownloadStats. | |
| MailFolderDownloadCanceled | 13 | This event is generated when the StartDownloadingAttachments()()()() is called and the folder download has been cancelled. The name of the folder that was cancelled can be obtained from FilenameOrFolder property. To obtain the total number of files downloaded successfully or with errors across all folders thus far, see IDownloadStats. | |
| MailFolderSelectError | 14 | This event is generated when the StartDownloadingAttachments()()()() is called and selecting the folder failed (for example, when the folder no longer exists on the server). | |
| MailFolderDownloadError | 15 | This event is generated when the StartDownloadingAttachments()()()() is called and the folder download had an error. The name of the folder that had the error can be obtained from FilenameOrFolder property. To obtain the total number of files downloaded successfully or with errors across all folders thus far, see IDownloadStats. | |
| MailSearchStarting | 16 | This event is generated when the StartDownloadingAttachments()()()() is called and the platform is searching for mail within a given folder. | |
| MailSearchComplete | 17 | This event is generated when the StartDownloadingAttachments()()()() is called and the platform has completed searching for mail with attachments within a given folder. | |
| MailSearchError | 18 | This event is generated when the StartDownloadingAttachments()()()() is called and the platform encountered an error when searching for mail within a given folder. This would normally be followed by a MailFatalUnknown error, triggering the end of the StartDownloadingAttachments()()()() operation. | |
| MailProcessSearchResults | 19 | This event is generated by the platform for every message that is processed when the StartDownloadingAttachments()()()() is called. | |
| MailDownloadStarted | 20 | This event is generated by the platform for every attachment that is being downloaded after the StartDownloadingAttachments()()()() was called. The name of the file that is being downloaded can be obtained from FilenameOrFolder property. | |
| MailDownloading | 21 | This event is generated by the platform for every few blocks of data that is being downloaded after the StartDownloadingAttachments()()()() was called. The name of the file that is being downloaded can be obtained from FilenameOrFolder property. | |
| MailDownloadComplete | 22 | This event is generated when the platform successfully downloads an attachment after the StartDownloadingAttachments()()()() was called. The name of the file that was downloaded can be obtained from FilenameOrFolder property. | |
| MailDownloadError | 23 | This event is generated when the platform encountered an error when downloading an attachment after the StartDownloadingAttachments()()()() was called. The name of the file that resulted in an error can be obtained from FilenameOrFolder property. | |
| MailSaving | 24 | This event is generated by the platform for every attachment that is being saved after the StartDownloadingAttachments()()()() was called. The name of the file that is being saved can be obtained from FilenameOrFolder property. | |
| MailSaved | 25 | This event is generated by the platform for every attachment that has been saved after the StartDownloadingAttachments()()()() was called. The name of the file that has been saved can be obtained from FilenameOrFolder property. | |
| MailSaveError | 26 | This event is generated by the platform for every attachment that resulted in a save error after the StartDownloadingAttachments()()()() was called. The name of the file that encountered the error can be obtained from FilenameOrFolder property. | |
| MailSearchAndDownloadComplete | 27 | This event is used internally. | |
| MailSearchAndDownloadCanceled | 28 | This event is used internally. | |
| MailSearchAndDownloadWorkerComplete | 29 | This event is used internally. | |
| MailSearchAndDownloadWorkerCanceled | 30 | This event is used internally. | |
| MailUserAction | 31 | This event is used internally. | |
| MailUnknown | 32 | This event is used internally. | |
| MailLog | 33 | This event is used internally. | |
| MailFatalUnknown | 34 | When either StartDownloadingAttachments()()()() or StartListFolders()()()() results in a fatal error that stops the platform from further execution of those functions, this error is raised. |
See Also
