<doc>
	<legacy_id></legacy_id>
	<name>mobileComposeHtmlMail</name>
	<type>command</type>

	<syntax>
		<example>mobileComposeHtmlMail <i>subject, </i>[<i>recipients, </i>[<i>ccs, </i>[<i>bccs, </i>[<i>body, </i>[<i>attachments</i>]]]]]</example>
	</syntax>

	<synonyms>
		<synonym>iphoneComposeHtmlMail</synonym>
	</synonyms>

	<summary>Opens a new email message in the user's email program.</summary>

	<examples>
<example>mobileComposeHtmlMail &quot;Test E-mail&quot;, &quot;guido@example.net&quot;,,, &quot;This is the bold &lt;b&gt;e-mail body&lt;/b&gt; text&quot;, tAttachment</example>
<example>mobileComposeHtmlMail &quot;Help&quot;, &quot;help@example.com&quot;,,,field &quot;Message&quot;</example>
<example><p>put &quot;Hello World!&quot; into tAttachment[&quot;data&quot;]</p><p>put &quot;text/plain&quot; into tAttachment[&quot;type&quot;]</p><p>put &quot;Greetings.txt&quot; into tAttachment[&quot;name&quot;]</p><p>mobileComposeHtmlMail &quot;Greetings&quot;, &quot;test@runrev.com&quot;,,,, tAttachment</p></example>
	</examples>

	<history>
		<introduced version="4.6">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		<changed version="4.6.1">4.6.1</changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Networks &amp; Communication</category>
		<category>Standalone Applications</category>
	</classification>

	<references>
		<command tag="revGoURL">revGoURL Command</command>
		<command tag="revMailUnicode">revMailUnicode Command</command>
		<command tag="revMail">revMail Command</command>
		<command tag="mobileComposeUnicodeMail">mobileComposeUnicodeMail Command</command>
		<command tag="mobileComposeMail">mobileComposeMail Command</command>
	</references>

	<description>
	<overview>Use the <b>mobileComposeHtmlMail</b> <glossary tag="command">command</glossary> to create an HTML email message with attachments from within a <object tag="stack">stack on iOS or Android</object>. </overview>

		<parameters>
  <parameter>
    <name>subject</name>
    <description>The subject line of the email.</description>
  </parameter>
  <parameter>
    <name>recipients</name>
    <description>A comma delimited list of email addresses to be placed in the 'To' field.</description>
  </parameter>
  <parameter>
    <name>ccs</name>
    <description>A comma delimited list of email addresses to be placed in the 'CC' field.</description>
  </parameter>
  <parameter>
    <name>bccs</name>
    <description>A comma delimited list of email addresses to be placed in the 'BCC' field.</description>
  </parameter>
  <parameter>
    <name>body</name>
    <description>The HTML body text of the email.</description>
  </parameter>
  <parameter>
    <name>attachments</name>
    <description>Either empty to send no attachments, a single attachment array or a one-based numeric array of attachment arrays to include. The attachments parameter consists of either a single array, or an array of arrays listing the attachments to include. A single attachment array should consist of the following keys:</description>
    <options title="">
      <option>
        <item>data</item>
        <description>The binary data to attach to the email (not needed if a file is present).</description>
      </option>
      <option>
        <item>file</item>
        <description>The filename of the file on disk to attach to the email (not needed if data present).</description>
      </option>
    </options>
  </parameter>		</parameters>

	<value>Upon completion of a compose request, the result is set to one of the following:<p>* sent - the email was sent successfully</p><p>* cancel - the email was not sent, and the user elected not to save it for later</p></value>
	<comments>This command interfaces with the iOS and Android mail composition interface<p></p><p>If you specify a file for the attachment, the engine tries to use the least amount of memory by asking the operating system to only load it from disk when the file is needed. Therefore, using <b>mobileComposeHtmlMail</b> should be the preferred method when attaching large amounts of data to an e-mail.</p><p>For example, sending multiple attachments may be done like this:</p><p></p><p>put &quot;Hello World!&quot; into tAttachments[1][&quot;data&quot;]</p><p>put &quot;text/plain&quot; into tAttachments[1][&quot;type&quot;]</p><p>put &quot;Greetings.txt&quot; into tAttachments[1][&quot;name&quot;]</p><p>put &quot;Goodbye World!&quot; into tAttachments[2][&quot;data&quot;]</p><p>put &quot;text/plain&quot; into tAttachments[2][&quot;type&quot;]</p><p>put &quot;Farewell.txt&quot; into tAttachments[2][&quot;name&quot;]</p><p><b>mobileComposeHtmlMail</b> tSubject, tTo, tCCs, tBCCs, tBody, tAttachments</p><p></p><p></p><p>Some devices are not configured with e-mail sending capability. To determine if the current device is, use the <function tag="mobileCanSendMail">mobileCanSendMail</function> function. This returns true if the mail client is configured.</p><p></p><p></p><note>Once the <b>mobileComposeHtmlMail</b> command is called, you have no more control over what the user does with the message. They are free to modify the message and the addresses as they see fit.</note></comments>
	</description>
</doc>