API Module Email Templates searchEmailTemplateRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Using PHP class)
 
(11 intermediate revisions not shown)
Line 15: Line 15:
*id
*id
*name
*name
-
*group  
+
*[[API Format group|group]]
-
*limit ''default value: 100''
+
*[[API Format tags|tags]]
-
*offset ''default value: 0''
+
*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'')
 +
*[[API Format Offset|offset]] (''default value: 0'')
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 23: Line 24:
* id
* id
|}
|}
 +
 +
==Additional Info==
 +
 +
Group is the Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails).
 +
==Examples==
==Examples==
Line 31: Line 37:
   ->setArgs([
   ->setArgs([
         'group' => 'ive',
         'group' => 'ive',
-
        'isActive' => true,
 
-
        'isDefault' => true,
 
     ]);
     ]);
===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>
 +
  <searchEmailTemplateRequest>
 +
    <group>ive</group>
 +
    <limit>1</limit>
 +
    <offset>0</offset>
 +
  </searchEmailTemplateRequest>
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
  <openXML>
 +
    <reply>
 +
      <nowiki><code>0</code></nowiki>
 +
      <desc></desc>
 +
      <data>
 +
        <results>
 +
          <array>
 +
            <item>
 +
              <id>733</id>
 +
              <name>Custom Template (en_GB)</name>
 +
              <group>ive</group>
 +
              <isDefault></isDefault>
 +
              <isActive>1</isActive>
 +
              <tags/>
 +
              <fields>
 +
                <array>
 +
                  <item>
 +
                    <name>body</name>
 +
                    <value>Body of the email</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>reminderBody</name>
 +
                    <value>Body of reminder email</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>subject</name>
 +
                    <value>Request for e-mail address verification</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>reminderSubject</name>
 +
                    <value>[REMINDER] Request for e-mail address verification</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>confirmUrl</name>
 +
                    <value>http://icann-verification.registrar.eu/?email=%%email%%&amp;authCode=%%authCode%%</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>resellerName</name>
 +
                    <value>MyCompany</value>
 +
                  </item>
 +
                  <item>
 +
                    <name>senderEmail</name>
 +
                    <value>support@mycompany.net</value>
 +
                  </item>
 +
                </array>
 +
              </fields>
 +
              <locale>
 +
                <array>
 +
                  <item>en_GB</item>
 +
                </array>
 +
              </locale>
 +
            </item>
 +
          </array>
 +
        </results>
 +
        <total>5</total>
 +
      </data>
 +
    </reply>
 +
  </openXML>

Current revision as of 08:29, 28 November 2025

Contents

Module Email Templates > Search

Module Email Templates
Command name searchEmailTemplateRequest
Use Returns a list of email templates matching search criteria
Input
Output
  • id

Additional Info

Group is the Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails).


Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchEmailTemplateRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs([
       'group' => 'ive',
    ]);

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>
  <searchEmailTemplateRequest>
    <group>ive</group>
    <limit>1</limit>
    <offset>0</offset>
  </searchEmailTemplateRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
  <openXML>
    <reply>
      <code>0</code>
      <desc></desc>
      <data>
        <results>
          <array>
            <item>
              <id>733</id>
              <name>Custom Template (en_GB)</name>
              <group>ive</group>
              <isDefault></isDefault>
              <isActive>1</isActive>
              <tags/>
              <fields>
                <array>
                  <item>
                    <name>body</name>
                    <value>Body of the email</value>
                  </item>
                  <item>
                    <name>reminderBody</name>
                    <value>Body of reminder email</value>
                  </item>
                  <item>
                    <name>subject</name>
                    <value>Request for e-mail address verification</value>
                  </item>
                  <item>
                    <name>reminderSubject</name>
                    <value>[REMINDER] Request for e-mail address verification</value>
                  </item>
                  <item>
                    <name>confirmUrl</name>
                    <value>http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%</value>
                  </item>
                  <item>
                    <name>resellerName</name>
                    <value>MyCompany</value>
                  </item>
                  <item>
                    <name>senderEmail</name>
                    <value>support@mycompany.net</value>
                  </item>
                </array>
              </fields>
              <locale>
                <array>
                  <item>en_GB</item>
                </array>
              </locale>
            </item>
          </array>
        </results>
        <total>5</total>
      </data>
    </reply>
  </openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Email_Templates_searchEmailTemplateRequest"
Views
Personal tools