API Module Email Templates deleteEmailTemplateRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Email Templates > Delete== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Email Templates |- style="background-color:#EEEEEE;" |'''Com…')
(→Module Email Templates > Delete)
 
(4 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Deletes an email template.
+
|Delete existing email template
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 26: Line 26:
     ->setAuth(array('username' => 'username', 'password' => 'password'))
     ->setAuth(array('username' => 'username', 'password' => 'password'))
     ->setArgs([
     ->setArgs([
-
         'name' => 'Demo template',
+
         'id' => 1409,
-
        'group' => 'ive',
+
      ]);
-
        'isDefault' => true,
+
-
        'isActive' => true,
+
-
        'locale' => ['nl_NL'],
+
-
        'fields' => [
+
-
            [
+
-
                'name' => 'senderEmail',
+
-
                'value' => 'myemail@mycompany.eu',
+
-
            ],
+
-
            [
+
-
                'name' => 'confirmUrl',
+
-
                'value' => 'http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%',
+
-
            ],
+
-
            [
+
-
                'name' => 'resellerName',
+
-
                'value' => 'demo Co',
+
-
            ],
+
-
            [
+
-
                'name' => 'subject',
+
-
                'value' => 'Initial E-mail verification',
+
-
            ],
+
-
            [
+
-
                'name' => 'body',
+
-
                'value' => '%%confirmUrl%% and %%respondDate%%',
+
-
            ],
+
-
            [
+
-
                'name' => 'reminderSubject',
+
-
                'value' => 'Email verification reminder',
+
-
            ],
+
-
            [
+
-
                'name' => 'reminderBody',
+
-
                'value' => '%%confirmUrl%% and %%respondDate%%',
+
-
            ],
+
-
        ],
+
-
    ]);
+
===Raw XML===
===Raw XML===
''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.''
''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.''
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <credentials>
 +
    <username>username</username>
 +
    <password>password</password>
 +
  </credentials>
 +
  <deleteEmailTemplateRequest>
 +
    <id>1404</id> 
 +
  </deleteEmailTemplateRequest>
 +
</openXML>
 +
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
    <nowiki><code>0</code></nowiki>
 +
    <desc></desc>
 +
    <data>1</data>
 +
  </reply>
 +
  </openXML>

Current revision as of 12:27, 17 June 2016

Contents

Module Email Templates > Delete

Module Email Templates
Command name deleteEmailTemplateRequest
Use Delete existing email template
Input
  • id
Output
  • -

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('createEmailTemplateRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs([
       'id' => 1409,
     ]);

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
 <credentials>
   <username>username</username>
   <password>password</password>
 </credentials>
 <deleteEmailTemplateRequest>
   <id>1404</id>   
 </deleteEmailTemplateRequest>
</openXML>



<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>1</data>
  </reply>
 </openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Email_Templates_deleteEmailTemplateRequest"
Views
Personal tools