Asynchronously uploads an attachment from a local file to the current EmailContent.

Namespace: ININ.IceLib.Interactions
Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void UploadFileAttachmentAsync(
	string fileName,
	string contentId,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub UploadFileAttachmentAsync ( _
	fileName As String, _
	contentId As String, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

fileName
Type: System..::..String
The path and name of a local file to upload the attachment from.
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

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionA parameter contains an invalid value.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also