Code Monkey home page Code Monkey logo

documentation's Introduction

Documentation

Here you can explore in detail our products, which include:

  • Publisher - all our Copernica documentation (not only Publisher!)
  • MailerQ - a high performance Mail Transfer Agent (MTA) designed for delivering large volume email messages at very high speeds
  • MS - documentation that is used inside our software (via the .documentationpage() jQuery plugin)
  • PHP-C++ - a C++ library for developing PHP extensions
  • PHP-JS - to execute JavaScript right from your PHP script and share variables between JavaScript and PHP
  • Responsive Email - an online service to create and send responsive HTML emails.
  • SMTPeter - to connect your app via SMTP or REST API and start sending emails through the cloud instead of your server

With Copernica you can deliver relevant and timely communications using email, sms, landing pages and PDF.

Working with documentation

Each top-level directory in this repository holds documentation for one specific product.

Documentation pages

Documentation pages can be written with HTML or Markdown. Thus, files written with Markdown will have priority over ones written with HTML.

Links and files

All links should be relative ones.

Internal links

Documentations pages can have internal links. Such links are created in HTML like fashion by adding hash part to the link.

Examples:

[Page on MailerQ](page#segment)

Internal links can reference headers. Identifiers to use inside such links are generated with use of text inside the header. Following steps will be applied to create identifier:

  1. convert every utf-8 characted into ascii character
  2. lowercase all characters
  3. replace all spaces with '-'

Special files

In each directory there should be two files: navigation.md and introduction.md. Both of those files are little bit special.

navigation.md

navigation.md should contain list of links to documentation topics. List can contain more lists.

introduction.md

introduction.md should contain introduction text for given documentation. Also, it will be a default page for documentation.

documentation's People

Contributors

aljar avatar ctvanoostwaard avatar damianwantzing avatar dannydijkzeul avatar derekcopernica avatar dr-taylor avatar emielbruijntjes avatar hamza-am100 avatar jeroencopernica avatar jeroenschuiten avatar jochemvd avatar joozt83 avatar kajzzer avatar laurahilhorst avatar mariannakv avatar mrbngle avatar mvdwerve avatar quancode avatar rafalgoslawski avatar raidiant avatar richard-hordijk avatar robkunst avatar sanderisbestok avatar selinablijleven avatar selinacopernica avatar semeleer avatar sliv9 avatar thijsvandiessen avatar thomaskamps avatar timscu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

Documentation issue with profiles & subprofiles

How do I update my data on a profiles subprofile?
The resource url's on both pages are very different and I don't know how to specifically update / PUT, for example, data for user 65 on subprofile 18, like I can with the post method.

Are the url's for the docs wrong or am I just missing something?
POST url: https://www.copernica.com/en/documentation/restv2/rest-post-profile-subprofiles
PUT url: https://www.copernica.com/en/documentation/restv2/rest-put-profile-subprofiles

Change to documentation/restv2/rest-php (REST API example)

There's an issue with the get() method vs. documentation/restv2/rest-fields-parameter:
You cannot pass a fields parameter into the example client and have it be handled correctly, because the '[]' part of 'fields[]' will always be encoded.

Replacement for the http_build_query() call: $this->encodeParams(), as in:

  /**
   * Converts parameters into an encoded string.
   *
   * An example of passing the 'fields' parameter into this function:
   * ['fields' => ['land==netherlands', 'age>16']]
   *
   * @param array $parameters
   *   An array with key-value pairs, where the value can also be an array. In
   *   the latter case, the key will be present multiple times in the resulting
   *   query string, as 'key[]'.
   *
   * @return string
   *   The encoded URL parameters, including a leading '?'.
   */
  private function encodeParams(array $parameters)
  {
      $encoded_parts = [];

      foreach ($parameters as $key => $value) {
          if (is_array($value)) {
              // This will come out as key[]=subvalue1&key[]=subvalue2; the
              // keys inside $value are ignored. The important thing here is
              // that the [] are NOT URL-encoded.
              foreach ($value as $subvalue) {
                  // Testing with a value containing spaces suggests that both
                  // urlencode() and rawurlencode() are good for Copernica.
                  $encoded_parts[] = rawurlencode($key) . '[]=' . rawurlencode($subvalue);
              }
          } else {
              $encoded_parts[] = rawurlencode($key) . '=' . rawurlencode($value);
          }
      }

      return $encoded_parts ? '?' . implode('&', $encoded_parts) : '';
  }

smtp logins not working

smtp logins not working

showing the following error

Transaction failed. The server response was: 5.7.1 Relay access denied

docs proper not updated to troubleshoot

update EmptyExtension.tar.gz

The Makefile is different in the downloadable demo archive from the example on this page: https://www.php-cpp.com/documentation/your-first-extension

The demo archive seems to contain an older version only for php 5.

Here's the actual diff:

 #
 #   Php.ini directories
 #
@@ -28,9 +27,22 @@ NAME             =   yourextension
 #   PHP installations use a conf.d directory that holds a set of config files,
 #   one for each extension. Use this variable to specify this directory.
 #
+#   In Ubuntu 14.04 Apache 2.4 is used, which uses the mods-available directory
+#   instead of a conf.d directory. In 16.04 the directory changed yet again.
+#   This has to be checked.
+#
 
-INI_DIR                =   /etc/php5/conf.d
+UBUNTU_MAJOR  := $(shell /usr/bin/lsb_release -r -s | cut -f1 -d.)
+OVER_SIXTEEN  := $(shell echo "${UBUNTU_MAJOR} >= 16" | bc)
+OVER_FOURTEEN := $(shell echo "${UBUNTU_MAJOR} >= 14" | bc)
 
+ifeq (${OVER_SIXTEEN}, 1)
+    INI_DIR     =   /etc/php/7.0/mods-available/
+else ifeq (${OVER_FOURTEEN}, 1)
+    INI_DIR     =   /etc/php5/mods-available/
+else
+    INI_DIR     =   /etc/php5/conf.d/
+endif

Feature request: Select profiles from database with id OR email.

Currently I'm able to select profiles based on their unique ID or their Email.

My flow now requires that I get alle profiles with either the given ID or Email.
For example:

        $parameters = array(
            'limit'     =>  1000,
            'fields'    =>  array(
                'rw_id==123',
                '[email protected]'
            )
        );

If the profile with ID 123 does not have [email protected] than it will not show in the response data.

If this is already possible, please let me how.

I followed the below documentation.
https://www.copernica.com/nl/documentation/restv2/rest-fields-parameter

REST API mailings documentation issues.

Sorry, no PR.

I just noticed a difference in the return value between https://www.copernica.com/en/documentation/restv2/rest-get-publisher-emailings and https://www.copernica.com/en/documentation/restv2/rest-get-publisher-emailings -- in v3 these are missing in the docs:

* errors: Number of errors for this mailing
* unsubscribes: Number of unsubscribes for this mailing
* abuses: Number of abuses for this mailing

...however they are actually returned. Not sure if they were deleted by accident, or restored in a later version or v3, or ....

The "publisher/destinations" call (i.e. a full list of destinations from/to a certain date) works, but is not documented in the list at https://www.copernica.com/en/documentation/restv3/rest-api.

This unlike the "ms/destinations" call which is documented.

(AFAICT this call is fairly crucial for getting MS statistics and less crucial for Publisher, but it's still nice to know it exists.
Though I could also be wrong on the "less crucial" part; getting to know the differences between the two systems, is a bit of a challenge at first sight :) )

Question re. documented HTTP 204.

(OK, I think this is my last question.)

https://www.copernica.com/en/documentation/restv2/rest-requests says

DELETE requests can also result in a "204 No Content" response in case the data that was meant to be deleted could not be located.

... and I don't see that. Maybe there are some entities where this is true (I'm just testing profiles and subprofiles), but I see a HTTP 400 with a standard JSON 'error/message' body being returned. (Containing either "This profile has already been removed" or "No profile with supplied ID".)

Maybe that particular edit in #f32cbca was only meant for v1 of the API? (In that case, it seems like that sentence can just be deleted... because the message about the 400 response is still on the page.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.