1. Home / Web Services API Version 8.x / RegisterEmail

RegisterEmail

Registers emails to the specified path.

Syntax

Visual Basic (declaration) 
Public Function RegisterEmail( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal TargetPath as String, _ 
	ByVal Senders as String, _ 
	ByVal Recipients as String, _ 
	ByVal CCAddress as String, _ 
	ByVal BCCAddress as String, _ 
	ByVal SentDate as DateTime, _ 
	ByVal Subject as String, _ 
	ByVal header as String, _ 
	ByVal htmlBody as String, _ 
	ByVal textBody as String, _ 
	ByVal AttachmentHandlers as String) as XmlNode

C# (declaration) 
public XmlNode RegisterEmail( 
	string AuthenticationTicket,
	string TargetPath,
	string Senders,
	string Recipients,
	string CCAddress,
	string BCCAddress,
	DateTime SentDate,
	string Subject,
	string header,
	string htmlBody,
	string textBody,
	string AttachmentHandlers)

Parameters

AuthenticationTicket
    string infoRouter ticket
TargetPath
    string An infoRouter document path where the email is located.
Senders
    string senders email address delimeted with semicolumns
Recipients
    string recipient email address delimeted with semicolumns
CCAddress
    string Carbon copy email address delimeted with semicolumns
BCCAddress
    string Blind copy email address delimeted with semicolumns
SentDate
    DateTime The send date of the email.
Subject
    string The Subject of the email.
header
    string The header information of the email.
htmlBody
    string If the email body is in the form of HTML
textBody
    string If the email body is in the form of TEXT
AttachmentHandlers
    string Attachment name and handler pairs delimeted by semicolumns. example (invoice1.pdf:ir117;invoice2.pdf:ir118;invoiceSum.xls:ir119

Return Value

returns xml fragment.

<response success="true" error=""/>

if success attribute is "true", the email item successfully filed.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

The caller must have at least "add" right to the specified path.
The Attachments have been upladed before using UploadHandlers.

See Also