RegisterEmail2 API¶

Registers an email message as a document in infoRouter, specifying the destination folder path and the email document name as two separate parameters instead of a combined path. This makes it convenient when the folder and file name are already available as distinct values. Behavior is otherwise identical to RegisterEmail1.

Endpoint¶

/srv.asmx/RegisterEmail2

Methods¶

• GET /srv.asmx/RegisterEmail2?AuthenticationTicket=...&FolderPath=...&EmailName=...&Senders=...&...

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

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

Parameters¶

RegisterEmail2 vs RegisterEmail1: The only structural difference is that TargetPath (a combined folder + file name path) is replaced by two separate parameters: FolderPath and EmailName. All email fields, attachment handling, keywords, responses, and error conditions are identical.

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/RegisterEmail2 HTTP/1.1

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

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

&FolderPath=/Finance/Emails

&EmailName=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/RegisterEmail2

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

  &FolderPath=/Finance/Emails

  &EmailName=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:RegisterEmail2>

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

      <tns:FolderPath>/Finance/Emails</tns:FolderPath>

      <tns:EmailName>Q1-Budget-Meeting.EMAIL</tns:EmailName>

      <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:RegisterEmail2>

  </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;
}

Files an e-mail as a document, taking the folder and the document name separately. This is the variant to reach for: the others take a single path that is the document's, not the folder's, which is easy to get wrong.

const root = await call('RegisterEmail2', {
  authenticationTicket: ticket,
  FolderPath: '/Finance/Emails',
  EmailName: '2026-09-supplier-query',       // .email is added
  Senders: 'supplier@example.com',
  Recipients: 'accounts@example.com',
  CCAddress: 'manager@example.com',
  BCCAddress: 'audit@example.com',
  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'
});

console.log(root.getAttribute('DocumentID'), root.getAttribute('DocumentName'));

The addresses are stored on the document as a SYSTBL_EMAIL property set, readable with GetDocument and withPropertySets=true. This variant stores CCAddress and BCCAddress correctly; RegisterEmail3 does not.

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¶

• FolderPath is the destination folder only -" do not include the document name. EmailName is the document name only -" do not include a folder path.

• EmailName must include the file extension. Pass .EMAIL as the name to have the system auto-generate a name using the document ID as a prefix.

• 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.

• Use RegisterEmail3 to pass all email parameters in a single XML string instead of individual parameters.

Related APIs¶

• RegisterEmail - Register an email using a combined TargetPath (no keywords)

• RegisterEmail1 - Register an email using a combined TargetPath with keywords

• 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

Error Codes¶

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