xdmp.email

xdmp.emailxdmpemail

/apidoc/8.0/xdmp:email.xml

Send an email in an XQuery program. A valid SMTP Relay must be configured in the Groups page of the Admin Interface for the email to be sent. The format of the email message must be an XML file that complies with the schema files listed below.

An XML representation of an email message to send. The message must comply with the XML schemas defined in the following schema files:

install_dir/Config/email-xml.xsd
install_dir/Config/rfc822.xsd

where install_dir is the directory in which MarkLogic Server is installed.

message

Node

null http://marklogic.com/xdmp/privileges/xdmp-email

// This example demonstrates sending a message with
// HTML content.
  
xdmp.email(xdmp.unquote(
'<em:Message\n\
 xmlns:em="URN:ietf:params:email-xml:"\n\
 xmlns:rf="URN:ietf:params:rfc822:">\n\
  <rf:subject>Sample HTML Email</rf:subject>\n\
  <rf:from>\n\
    <em:Address>\n\
      <em:name>MarkLogic</em:name>\n\
      <em:adrs>marklogic@yourdomain</em:adrs>\n\
    </em:Address>\n\
  </rf:from>\n\
  <rf:to>\n\
    <em:Address>\n\
      <em:name>System Administrator</em:name>\n\
      <em:adrs>admin@yourdomain</em:adrs>\n\
    </em:Address>\n\
  </rf:to>\n\
  <em:content>\n\
    <html xmlns="http://www.w3.org/1999/xhtml">\n\
      <head>\n\
        <title>Test HTML message</title>\n\
      </head>\n\
      <body>\n\
        <h1>Test HTML message</h1>\n\
        <p>Here is a simple paragraph</p>\n\
      </body>\n\
    </html>\n\
  </em:content>\n\
</em:Message>').next().value.root)

// This example demonstrate sending a message with
// plain text content.

xdmp.email(xdmp.unquote(
'<em:Message\n\
 xmlns:em="URN:ietf:params:email-xml:"\n\
 xmlns:rf="URN:ietf:params:rfc822:">\n\
  <rf:subject>Sample Plain Text Email</rf:subject>\n\
  <rf:from>\n\
    <em:Address>\n\
      <em:name>MarkLogic</em:name>\n\
      <em:adrs>marklogic@yourdomain</em:adrs>\n\
    </em:Address>\n\
  </rf:from>\n\
  <rf:to>\n\
    <em:Address>\n\
      <em:name>System Administrator</em:name>\n\
      <em:adrs>admin@yourdomain</em:adrs>\n\
    </em:Address>\n\
  </rf:to>\n\
  <em:content xml:space="preserve">\n\
This is a sample email with a plain text body.\n\
</em:content>\n\
</em:Message>').next().value.root)

// This example demonstrates sending a message with
// attachments.

var newline = "\n";
var boundary = fn.concat("blah", xdmp.random());
var contentType = fn.concat("multipart/mixed; boundary=", boundary);
var attachment1 = xs.base64Binary(
		cts.doc("/space/binaries/testdata1/Bon-Jovi.jpeg"));
var attachment2 = xs.base64Binary(
		cts.doc("/space/binaries/testdata1/logo.gif"));
var content = fn.concat(
  "--", boundary, newline, newline,
  "This is a test email with two images attached.", newline,
  "--", boundary, newline,
  "Content-Type: image/jpeg", newline,
  "Content-Disposition: attachment; filename=Bon-Jovi.jpeg", newline,
  "Content-Transfer-Encoding: base64", newline,
  newline, attachment1, newline,
  "--", boundary, newline,
  "Content-Type: image/gif", newline,
  "Content-Disposition: attachment; filename=logo.gif", newline,
  "Content-Transfer-Encoding: base64", newline,
  newline,
  attachment2, newline,
  "--", boundary,"--", newline);
xdmp:email(xdmp.unquote(
'  <em:Message\n\
    xmlns:em="URN:ietf:params:email-xml:"\n\
    xmlns:rf="URN:ietf:params:rfc822:">\n\
    <rf:subject>Sample Email</rf:subject>\n\
    <rf:from>\n\
      <em:Address>\n\
        <em:name>MarkLogic</em:name>\n\
        <em:adrs>marklogic@yourdomain</em:adrs>\n\
      </em:Address>\n\
    </rf:from>\n\
    <rf:to>\n\
      <em:Address>\n\
        <em:name>System Administrator</em:name>\n\
        <em:adrs>admin@yourdomain</em:adrs>\n\
      </em:Address>\n\
    </rf:to>\n\
    <rf:content-type>'
    + contentType + '</rf:content-type>\n\
    <em:content xml:space="preserve">'
    +  content
  +  '</em:content>\n\
  </em:Message>').next().value.root)