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¶

• GET /srv.asmx/RegisterEmail1?AuthenticationTicket=...&TargetPath=...&Senders=...&...&keywords=...

• POST /srv.asmx/RegisterEmail1 (form data)

• SOAP Action: http://tempuri.org/RegisterEmail1

Parameters¶

Attachments¶

The AttachmentHandlers parameter format is:

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

• Entries are separated by ;

• Within each entry, the file name and handler GUID are separated by :

• Handler GUIDs must correspond to valid, unexpired upload handlers

• After a successful call, the upload handlers are automatically deleted from the server

Response¶

Success Response¶

<response success="true" error="" DocumentID="1051" DocumentName="Meeting-Notes.EMAIL" />

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>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

RegisterEmail with one more thing it can set: keywords.

const root = await call('RegisterEmail1', {
  authenticationTicket: ticket,
  TargetPath: '/Finance/Emails/2026-09-supplier-query',   // the document path, without .email
  Senders: 'supplier@example.com',
  Recipients: 'accounts@example.com',
  CCAddress: '',
  BCCAddress: '',
  SentDate: '2026-09-01',
  Subject: 'Invoice query',
  header: '',
  htmlBody: '<p>Could you check invoice 4471?</p>',
  textBody: 'Could you check invoice 4471?',
  AttachmentHandlers: '',
  keywords: 'invoice,supplier'
});

Keywords are comma-separated and a keyword may contain spaces, exactly as GetDocumentKeywords reads them back.

Which of the four to use¶

Prefer RegisterEmail2. The first two take a single TargetPath which is the path of the document to create, not the folder to put it in - so aiming one at a folder writes the document beside that folder, named after it. RegisterEmail2 takes the folder and the name separately and cannot be got wrong that way.

.email is appended to the name unless it already ends with it, and the document is dated from SentDate rather than from now.

Notes¶

• This API is identical to RegisterEmail with the addition of the keywords parameter. All behavior, error conditions, and response attributes are the same.

• The keywords value is stored as the document's user-defined keywords and is searchable via the standard search APIs.

• The document name is taken from the last path segment of TargetPath. The parent folder path must already exist.

• If the document name is exactly .EMAIL, the system automatically prepends the generated document ID to create a unique name.

• Email documents are stored with PercentComplete=100 (completed) and are not subject to the checkout/lock workflow.

• The document's creation date and modification date are set to SentDate. The completion date is set to the current server time.

• Duplicate detection: If a document with the same name and the same email Message-ID header already exists in the target folder, the call fails to prevent duplicate registrations.

• After a successful call, all referenced upload handlers are automatically deleted from the server.

Related APIs¶

• RegisterEmail - Register an email without keywords

• RegisterEmail2 - Register an email with folder path and document name as separate parameters

• RegisterEmail3 - Register an email using an XML parameter envelope

• CreateUploadHandler - Create an upload handler for pre-uploading email attachments

• UploadFileChunk - Upload file content in chunks to an upload handler

• GetDocument - Get the properties of the registered email document

• UpdateDocumentKeywords - Update keywords on an existing document

Error Codes¶

The errorCode values this operation returns, checked against a running server: