mail.send
=========

Sends mail using configured mail settings.

This method is a job.

*This job CAN be used with file upload.* See :ref:`uploading-files`.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: message</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>message</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Email message content and configuration.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_subject"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_subject"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_subject" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_subject" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_subject')" type="button"><span class="property-name">subject</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_subject" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_subject" id="Call_parameters_items_i0_subject"> <div class="card-body pl-5"> <h4>Subject</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Subject line for the email message.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_text"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_text"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_text" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_text" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_text')" type="button"><span class="property-name">text</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_text" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_text" id="Call_parameters_items_i0_text"> <div class="card-body pl-5"> <h4>Text</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Formatted to HTML using Markdown and rendered using default email template.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_html"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_html"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_html" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_html" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_html')" type="button"><span class="property-name">html</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_html" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_html" id="Call_parameters_items_i0_html"> <div class="card-body pl-5"> <h4>Html</h4><br/> <span class="description"><p>Custom HTML (overrides <code>text</code>). If null, no HTML MIME part will be added to the email.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_html_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_html_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_html_anyOf_i0" id="Call_parameters_items_i0_html_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_html_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_html_anyOf_i1" id="Call_parameters_items_i0_html_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_html_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_html_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_html_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_to"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_to"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_to" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_to" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_to')" type="button"><span class="property-name">to</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_to" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_to" id="Call_parameters_items_i0_to"> <div class="card-body pl-5"> <h4>To</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Email recipients. Defaults to all local administrators.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0_to_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_cc"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_cc"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_cc" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_cc" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_cc')" type="button"><span class="property-name">cc</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_cc" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_cc" id="Call_parameters_items_i0_cc"> <div class="card-body pl-5"> <h4>Cc</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Email CC recipients, if any.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0_cc_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_interval"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_interval"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_interval" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_interval" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_interval')" type="button"><span class="property-name">interval</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_interval" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_interval" id="Call_parameters_items_i0_interval"> <div class="card-body pl-5"> <h4>Interval</h4><br/> <span class="description"><p>In seconds.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_interval_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_interval_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interval_anyOf_i0" id="Call_parameters_items_i0_interval_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_interval_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interval_anyOf_i1" id="Call_parameters_items_i0_interval_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_interval_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_interval_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_interval_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_channel"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_channel"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_channel" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_channel" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_channel')" type="button"><span class="property-name">channel</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_channel" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_channel" id="Call_parameters_items_i0_channel"> <div class="card-body pl-5"> <h4>Channel</h4><br/> <span class="description"><p>Defaults to "truenas".</p> </span><div class="any-of-value" id="Call_parameters_items_i0_channel_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_channel_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_channel_anyOf_i0" id="Call_parameters_items_i0_channel_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_channel_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_channel_anyOf_i1" id="Call_parameters_items_i0_channel_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_channel_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_channel_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_channel_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_timeout"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_timeout"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_timeout')" type="button"><span class="property-name">timeout</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_timeout" id="Call_parameters_items_i0_timeout"> <div class="card-body pl-5"> <h4>Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 300</span><br/> <span class="description"><p>Time limit for connecting to the SMTP server in seconds.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_attachments"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_attachments"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_attachments" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_attachments" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_attachments')" type="button"><span class="property-name">attachments</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_attachments" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_attachments" id="Call_parameters_items_i0_attachments"> <div class="card-body pl-5"> <h4>Attachments</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>If set to true, an array compromised of the following object is required via HTTP upload:</p> <ul> <li><p>headers <em>(array)</em></p> <ul> <li>name <em>(string)</em></li> <li>value <em>(string)</em></li> <li>params <em>(object)</em></li> </ul></li> <li><p>content <em>(string)</em></p></li> </ul> <p>Example:<br/> [<br/> {<br/> "headers": [<br/> {<br/> "name": "Content-Transfer-Encoding",<br/> "value": "base64"<br/> },<br/> {<br/> "name": "Content-Type",<br/> "value": "application/octet-stream",<br/> "params": {<br/> "name": "test.txt"<br/> }<br/> }<br/> ],<br/> "content": "dGVzdAo="<br/> }<br/> ]</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_queue"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_queue"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_queue" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_queue" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_queue')" type="button"><span class="property-name">queue</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_queue" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_queue" id="Call_parameters_items_i0_queue"> <div class="card-body pl-5"> <h4>Queue</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/> <span class="description"><p>Queue the message to be sent later if it fails to send.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_extra_headers"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_extra_headers"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_extra_headers" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_extra_headers" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_extra_headers')" type="button"><span class="property-name">extra_headers</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_extra_headers" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_extra_headers" id="Call_parameters_items_i0_extra_headers"> <div class="card-body pl-5"> <h4>Extra Headers</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Any additional headers to include in the email message.</p> </span> </div> </div> </div> </div> </div> </div> <h5>Parameter 2: config</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>config</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Optional mail configuration overrides for this message.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_fromemail"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_fromemail"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_fromemail" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_fromemail" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_fromemail')" type="button"><span class="property-name">fromemail</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_fromemail" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_fromemail" id="Call_parameters_items_i1_fromemail"> <div class="card-body pl-5"> <h4>Fromemail</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The sending address that the mail server will use for sending emails.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_fromname"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_fromname"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_fromname" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_fromname" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_fromname')" type="button"><span class="property-name">fromname</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_fromname" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_fromname" id="Call_parameters_items_i1_fromname"> <div class="card-body pl-5"> <h4>Fromname</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Display name that will appear as the sender name in outgoing emails.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_outgoingserver"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_outgoingserver"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_outgoingserver" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_outgoingserver" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_outgoingserver')" type="button"><span class="property-name">outgoingserver</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_outgoingserver" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_outgoingserver" id="Call_parameters_items_i1_outgoingserver"> <div class="card-body pl-5"> <h4>Outgoingserver</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Hostname or IP address of the SMTP server used for sending emails.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_port"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_port"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_port" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_port" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_port" id="Call_parameters_items_i1_port"> <div class="card-body pl-5"> <h4>Port</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>TCP port number for the SMTP server connection.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_security"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_security"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_security" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_security" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_security')" type="button"><span class="property-name">security</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_security" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_security" id="Call_parameters_items_i1_security"> <div class="card-body pl-5"> <h4>Security</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Type of encryption.</p> </span><div class="enum-value" id="Call_parameters_items_i1_security_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"PLAIN"</li><li class="list-group-item enum-item">"SSL"</li><li class="list-group-item enum-item">"TLS"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_smtp"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_smtp"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_smtp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_smtp" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_smtp')" type="button"><span class="property-name">smtp</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_smtp" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_smtp" id="Call_parameters_items_i1_smtp"> <div class="card-body pl-5"> <h4>Smtp</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Whether SMTP authentication is enabled and <code>user</code>, <code>pass</code> are required.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_user"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_user"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_user" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_user" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_user')" type="button"><span class="property-name">user</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_user" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_user" id="Call_parameters_items_i1_user"> <div class="card-body pl-5"> <h4>User</h4><br/> <span class="description"><p>SMTP username.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_user_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_user_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_user_anyOf_i0" id="Call_parameters_items_i1_user_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_user_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_user_anyOf_i1" id="Call_parameters_items_i1_user_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_user_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_user_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_user_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_pass"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_pass"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_pass" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_pass" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_pass')" type="button"><span class="property-name">pass</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_pass" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_pass" id="Call_parameters_items_i1_pass"> <div class="card-body pl-5"> <h4>Pass</h4><br/> <span class="description"><p>SMTP password.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_pass_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_pass_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_pass_anyOf_i0" id="Call_parameters_items_i1_pass_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_pass_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_pass_anyOf_i1" id="Call_parameters_items_i1_pass_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_pass_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_pass_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_pass_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oauth"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oauth"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oauth" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oauth" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oauth')" type="button"><span class="property-name">oauth</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oauth" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oauth" id="Call_parameters_items_i1_oauth"> <div class="card-body pl-5"> <h4>Oauth</h4><br/> <span class="description"><p>OAuth configuration for email providers that support it or <code>null</code> for basic authentication.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_oauth_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oauth_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oauth_anyOf_i0" id="Call_parameters_items_i1_oauth_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i0')" role="tab">MailEntryOAuth</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oauth_anyOf_i1" id="Call_parameters_items_i1_oauth_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i1')" role="tab">EmptyDict</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oauth_anyOf_i2" id="Call_parameters_items_i1_oauth_anyOf_i2" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i2')" role="tab">Option 3</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_oauth_anyOf_i0" role="tabpanel"> <h4>MailEntryOAuth</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_oauth_anyOf_i0_provider"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oauth_anyOf_i0_provider"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oauth_anyOf_i0_provider" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oauth_anyOf_i0_provider" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i0_provider')" type="button"><span class="property-name">provider</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oauth_anyOf_i0_provider" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oauth_anyOf_i0_provider" id="Call_parameters_items_i1_oauth_anyOf_i0_provider"> <div class="card-body pl-5"> <h4>Provider</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>An email provider, e.g. "gmail", "outlook".</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oauth_anyOf_i0_client_id"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oauth_anyOf_i0_client_id"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oauth_anyOf_i0_client_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oauth_anyOf_i0_client_id" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i0_client_id')" type="button"><span class="property-name">client_id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oauth_anyOf_i0_client_id" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oauth_anyOf_i0_client_id" id="Call_parameters_items_i1_oauth_anyOf_i0_client_id"> <div class="card-body pl-5"> <h4>Client Id</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>OAuth client ID provided by the email provider.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oauth_anyOf_i0_client_secret"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oauth_anyOf_i0_client_secret"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oauth_anyOf_i0_client_secret" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oauth_anyOf_i0_client_secret" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i0_client_secret')" type="button"><span class="property-name">client_secret</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oauth_anyOf_i0_client_secret" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oauth_anyOf_i0_client_secret" id="Call_parameters_items_i1_oauth_anyOf_i0_client_secret"> <div class="card-body pl-5"> <h4>Client Secret</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>OAuth client secret provided by the email provider.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oauth_anyOf_i0_refresh_token"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oauth_anyOf_i0_refresh_token"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oauth_anyOf_i0_refresh_token" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oauth_anyOf_i0_refresh_token" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oauth_anyOf_i0_refresh_token')" type="button"><span class="property-name">refresh_token</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oauth_anyOf_i0_refresh_token" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oauth_anyOf_i0_refresh_token" id="Call_parameters_items_i1_oauth_anyOf_i0_refresh_token"> <div class="card-body pl-5"> <h4>Refresh Token</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>OAuth refresh token used to obtain new access tokens for email authentication.</p> </span> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_oauth_anyOf_i1" role="tabpanel"> <h4>EmptyDict</h4><span class="badge badge-dark value-type">Type: object</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_oauth_anyOf_i2" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>The message was sent successfully.</p> </span> </div> </div> </div> </div> </div><br><br>

*Required roles:* MAIL_WRITE

