.. _smtp:

smtp
====

Configure SMTP Server


smtp Specification
------------------

	===================================== =============================================
	 **Parameter**                         **Value** 

	===================================== =============================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      smtp

	 **Element URI**                       /axapi/v3/smtp

	 **Element Attributes**                smtp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`smtp schema <smtp/smtp.txt>`
	===================================== =============================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/smtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`3077_smtp_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/smtp_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/smtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`3077_smtp_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/smtp_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/smtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`3077_smtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/smtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`3077_smtp_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/smtp_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/smtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`3077_smtp_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/smtp_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _3077_smtp_attributes:

smtp attributes
---------------

    **mailfrom**

        **Description** Configure email source address

        **Type:** string

        **Format:** email-addr

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **needauthentication**

        **Description** Configure SMTP server need authtication

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **port**

        **Description** Configure SMTP Port (Configure SMTP port, default is 25)

        **Type:** number

        **Range:** 1-65535

    **smtp-server**

        **Description** Configure SMTP Server (length:1-254)

        **Type:** string

        **Format:** host

        **Maximum Length:** 254 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** smtp-server and smtp-server-v6 are mutually exclusive

    **smtp-server-v6**

        **Description** Configure SMTP Server IPV6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** smtp-server-v6 and smtp-server are mutually exclusive

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **username-cfg**

        **Description:** username-cfg is a **JSON Block**.  Please see below for :ref:`3077_username-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3077_username-cfg:

username-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **password**

        **Description:** password is a **JSON Block**.  Please see below for :ref:`3077_username-cfg_password` 

        **Type:** Object

    **username**

        **Description** Configure SMTP login username

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _3077_username-cfg_password:

username-cfg_password
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **encrypted**

        **Description**  Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **smtp-password**

        **Description** Configure SMTP login password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters