doc.arkadia.com

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== <#share_url_by_email> ======

Use this function to send an url link via email. This function will be typically called from 
[[en:public:developer:template_system:cfgpages]]. 

==== Parameters ====

Parameters taken from the tag

^ Name                                                        ^ Mandatory ^ Description       ^       
| <html><span style="color:#008000">Privatekey</span></html>  | Yes       | The [[http://www.google.com/recaptcha|ReCaptcha]] private key |
| <html><span style="color:#008000">Template</span></html>    | Yes       | The mail template |

Parameters taken from HTTP GET/Post data

^ Name                                                                    ^ Mandatory ^ Description       ^       
| <html><span style="color:#008000">Recaptcha_challenge</span></html>     | Yes       | The value of "recaptcha_challenge_field" sent via the form |
| <html><span style="color:#008000">Recaptcha_response</span></html>      | Yes       | The value of "recaptcha_response_field" sent via the form |
| <html><span style="color:#008000">Url</span></html>                     | No        | The url to share. If empty the current url will be taken |
| <html><span style="color:#008000">From</span></html>                    | Yes       | the sender email |
| <html><span style="color:#008000">To</span></html>                      | Yes       | the recipient email |

==== Error Codes ====

^ Code                                                ^ Description ^       
| <html><span style="color:#008000">122</span></html> | Wrong Captcha|

==== Example ====

Exemple of the template :

<code html>

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  </head>
  <body>
    <#if condition="<#AMRequest.values['Url'] checksum=1>">
      <a href="<#AMRequest.values['Url']>"><#AMRequest.values['Url']></a><br />
    <#else>
      <a href="<#Url>"><#Url></a><br />
    <#endif>
    
    <#if condition="<#AMRequest.values['message'] checksum=1>">
      <br />
      <#AMRequest.values['message']><br />
    <#endif>
    
    <br />
    <br />
    
    Message sent via <#url id=/>     
  </body>
</html>

</code>

Exemple of [[en:public:developer:template_system:cfgpages]] configuration node

<code xml>

<page name="share_url_by_email">
  <cfg>
    <frames>
      <frame name="content" 
             processname="share_url_by_email" 
             privatekey="...." 
             template="emails\email_share_url_by_email.&lt;#language&gt;.html"/>
    </frames>
    <maintemplate>maintemplates\maintemplate_empty.html</maintemplate>
    <content_type>&lt;#content_type&gt;</content_type>
  </cfg>
</page>

</code>

Exemple of API call

<code javascript>

  ak_call_api("/api/share_url_by_email/",  /* the api url */
              {
               From: "me@exemple.com",
               To: "you@exemple.com",
               Message: "my message",
               Recaptcha_challenge: Recaptcha.get_challenge(), 
               Recaptcha_response: Recaptcha.get_response()
              }, /* the post params */
              ...
              );

</code>
doc.arkadia.com

User Tools

Site Tools

Page Tools
