.. _slb_template_smtp:

slb template smtp
=================

SMTP


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

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

	===================================== =================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3048_smtp_list`

	 **Collection URI**                    /axapi/v3/slb/template/smtp

	                                       

	 **Element Name**                      smtp

	 **Element URI**                       /axapi/v3/slb/template/smtp/{name}

	 **Element Attributes**                smtp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`smtp schema <slb-template-smtp/slb-template-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/slb/template/smtp



.. raw:: html

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


:ref:`3048_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/slb_template_smtp_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/smtp



.. raw:: html

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


:ref:`3048_smtp_attributes`



.. raw:: html

   </td><td></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/slb/template/smtp/{name}



.. raw:: html

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


:ref:`3048_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/slb_template_smtp_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/slb/template/smtp



.. raw:: html

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


:ref:`3048_smtp_list`



.. raw:: html

   </td><td></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/slb/template/smtp/{name}



.. raw:: html

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


:ref:`3048_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/slb/template/smtp/{name}



.. raw:: html

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


:ref:`3048_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/slb_template_smtp_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/slb/template/smtp



.. raw:: html

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


:ref:`3048_smtp_list`



.. raw:: html

   </td><td></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/slb/template/smtp/{name}



.. raw:: html

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


:ref:`3048_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/slb_template_smtp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3048_smtp_list:

smtp-list
---------


    smtp-list is **JSON List** of :ref:`3048_smtp_attributes` 

        smtp-list : [

             { :ref:`3048_smtp_attributes` },

             { :ref:`3048_smtp_attributes` },

             ...

         ]

.. _3048_smtp_attributes:

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

    **LF-to-CRLF**

        **Description** Change the LF to CRLF for smtp end of line

        **Type:** boolean

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

        **Default:** 0

    **client-domain-switching**

        **Type:** List

    **client-starttls-type**

        **Description** 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; 

        **Type:** string

        **Supported Values:** optional, enforced

    **command-disable**

        **Type:** List

    **error-code-to-client**

        **Description** Would transfer error code(554) to client, when getting it from connection establishing with real-server

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** SMTP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **server-domain**

        **Description** Config the domain of the email servers (Server's domain, default is "mail-server-domain")

        **Type:** string

        **Format:** host

        **Maximum Length:** 254 characters

        **Maximum Length:** 1 characters

        **Default:** mail-server-domain

    **server-starttls-type**

        **Description** 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; 

        **Type:** string

        **Supported Values:** optional, enforced

    **service-ready-msg**

        **Description** Set SMTP service ready message (SMTP service ready message, default is "ESMTP mail service ready")

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** ESMTP mail service ready

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`3048_template` 

        **Type:** Object

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3048_client-domain-switching:

client-domain-switching
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **match-string**

        **Description** Domain name string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **service-group**

        **Description** Select service group (Service group name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **switching-type**

        **Description** 'contains': Specify domain name string if domain contains another string; 'ends-with': Specify domain name string if domain ends with another string; 'starts-with': Specify domain string if domain starts with another string; 

        **Type:** string

        **Supported Values:** contains, ends-with, starts-with

.. _3048_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **logging**

        **Description** Logging template (Logging Config name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/logging <slb_template_logging>`

.. _3048_command-disable:

command-disable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **disable-type**

        **Description** 'expn': Disable SMTP EXPN commands; 'turn': Disable SMTP TURN commands; 'vrfy': Disable SMTP VRFY commands; 

        **Type:** string

        **Supported Values:** expn, turn, vrfy