Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void UploadFileAttachmentAsync( Stream inputStream, string fileName, string contentId, AsyncCompletedEventHandler completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub UploadFileAttachmentAsync ( _ inputStream As Stream, _ fileName As String, _ contentId As String, _ completedCallback As AsyncCompletedEventHandler, _ userState As Object _ ) |
Parameters
- inputStream
- Type: System.IO..::..Stream
The Stream from which the file content should be read.
- fileName
- Type: System..::..String
The file name to be given to the created attachment.
- contentId
- Type: System..::..String
The Content-ID for an inline attachment conforming to RFC 2111.
- completedCallback
- Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An object that contains state information for this request.
Remarks
A non-null, non-empty Content-ID must be provided to create an inline attachment. Inline attachments conform to RFC 2111, and appear within the body of an email if a Content-ID is provided and the HTML email body includes an element (e.g. <img>) associated to a valid URL using the cid: URL scheme.
Use GenerateContentId(String) to generate a unique Content-ID for an inline attachment prior to uploading it.
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A parameter contains an invalid value. |
Version Information
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.