apidocs

RegisterEmail1 API

Registers an email message as a document in infoRouter at the specified path, and also sets user-defined keywords on the created document in a single call. This is identical to RegisterEmail with the addition of the keywords parameter.

Endpoint


/srv.asmx/RegisterEmail1

Methods

Parameters

Parameter Type Required Description
AuthenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
TargetPath string Yes Full infoRouter path including the document name (e.g. /Finance/Emails/Meeting-Notes.EMAIL). The folder portion must exist. The file name portion becomes the document name. If you pass only .EMAIL as the file name, the system automatically prefixes the generated document ID.
Senders string Yes Sender email address(es). Multiple addresses may be separated by a semicolon.
Recipients string Yes Primary recipient address(es). Multiple addresses may be separated by a semicolon.
CCAddress string No CC address(es). Multiple addresses may be separated by a semicolon. Pass empty string or omit if not applicable.
BCCAddress string No BCC address(es). Multiple addresses may be separated by a semicolon. Pass empty string or omit if not applicable.
SentDate DateTime Yes Date and time the email was sent. Format: yyyy-MM-ddTHH:mm:ss (ISO 8601). Used as the document’s creation and modification date.
Subject string No Email subject line. Pass empty string or omit if not applicable.
header string No Raw email header block. Pass empty string or omit if not applicable.
htmlBody string No HTML body content of the email. Pass empty string or omit if not applicable.
textBody string No Plain text body content of the email. Pass empty string or omit if not applicable.
AttachmentHandlers string No Semicolon-separated list of email attachment descriptors. Each entry has the format {filename}:{upload-handler-guid}. Upload handlers must be pre-created with CreateUploadHandler and populated with UploadFileChunk. Pass empty string or omit if there are no attachments.
keywords string No Comma-separated list of user-defined keywords to assign to the registered email document (e.g. invoice,Q1,finance). Pass empty string or omit to register without keywords.

Attachments

The AttachmentHandlers parameter format is:


{filename1}:{handler-guid1};{filename2}:{handler-guid2}

Response

Success Response


<response success="true" error="" DocumentID="1051" DocumentName="Meeting-Notes.EMAIL" />
Attribute Description
success "true" on success.
error Empty string on success.
DocumentID The infoRouter document ID assigned to the newly registered email document.
DocumentName The actual document name used (may differ from TargetPath if auto-naming was applied).

Error Response


<response success="false" error="Folder not found." />

Required Permissions

The calling user must be authenticated (anonymous users cannot register emails). The user must have add document permission on the target folder.

Example

POST Request


POST /srv.asmx/RegisterEmail1 HTTP/1.1

Content-Type: application/x-www-form-urlencoded



AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&TargetPath=/Finance/Emails/Q1-Budget-Meeting.EMAIL

&Senders=alice@example.com

&Recipients=bob@example.com;carol@example.com

&CCAddress=manager@example.com

&BCCAddress=

&SentDate=2024-03-15T14:30:00

&Subject=Q1 Budget Meeting Notes

&header=

&htmlBody=<html><body><p>Please find the meeting notes attached.</p></body></html>

&textBody=Please find the meeting notes attached.

&AttachmentHandlers=MeetingNotes.pdf:3f2504e0-4f89-11d3-9a0c-0305e82c3301

&keywords=budget,Q1,finance

GET Request


GET /srv.asmx/RegisterEmail1

  ?AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &TargetPath=/Finance/Emails/Q1-Budget-Meeting.EMAIL

  &Senders=alice@example.com

  &Recipients=bob@example.com

  &CCAddress=

  &BCCAddress=

  &SentDate=2024-03-15T14:30:00

  &Subject=Q1+Budget+Meeting+Notes

  &header=

  &htmlBody=

  &textBody=Please+find+the+meeting+notes+attached.

  &AttachmentHandlers=

  &keywords=budget,Q1,finance

HTTP/1.1

SOAP Request


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:RegisterEmail1>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

      <tns:TargetPath>/Finance/Emails/Q1-Budget-Meeting.EMAIL</tns:TargetPath>

      <tns:Senders>alice@example.com</tns:Senders>

      <tns:Recipients>bob@example.com</tns:Recipients>

      <tns:CCAddress></tns:CCAddress>

      <tns:BCCAddress></tns:BCCAddress>

      <tns:SentDate>2024-03-15T14:30:00</tns:SentDate>

      <tns:Subject>Q1 Budget Meeting Notes</tns:Subject>

      <tns:header></tns:header>

      <tns:htmlBody></tns:htmlBody>

      <tns:textBody>Please find the meeting notes attached.</tns:textBody>

      <tns:AttachmentHandlers></tns:AttachmentHandlers>

      <tns:keywords>budget,Q1,finance</tns:keywords>

    </tns:RegisterEmail1>

  </soap:Body>

</soap:Envelope>

Notes

Error Codes

Error Description
[900] Authentication failed Invalid or missing authentication ticket.
[901] Session expired or Invalid ticket The ticket has expired or does not exist.
Anonymous users cannot perform this action The authenticated user is an anonymous/guest user.
Folder not found The folder portion of TargetPath does not exist.
Upload handler not found One of the specified attachment handler GUIDs is invalid or has expired.
Invalid attachment handler format The AttachmentHandlers string is malformed (missing : separator or invalid GUID).
Duplicate email An email with the same document name and Message-ID already exists in the target folder.
Access denied The user does not have add document permission on the target folder.
SystemError:... An unexpected server-side error occurred.