diff --git a/guides-sms/_export-sms_stats.md b/guides-sms/_export-sms_stats.md index 40a5cd0..242901a 100644 --- a/guides-sms/_export-sms_stats.md +++ b/guides-sms/_export-sms_stats.md @@ -15,6 +15,29 @@ https://api.mailjet.com/v4/sms/export \ -H 'Content-Type: application/json' \ -d '{"FromTS": 1033552800, "ToTS": 1033574400}' ``` +```javascript +/** + * Create : Create a CSV export file with a list of SMS messages for a specific time period + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .post('sms', { version: 'v4' }) + .action('export') + .request({ + FromTS: 1033552800, + ToTS: 1033574400 + }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` A `POST` on the [`/sms/export`](/sms-api/v4/sms-export/) endpoint gives you the ability to request a CSV export file to be generated. With your request you are required to submit a specific timeframe using the `FromTS` and `ToTS` properties. @@ -56,6 +79,27 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms/export/$ID ``` +```javascript +/** + * View : Check the status of an export request and retrieve the download URL, if ready + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .action('export') + .id($ID) + .request() + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` Use `GET` on [`/sms/export/{RequestID}`](/sms-api/v4/sms-export/) to check the status of your export request, and to retrieve the download URL, once the export file is ready. diff --git a/guides-sms/_filtering-resources.md b/guides-sms/_filtering-resources.md index 1e30f74..0a62212 100644 --- a/guides-sms/_filtering-resources.md +++ b/guides-sms/_filtering-resources.md @@ -24,6 +24,25 @@ curl -s \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?Limit=100 ``` +```javascript +/** + * View : List of 100 SMS messages + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { Limit: 100 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` You can limit the number of results by applying the Limit filter. The default value is 10 and the maximum value is 1000. `Limit=0` delivers the maximum amount of results - 1000. @@ -39,6 +58,25 @@ curl -s \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?Offset=25000 ``` +```javascript +/** + * View : List of SMS messages with Offset, starting with the 25000th contact + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { Offset: 25000 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` You can use the Offset filter to retrieve a list starting from a certain offset.
@@ -50,6 +88,25 @@ curl -s \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?Limit=150\&Offset=25000 ``` +```javascript +/** + * View : List of SMS with Limit and Offset, retrieves a list of 150 SMS starting with the 25000th contact + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { Limit: 150, Offset: 25000 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` The Offset filter can be combined with the Limit filter. @@ -64,7 +121,25 @@ curl -s \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?FromTS=1519862400\&ToTS=1520640000 ``` - +```javascript +/** + * View : List of contacts sent between March 1st 2018 00:00 UTC and March 10th 2018 00:00 UTC + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { FromTS: 1519862400, ToTS: 1520640000 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` Use the `FromTS` and `ToTS` filters (Unix timestamp) to specify a time period, for which to retrieve the information you need. diff --git a/guides-sms/_getting-started.md b/guides-sms/_getting-started.md index a3f2972..3e2488b 100644 --- a/guides-sms/_getting-started.md +++ b/guides-sms/_getting-started.md @@ -41,6 +41,26 @@ curl -X POST \ "Text": "Hello World!" }' ``` +```javascript +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .post('sms-send', { version: 'v4' }) + .request({ + From: "InfoSMS", + To: "+33600000000", + Text: "Hello World!" + }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` Fill your sending information in the payload. Three properties are required: diff --git a/guides-sms/_send-sms-api.md b/guides-sms/_send-sms-api.md index 4287404..8ae321a 100644 --- a/guides-sms/_send-sms-api.md +++ b/guides-sms/_send-sms-api.md @@ -28,6 +28,29 @@ curl -X POST \ "From": "MJPilot" }' ``` +```javascript +/** + * Create : Send SMS Message to a selected recipient. + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .post('sms-send', { version: 'v4' }) + .request({ + From: "MJPilot", + To: "+33600000000", + Text: "Have a nice SMS flight with Mailjet !" + }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` In the code sample you can see a `POST` request with an Authorization header that includes the token value. diff --git a/guides-sms/_sms-stats.md b/guides-sms/_sms-stats.md index f031e9a..ab77f8b 100644 --- a/guides-sms/_sms-stats.md +++ b/guides-sms/_sms-stats.md @@ -8,6 +8,25 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?FromTS=1033552800&ToTS=1033574400 ``` +```javascript +/** + * View : Retrieve a list of SMS messages sent during a specific time period + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { FromTS: 1033552800, ToTS: 1033574400 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` With `GET` on the [`/sms`](/sms-api/v4/sms/) endpoint you are able to view details for a list of existing messages - `Status`, `Cost`, `MessageID`, sender and recipient, `CreationTS` and `SentTS` timestamps etc. @@ -70,6 +89,25 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?To=+33600000000 ``` +```javascript +/** + * View : Retrieve a list of SMS messages sent to a specific recipient + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { To: '+33600000000' }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` >API Response @@ -128,6 +166,25 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms?StatusCode=1,2 ``` +```javascript +/** + * View : Retrieve a list of SMS messages that were successfully sent, or are being currently sent + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .request({}, { StatusCode: '1,2' }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` >API Response @@ -208,6 +265,26 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms/744ecf8c-9fed-4ec9-acd0-9b326671f5df ``` +```javascript +/** + * View : Retrieve a specific SMS Message + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .id('744ecf8c-9fed-4ec9-acd0-9b326671f5df') // your id + .request() + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` >API Response @@ -247,6 +324,26 @@ curl -s -X GET \ -H "Authorization: Bearer $MJ_TOKEN" \ https://api.mailjet.com/v4/sms/count?FromTS=1033552800&ToTS=1033574400 ``` +```javascript +/** + * View : Retrieve the number of SMS messages that were processed within a specific timeframe + * */ +const mailjet = require('node-mailjet') + .smsConnect(process.env.MJ_API_TOKEN) + +const request = mailjet + .get('sms', { version: 'v4' }) + .action('count') + .request({}, { FromTS: 1033552800, ToTS: 1033574400 }) + +request + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) +``` >API Response diff --git a/guides/_account-management.md b/guides/_account-management.md index 80a6e3e..3076533 100644 --- a/guides/_account-management.md +++ b/guides/_account-management.md @@ -41,20 +41,22 @@ curl -s \ * Create : Manage your Mailjet API Keys. API keys are used as credentials to access the API and SMTP server. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("apikey") - .request({ - "Name":"MynewKEY" - }) + .post('apikey') + .request({ + Name: "MynewKEY" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage your Mailjet API Keys. API keys are used as credentials to access the API and SMTP server. @@ -318,18 +320,20 @@ public class MyClass { * View : Manage your Mailjet API Keys. API keys are used as credentials to access the API and SMTP server. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("apikey") - .request() + .get('apikey') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```csharp using Mailjet.Client; diff --git a/guides/_contacts-delete.md b/guides/_contacts-delete.md index 5f0d49e..4809568 100644 --- a/guides/_contacts-delete.md +++ b/guides/_contacts-delete.md @@ -1,21 +1,21 @@ -# GDPR Delete Contacts - -Under the European Union's [General Data Protection Regulation (GDPR)](https://www.eugdpr.org/), recipients in your Mailjet contacts database have the right to request the deletion of all their personal data stored on your end. In such cases, the GDPR requires the permanent removal of their contact record from your database, including contact properties, email tracking history and other engagement data. You’ll typically need to respond to these requests within 30 days. - -With the Mailjet API you are able to comply with the GDPR policy and delete a specific contact on a specific API Key. - - - -You must complete the following steps to successfully delete a contact: - -1. Identify the presence of this contact in your Mailjet account. -2. Save the Mailjet `{contact_ID}` related to this recipient. -3. Proceed with the deletion using the `{contact_ID}` you retrieved. - -## Retrieve a Contact - +# GDPR Delete Contacts + +Under the European Union's [General Data Protection Regulation (GDPR)](https://www.eugdpr.org/), recipients in your Mailjet contacts database have the right to request the deletion of all their personal data stored on your end. In such cases, the GDPR requires the permanent removal of their contact record from your database, including contact properties, email tracking history and other engagement data. You’ll typically need to respond to these requests within 30 days. + +With the Mailjet API you are able to comply with the GDPR policy and delete a specific contact on a specific API Key. + + + +You must complete the following steps to successfully delete a contact: + +1. Identify the presence of this contact in your Mailjet account. +2. Save the Mailjet `{contact_ID}` related to this recipient. +3. Proceed with the deletion using the `{contact_ID}` you retrieved. + +## Retrieve a Contact + ```php { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Retrieve details for a contact (including contact ID) by using the contact email. @@ -172,10 +174,10 @@ namespace Mailjet.ConsoleApplication } } ``` - - -> API Response: - + + +> API Response: + ```json { "Count": 1, @@ -199,71 +201,71 @@ namespace Mailjet.ConsoleApplication "Total": 1 } ``` - - -To delete a contact, you must first identify its presence in the contact database of your account. - -Use `GET` [`/contact/$CONTACT_EMAIL`](https://dev.mailjet.com/reference/email/contacts/contact/#v3_get_contact_contact_ID) to do it. - -
- -Save the contact ID - you need it to complete the deletion process. - -## Delete the Contact - -> Example available only with CURL - -```shell -curl -s \ --X DELETE \ ---user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \ -https://api.mailjet.com/v4/contacts/{contact_ID} \ -``` - -Use the `{contact_ID}` you retrieved to `DELETE` the contact with the `/v4/contacts/{contact_ID}` endpoint. When the deletion is successful, the API will return a `200 OK` status. Any other response will indicate that the deletion was not successfully processed. - -
- -```shell -# Retrieve an anonymized contact -curl -s \ --X GET \ ---user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \ -https://api.mailjet.com/v3/REST/contact/{contact_ID} \ -``` - -> API Response - -```json -{ - "Count": 1, - "Data": [ - { - "CreatedAt": "2017-09-26T14:12:32Z", - "DeliveredCount": 0, - "Email": "\\xae872d762f67cc4fc5d4bfe04e607256579928ac@domain.invalid", - "ExclusionFromCampaignsUpdatedAt": "", - "ID": 21339837, - "IsExcludedFromCampaigns": false, - "IsOptInPending": false, - "IsSpamComplaining": false, - "LastActivityAt": "2017-09-26T14:12:32Z", - "LastUpdateAt": "2018-07-12T09:04:23Z", - "Name": "Anonymized", - "UnsubscribedAt": "", - "UnsubscribedBy": "" - } - ], - "Total": 1 -} -``` - - - -
- -The deletion of a contact does not prevent you from re-uploading the same contact in the future. If you are using an external database to sync contacts with your Mailjet contact database, please make sure to simultaneously remove the contacts from it as well. - -This way you will be completely GDPR-compliant and will ensure that the contacts won’t be added by mistake later on. + + +To delete a contact, you must first identify its presence in the contact database of your account. + +Use `GET` [`/contact/$CONTACT_EMAIL`](https://dev.mailjet.com/reference/email/contacts/contact/#v3_get_contact_contact_ID) to do it. + +
+ +Save the contact ID - you need it to complete the deletion process. + +## Delete the Contact + +> Example available only with CURL + +```shell +curl -s \ +-X DELETE \ +--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \ +https://api.mailjet.com/v4/contacts/{contact_ID} \ +``` + +Use the `{contact_ID}` you retrieved to `DELETE` the contact with the `/v4/contacts/{contact_ID}` endpoint. When the deletion is successful, the API will return a `200 OK` status. Any other response will indicate that the deletion was not successfully processed. + +
+ +```shell +# Retrieve an anonymized contact +curl -s \ +-X GET \ +--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \ +https://api.mailjet.com/v3/REST/contact/{contact_ID} \ +``` + +> API Response + +```json +{ + "Count": 1, + "Data": [ + { + "CreatedAt": "2017-09-26T14:12:32Z", + "DeliveredCount": 0, + "Email": "\\xae872d762f67cc4fc5d4bfe04e607256579928ac@domain.invalid", + "ExclusionFromCampaignsUpdatedAt": "", + "ID": 21339837, + "IsExcludedFromCampaigns": false, + "IsOptInPending": false, + "IsSpamComplaining": false, + "LastActivityAt": "2017-09-26T14:12:32Z", + "LastUpdateAt": "2018-07-12T09:04:23Z", + "Name": "Anonymized", + "UnsubscribedAt": "", + "UnsubscribedBy": "" + } + ], + "Total": 1 +} +``` + + + +
+ +The deletion of a contact does not prevent you from re-uploading the same contact in the future. If you are using an external database to sync contacts with your Mailjet contact database, please make sure to simultaneously remove the contacts from it as well. + +This way you will be completely GDPR-compliant and will ensure that the contacts won’t be added by mistake later on. diff --git a/guides/_contacts_bulk.md b/guides/_contacts_bulk.md index 65470f7..2e13d9e 100644 --- a/guides/_contacts_bulk.md +++ b/guides/_contacts_bulk.md @@ -85,31 +85,33 @@ curl -s \ * Create : Manage a contact subscription to a list * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .id($ID) - .action("managecontactslists") - .request({ - "ContactsLists":[ - { - "ListID": "$ListID_1", - "Action": "addnoforce" - }, - { - "ListID": "$ListID_2", - "Action": "addforce" - } - ] - }) + .post('contact') + .id($ID) + .action('managecontactslists') + .request({ + ContactsLists: [ + { + ListID: "$ListID_1", + Action: "addnoforce" + }, + { + ListID: "$ListID_2", + Action: "addforce" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage a contact subscription to a list @@ -319,6 +321,7 @@ To manage a Contact subscription for one or multiple Lists, we can do a PO unsub | **string**
unsubscribes a contact from the list
+ ```json { "ErrorInfo": "", @@ -333,7 +336,6 @@ To manage a Contact subscription for one or multiple Lists, we can do a PO }, "StatusCode": 400 } - ``` For this API call, there is one specific HTTP 400 status error condition that is worth noting: @@ -380,20 +382,22 @@ $response->success() && var_dump($response->getData()); * View : Lists a contact belong to * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("contact") - .id($ID) - .action("getcontactslists") - .request() + .get('contact') + .id($ID) + .action('getcontactslists') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Lists a contact belong to @@ -627,48 +631,50 @@ curl -s \ * Create : Manage the details of a Contact. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .action("managemanycontacts") - .request({ - "ContactsLists":[ - { - "ListID": 1, - "action": "addnoforce" - }, - { - "ListID": 2, - "action": "addforce" - } - ], - "Contacts":[ - { - "Email": "jimsmith@example.com", - "Name": "Jim", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - }, - { - "Email": "janetdoe@example.com", - "Name": "Janet", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - } - ] - }) + .post('contact') + .action('managemanycontacts') + .request({ + ContactsLists: [ + { + ListID: 1, + action: "addnoforce" + }, + { + ListID: 2, + action: "addforce" + } + ], + Contacts: [ + { + Email: "jimsmith@example.com", + Name: "Jim", + Properties: { + Property1: "value", + Property2: "value2" + } + }, + { + Email: "janetdoe@example.com", + Name: "Janet", + Properties: { + Property1: "value", + Property2: "value2" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage the details of a Contact. @@ -1025,13 +1031,15 @@ curl -s \ * View: Job information * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("contact") - .action('managemanycontacts') - .id($JOBID) - .request() + .get('contact') + .action('managemanycontacts') + .id($JOBID) + .request() + request .then(result => { console.log(result.body) @@ -1233,40 +1241,42 @@ curl -s \ * Create : Manage your contact lists. One Contact might be associated to one or more ContactsList. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contactslist") - .id($ID) - .action("ManageManyContacts") - .request({ - "Action":"addnoforce", - "Contacts":[ - { - "Email": "jimsmith@example.com", - "Name": "Jim", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - }, - { - "Email": "janetdoe@example.com", - "Name": "Janet", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - } - ] - }) + .post('contactslist') + .id($ID) + .action('ManageManyContacts') + .request({ + Action: "addnoforce", + Contacts: [ + { + Email: "jimsmith@example.com", + Name: "Jim", + Properties: { + Property1: "value", + Property2: "value2" + } + }, + { + Email: "janetdoe@example.com", + Name: "Janet", + Properties: { + Property1: "value", + Property2: "value2" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage your contact lists. One Contact might be associated to one or more ContactsList. @@ -1561,14 +1571,16 @@ variable = Mailjet::Contactslist_managemanycontacts.find($ID, $JOBID) * View: Job information * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("contact") - .id($ID) - .action('managemanycontacts') - .id($JOBID) - .request() + .get('contact') + .id($ID) + .action('managemanycontacts') + .id($JOBID) + .request() + request .then(result => { console.log(result.body) @@ -1804,23 +1816,27 @@ https://api.mailjet.com/v3/DATA/contactslist/$ID_CONTACTLIST/CSVData/text:plain ``` ruby # unsupported at the moment, please refer to cURL ``` -``` javascript -const fs = require ('fs') -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +```javascript +const fs = require('fs') +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + fs.readFile('./data.csv', (err, data) => { - if (err) { return console.error(err) } - const request = mailjet.post('contactslist') - .id("$ID_CONTACTLIST") - .action('csvdata') - .request(data); + if (err) return console.error(err) + + const request = mailjet + .post('contactslist') + .id($ID_CONTACTLIST) + .action('csvdata') + .request(data); + request - .then(result => { - console.log(result.body) - }) - .catch(error => { - console.log(error.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(error => { + console.log(error.statusCode) + }) }) ``` ``` go @@ -1917,22 +1933,24 @@ curl -s \ * Create: A wrapper for the CSV importer * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("csvimport") - .request({ - "ContactsListID":"$ID_CONTACTLIST", - "DataID":"$ID_DATA", - "Method":"addnoforce" - }) + .post('csvimport') + .request({ + ContactsListID: "$ID_CONTACTLIST", + DataID: "$ID_DATA", + Method: "addnoforce" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create: A wrapper for the CSV importer @@ -2153,23 +2171,31 @@ curl -s \ * Create: A wrapper for the CSV importer * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("csvimport") - .request({ - "ContactsListID":"$ID_CONTACTLIST", - "DataID":"$ID_DATA", - "Method":"addnoforce", - "ImportOptions":"{\"DateTimeFormat\": \"yyyy/mm/dd\",\"TimezoneOffset\": 2,\"FieldNames\": [\"email\",\"birthday\"]}" - }) + .post('csvimport') + .request({ + ContactsListID: "$ID_CONTACTLIST", + DataID: "$ID_DATA", + Method: "addnoforce", + ImportOptions: JSON.stringify( + { + DateTimeFormat: "yyyy/mm/dd", + TimezoneOffset: 2, + FieldNames: ["email", "birthday"] + } + ) + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create: A wrapper for the CSV importer @@ -2379,19 +2405,21 @@ curl -s \ * View: CSV upload Batch job running on the Mailjet infrastructure. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("csvimport") - .id($ID_JOB) - .request() + .get('csvimport') + .id($ID_JOB) + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View: CSV upload Batch job running on the Mailjet infrastructure. diff --git a/guides/_domain-dns.md b/guides/_domain-dns.md index 387e52e..d1eec7b 100644 --- a/guides/_domain-dns.md +++ b/guides/_domain-dns.md @@ -38,20 +38,22 @@ curl -s \ * Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("sender") - .request({ - "Email":"anothersender@example.com" - }) + .post('sender') + .request({ + Email: "anothersender@example.com" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. @@ -237,19 +239,21 @@ curl -s \ * View : Sender Domain properties. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("dns") - .id($ID_OR_DOMAINNAME) - .request() + .get('dns') + .id($ID_OR_DOMAINNAME) + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Sender Domain properties. @@ -439,20 +443,22 @@ curl -s \ * Check : Run a check on a domain * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("dns") - .id($ID_OR_DOMAINNAME) - .action("check") - .request() + .post('dns') + .id($ID_OR_DOMAINNAME) + .action('check') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Check : Run a check on a domain @@ -654,20 +660,22 @@ curl -s \ * Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("sender") - .request({ - "Email":"anothersender@example.com" - }) + .post('sender') + .request({ + Email: "anothersender@example.com" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. @@ -854,20 +862,22 @@ $response->success() && var_dump($response->getData()); * Validate : check if the Ownership token has been properly setup on the website or DNS * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("sender") - .id($ID) - .action("validate") - .request() + .post('sender') + .id($ID) + .action('validate') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Validate : check if the Ownership token has been properly setup on the website or DNS diff --git a/guides/_event-api.md b/guides/_event-api.md index 43ceb4a..c8a3099 100644 --- a/guides/_event-api.md +++ b/guides/_event-api.md @@ -72,22 +72,24 @@ print result.json() * Create a grouped handler for the open event * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE); + const request = mailjet - .post("eventcallbackurl") - .request({ - "EventType":"open", - "Url":"https://mydomain.com/event_handler", - "Version":2 - }) + .post('eventcallbackurl') + .request({ + EventType: 'open', + Url: 'https://mydomain.com/event_handler', + Version: 2 + }); + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body); + }) + .catch((err) => { + console.log(err.statusCode); + }); ``` ``` go /* diff --git a/guides/_exclusionlist.md b/guides/_exclusionlist.md index f80305e..7046f0f 100644 --- a/guides/_exclusionlist.md +++ b/guides/_exclusionlist.md @@ -40,21 +40,23 @@ curl -s \ * Call to add contact to exclusion list * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .put("contact") - .id($ID_OR_EMAIL) - .request({ - "IsExcludedFromCampaigns":"true" - }) + .put('contact') + .id($ID_OR_EMAIL) + .request({ + IsExcludedFromCampaigns: true + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Call to add contact to exclusion list @@ -292,40 +294,42 @@ curl -s \ * Create : Manage the details of a Contact. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .action("managemanycontacts") - .request({ - "Contacts":[ - { - "Email": "jimsmith@example.com", - "Name": "Jim", - "IsExcludedFromCampaigns": true, - "Properties": { - "Property1": "value", - "Property2": "value2" - } - }, - { - "Email": "janetdoe@example.com", - "Name": "Janet", - "IsExcludedFromCampaigns": true, - "Properties": { - "Property1": "value", - "Property2": "value2" - } - } - ] - }) + .post('contact') + .action('managemanycontacts') + .request({ + Contacts: [ + { + Email: "jimsmith@example.com", + Name: "Jim", + IsExcludedFromCampaigns: true, + Properties: { + Property1: "value", + Property2: "value2" + } + }, + { + Email: "janetdoe@example.com", + Name: "Janet", + IsExcludedFromCampaigns: true, + Properties: { + Property1: "value", + Property2: "value2" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage the details of a Contact. @@ -563,21 +567,23 @@ curl -s \ * Create: A wrapper for the CSV importer * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("csvimport") - .request({ - "DataID":"$ID_DATA", - "Method":"excludemarketing" - }) + .post('csvimport') + .request({ + DataID: "$ID_DATA", + Method: "excludemarketing" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create: A wrapper for the CSV importer diff --git a/guides/_getting-started2.md b/guides/_getting-started2.md index a6b66d3..840095d 100644 --- a/guides/_getting-started2.md +++ b/guides/_getting-started2.md @@ -1,73 +1,73 @@ -# Getting Started - -In this section we will guide you through the core features of the Mailjet Email API : sending an email and retrieving information about your sent messages, including engagement statistics (opens, clicks, etc.). - -Let’s start! - -## Prerequisites - -To use the Mailjet Email API, you need to: - -1. [Create a Mailjet account](https://app.mailjet.com/signup), then [retrieve your API and Secret keys](https://app.mailjet.com/account/api_keys). They will be used for authentication purposes. -2. Make sure you have [cURL](https://curl.haxx.se/) installed on your machine, or use one of our official libraries in [PHP](https://github.com/mailjet/mailjet-apiv3-php), [Python](https://github.com/mailjet/mailjet-apiv3-python), [Node.js](https://github.com/mailjet/mailjet-apiv3-nodejs), [Java](https://github.com/mailjet/mailjet-apiv3-java), [C#](https://github.com/mailjet/mailjet-apiv3-dotnet), [Go](https://github.com/mailjet/mailjet-apiv3-go), and [Ruby](https://github.com/mailjet/mailjet-gem). - - Alternatively, you can use [Postman](https://www.getpostman.com/) to test the different API endpoints. Click on the button below to import a pre-made collection of examples. - -
- - -We also suggest that you create environment variables for your API and Secret keys for easy input. - -```bash -export $MJ_APIKEY_PUBLIC='Enter your API Key here' -export $MJ_APIKEY_PRIVATE='Enter your API Secret here' -``` - -- On Mac OS / Linux: - -
- -```bash -setx -m $MJ_APIKEY_PUBLIC "Enter your API Key here" -setx -m $MJ_APIKEY_PRIVATE "Enter your API Secret here" -``` - -- On Windows: - -
- -## Send your first email - -First, define the sender and recipient email as environment variables. Keep in mind that the sender email should be [validated in your Mailjet account](https://app.mailjet.com/account/sender) (your signup email address will be automatically validated). - -```bash -export $SENDER_EMAIL='Enter your sender email address here' -export $RECIPIENT_EMAIL='Enter your recipient email address here' -``` - - - On Mac OS / Linux: - -
- - ```bash - setx -m $SENDER_EMAIL "Enter your sender email address here" - setx -m $RECIPIENT_EMAIL "Enter your recipient email address here" - ``` - - - On Windows: - -
- +# Getting Started + +In this section we will guide you through the core features of the Mailjet Email API : sending an email and retrieving information about your sent messages, including engagement statistics (opens, clicks, etc.). + +Let’s start! + +## Prerequisites + +To use the Mailjet Email API, you need to: + +1. [Create a Mailjet account](https://app.mailjet.com/signup), then [retrieve your API and Secret keys](https://app.mailjet.com/account/api_keys). They will be used for authentication purposes. +2. Make sure you have [cURL](https://curl.haxx.se/) installed on your machine, or use one of our official libraries in [PHP](https://github.com/mailjet/mailjet-apiv3-php), [Python](https://github.com/mailjet/mailjet-apiv3-python), [Node.js](https://github.com/mailjet/mailjet-apiv3-nodejs), [Java](https://github.com/mailjet/mailjet-apiv3-java), [C#](https://github.com/mailjet/mailjet-apiv3-dotnet), [Go](https://github.com/mailjet/mailjet-apiv3-go), and [Ruby](https://github.com/mailjet/mailjet-gem). + + Alternatively, you can use [Postman](https://www.getpostman.com/) to test the different API endpoints. Click on the button below to import a pre-made collection of examples. + +
+ + +We also suggest that you create environment variables for your API and Secret keys for easy input. + +```bash +export $MJ_APIKEY_PUBLIC='Enter your API Key here' +export $MJ_APIKEY_PRIVATE='Enter your API Secret here' +``` + +- On Mac OS / Linux: + +
+ +```bash +setx -m $MJ_APIKEY_PUBLIC "Enter your API Key here" +setx -m $MJ_APIKEY_PRIVATE "Enter your API Secret here" +``` + +- On Windows: + +
+ +## Send your first email + +First, define the sender and recipient email as environment variables. Keep in mind that the sender email should be [validated in your Mailjet account](https://app.mailjet.com/account/sender) (your signup email address will be automatically validated). + +```bash +export $SENDER_EMAIL='Enter your sender email address here' +export $RECIPIENT_EMAIL='Enter your recipient email address here' +``` + + - On Mac OS / Linux: + +
+ + ```bash + setx -m $SENDER_EMAIL "Enter your sender email address here" + setx -m $RECIPIENT_EMAIL "Enter your recipient email address here" + ``` + + - On Windows: + +
+ ```shell # Run: curl -s \ @@ -132,36 +132,38 @@ $response->success() && var_dump($response->getData()); * Run: * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "$SENDER_EMAIL", - "Name": "Me" - }, - "To": [ - { - "Email": "$RECIPIENT_EMAIL", - "Name": "You" - } - ], - "Subject": "My first Mailjet Email!", - "TextPart": "Greetings from Mailjet!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: process.env.SENDER_EMAIL, + Name: "Me" + }, + To: [ + { + Email: process.env.RECIPIENT_EMAIL, + Name: "You" + } + ], + Subject: "My first Mailjet Email!", + TextPart: "Greetings from Mailjet!", + HTMLPart: "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Run: @@ -358,40 +360,40 @@ namespace Mailjet.ConsoleApplication } } ``` - - -Then use the code sample to send a message. - -
- -> Example API Response: - -```json -{ - "Messages": [ - { - "Status": "success", - "To": [ - { - "Email": "passenger@mailjet.com", - "MessageUUID": "1ab23cd4-e567-8901-2345-6789f0gh1i2j", - "MessageID": "1234567890987654321", - "MessageHref": "https://api.mailjet.com/v3/message/1234567890987654321" - } - ], - } - ] -} -``` - -**Congratulations - you have successfully sent your first email!** - -Save the `MessageID` - we will need it in the next section to access detailed information about the sent email. - -
- -## Retrieve sent messages - + + +Then use the code sample to send a message. + +
+ +> Example API Response: + +```json +{ + "Messages": [ + { + "Status": "success", + "To": [ + { + "Email": "passenger@mailjet.com", + "MessageUUID": "1ab23cd4-e567-8901-2345-6789f0gh1i2j", + "MessageID": "1234567890987654321", + "MessageHref": "https://api.mailjet.com/v3/message/1234567890987654321" + } + ], + } + ] +} +``` + +**Congratulations - you have successfully sent your first email!** + +Save the `MessageID` - we will need it in the next section to access detailed information about the sent email. + +
+ +## Retrieve sent messages + ```shell # Run : curl -s \ @@ -417,12 +419,14 @@ $response->success() && var_dump($response->getData()); * Run : * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("message") + .get('message') .id($MESSAGE_ID) .request() + request .then((result) => { console.log(result.body) @@ -548,49 +552,49 @@ namespace Mailjet.ConsoleApplication } } ``` - - -Now, let’s view the status of the sent message and its configuration specifics. - -
- -> Example API response: - -```json -{ - "Count": "1", - "Data": [ - { - "ArrivedAt": "2018-01-01T00:00:00", - "AttachmentCount": "1", - "AttemptCount": "1", - "CampaignID": "123456789", - "ContactAlt": "", - "ContactID": "987654", - "FilterTime": "111", - "ID": "1234567890987654321", - "Status": "clicked", - "Subject": "", - "UUID": "1ab23cd4-e567-8901-2345-6789f0gh1i2j" - "........................." - } - ], - "Total": "1" -} -``` - -As you can see, the information about the message is quite detailed and includes, among other things: - -- The time the message arrived -- The contact, to which it was sent -- Message size -- Number of attachments -- Current message status (e.g. sent, opened, clicked, etc.) - -In case you want to view the contact email address, or the Subject of the email, add the `ShowContactAlt=true` and `ShowSubject=true` as query parameters, respectively. - -
- + + +Now, let’s view the status of the sent message and its configuration specifics. + +
+ +> Example API response: + +```json +{ + "Count": "1", + "Data": [ + { + "ArrivedAt": "2018-01-01T00:00:00", + "AttachmentCount": "1", + "AttemptCount": "1", + "CampaignID": "123456789", + "ContactAlt": "", + "ContactID": "987654", + "FilterTime": "111", + "ID": "1234567890987654321", + "Status": "clicked", + "Subject": "", + "UUID": "1ab23cd4-e567-8901-2345-6789f0gh1i2j" + "........................." + } + ], + "Total": "1" +} +``` + +As you can see, the information about the message is quite detailed and includes, among other things: + +- The time the message arrived +- The contact, to which it was sent +- Message size +- Number of attachments +- Current message status (e.g. sent, opened, clicked, etc.) + +In case you want to view the contact email address, or the Subject of the email, add the `ShowContactAlt=true` and `ShowSubject=true` as query parameters, respectively. + +
+ ```shell # Run : curl -s \ @@ -619,13 +623,13 @@ $response->success() && var_dump($response->getData()); * Run : * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("message") - .request({ - "ContactAlt":"$RECIPIENT_EMAIL" - }) + .get('message') + .request({}, { ContactAlt: process.env.RECIPIENT_EMAIL }); + request .then((result) => { console.log(result.body) @@ -751,14 +755,14 @@ namespace Mailjet.ConsoleApplication } } ``` - - -Alternatively, you can retrieve messages sent to a specific recipient email address, using a query parameter: - -
- -## View message history - + + +Alternatively, you can retrieve messages sent to a specific recipient email address, using a query parameter: + +
+ +## View message history + ```shell # Run : curl -s \ @@ -784,12 +788,14 @@ $response->success() && var_dump($response->getData()); * Run : * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("messagehistory") + .get('messagehistory') .id($MESSAGE_ID) .request() + request .then((result) => { console.log(result.body) @@ -915,50 +921,50 @@ namespace Mailjet.ConsoleApplication } } ``` - - -You can track important events linked to the sent emails, for example whether the recipient opened the message, or clicked on a link within. - -Do a `GET` request on [`/messagehistory/{message_ID}`](https://dev.mailjet.com/reference/email/messages/#v3_get_messagehistory_message_ID) to retrieve the list of events linked to the email we just sent. - -
- -> Example API Response: - -```json -{ - "Count": 4, - "Data": [ - { - "EventAt": 1546958313, - "EventType": "sent", - ".........................." - }, - { - "EventAt": 1546958354, - "EventType": "opened", - ".........................." - }, - { - "EventAt": 1546958355, - "EventType": "clicked", - ".........................." - } - ], - "Total": 4 -} -``` - -We can see the event type, as well as a timestamp indicating when it happened. Pretty useful, right? - - - -
- -## Retrieve Statistics - + + +You can track important events linked to the sent emails, for example whether the recipient opened the message, or clicked on a link within. + +Do a `GET` request on [`/messagehistory/{message_ID}`](https://dev.mailjet.com/reference/email/messages/#v3_get_messagehistory_message_ID) to retrieve the list of events linked to the email we just sent. + +
+ +> Example API Response: + +```json +{ + "Count": 4, + "Data": [ + { + "EventAt": 1546958313, + "EventType": "sent", + ".........................." + }, + { + "EventAt": 1546958354, + "EventType": "opened", + ".........................." + }, + { + "EventAt": 1546958355, + "EventType": "clicked", + ".........................." + } + ], + "Total": 4 +} +``` + +We can see the event type, as well as a timestamp indicating when it happened. Pretty useful, right? + + + +
+ +## Retrieve Statistics + ```php success() && var_dump($response->getData()); * Run : * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statcounters") - .request({ - "CounterSource":"APIKey", - "CounterTiming":"Message", - "CounterResolution":"Lifetime" - }) + .get('statcounters') + .request({}, { + CounterSource: "APIKey", + CounterTiming: "Message", + CounterResolution: "Lifetime" + }) + request .then((result) => { console.log(result.body) @@ -1131,48 +1139,48 @@ namespace Mailjet.ConsoleApplication } } ``` - - -> Example API Response - -```json -{ - "Count": "1", - "Data": [ - { - "APIKeyID": "123456", - "MessageClickedCount": "1", - "MessageDeferredCount": "0", - "MessageHardBouncedCount": "0", - "MessageOpenedCount": "1", - "MessageQueuedCount": "0", - "MessageSentCount": "1", - "MessageSoftBouncedCount": "0", - "MessageSpamCount": "0", - "MessageUnsubscribedCount": "0", - "Total": "1" - "........................." - } - ], - "Total": "1" -} -``` - -The Mailjet API also has a variety of resources that help retrieve aggregated statistics for key performance indicators like opens, clicks, unsubscribes, etc. - -Let's take a look at just one of those resources to give you a sample of the data you can read - we’ll retrieve total aggregated statistics for your API key. - -
- -## Next steps - -You have played around with some of the basic functionalities of the Mailjet API, but there is so much more to learn! Continue reading to understand how to make the most out of the available resources. - -Here's a small list of suggestions: - -- [Verify Your Domain](#verify-your-domain) - Complete the SPF / DKIM authentication of your sender domains, which will ensure higher deliverability of your emails. -- [Send API v3.1](#send-api-v3-1) - Get acquainted with the full capabilities of our Send API - sending in bulk, using templates, adding headers and much more. -- [Event Tracking](#event-api-real-time-notifications) - Learn how to track email events (open, click, unsubscribe, bounce, etc.) in almost real time with the Mailjet Event API. -- [Statistics](#statistics) - See the numerous possibilities to extract different delivery and engagement metrics. - -For full information on all API endpoints, please visit our [API Reference](https://dev.mailjet.com/reference/email/). + + +> Example API Response + +```json +{ + "Count": "1", + "Data": [ + { + "APIKeyID": "123456", + "MessageClickedCount": "1", + "MessageDeferredCount": "0", + "MessageHardBouncedCount": "0", + "MessageOpenedCount": "1", + "MessageQueuedCount": "0", + "MessageSentCount": "1", + "MessageSoftBouncedCount": "0", + "MessageSpamCount": "0", + "MessageUnsubscribedCount": "0", + "Total": "1" + "........................." + } + ], + "Total": "1" +} +``` + +The Mailjet API also has a variety of resources that help retrieve aggregated statistics for key performance indicators like opens, clicks, unsubscribes, etc. + +Let's take a look at just one of those resources to give you a sample of the data you can read - we’ll retrieve total aggregated statistics for your API key. + +
+ +## Next steps + +You have played around with some of the basic functionalities of the Mailjet API, but there is so much more to learn! Continue reading to understand how to make the most out of the available resources. + +Here's a small list of suggestions: + +- [Verify Your Domain](#verify-your-domain) - Complete the SPF / DKIM authentication of your sender domains, which will ensure higher deliverability of your emails. +- [Send API v3.1](#send-api-v3-1) - Get acquainted with the full capabilities of our Send API - sending in bulk, using templates, adding headers and much more. +- [Event Tracking](#event-api-real-time-notifications) - Learn how to track email events (open, click, unsubscribe, bounce, etc.) in almost real time with the Mailjet Event API. +- [Statistics](#statistics) - See the numerous possibilities to extract different delivery and engagement metrics. + +For full information on all API endpoints, please visit our [API Reference](https://dev.mailjet.com/reference/email/). diff --git a/guides/_newsletter.md b/guides/_newsletter.md index f803e5e..3588df5 100644 --- a/guides/_newsletter.md +++ b/guides/_newsletter.md @@ -39,20 +39,22 @@ curl -s \ * Create : only need a Name * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contactslist") - .request({ - "Name":"myList" - }) + .post('contactslist') + .request({ + Name: "myList" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : only need a Name @@ -244,20 +246,22 @@ curl -s \ * Create : Manage the details of a Contact. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .request({ - "Email":"Mister@mailjet.com" - }) + .post('contact') + .request({ + Email: "Mister@mailjet.com" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage the details of a Contact. @@ -466,22 +470,24 @@ curl -s \ * Create : Definition of available extra data items for contacts. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contactmetadata") - .request({ - "Datatype":"str", - "Name":"Age", - "NameSpace":"static" - }) + .post('contactmetadata') + .request({ + Datatype: "str", + Name: "Age", + NameSpace: "static" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Definition of available extra data items for contacts. @@ -712,30 +718,32 @@ curl -s \ * Modify : Modify the static custom contact data * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .put("contactdata") - .id($CONTACT_ID) - .request({ - "Data":[ - { - "Name": "Age", - "value": 30 - }, - { - "Name": "Country", - "value": "US" - } - ] - }) + .put('contactdata') + .id($CONTACT_ID) + .request({ + Data: [ + { + Name: "Age", + value: 30 + }, + { + Name: "Country", + value: "US" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Modify : Modify the static custom contact data @@ -976,38 +984,40 @@ curl -s \ * Create : Manage the details of a Contact. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .action("managemanycontacts") - .request({ - "Contacts":[ - { - "Email": "jimsmith@example.com", - "Name": "Jim", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - }, - { - "Email": "janetdoe@example.com", - "Name": "Janet", - "Properties": { - "Property1": "value", - "Property2": "value2" - } - } - ] - }) + .post('contact') + .action('managemanycontacts') + .request({ + Contacts: [ + { + Email: "jimsmith@example.com", + Name: "Jim", + Properties: { + Property1: "value", + Property2: "value2" + } + }, + { + Email: "janetdoe@example.com", + Name: "Janet", + Properties: { + Property1: "value", + Property2: "value2" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage the details of a Contact. @@ -1273,31 +1283,33 @@ curl -s \ * Create : Manage a contact subscription to a list * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contact") - .id($ID) - .action("managecontactslists") - .request({ - "ContactsLists":[ - { - "ListID": "$ListID_1", - "Action": "addnoforce" - }, - { - "ListID": "$ListID_2", - "Action": "addforce" - } - ] - }) + .post('contact') + .id($ID) + .action('managecontactslists') + .request({ + ContactsLists: [ + { + ListID: "$ListID_1", + Action: "addnoforce" + }, + { + ListID: "$ListID_2", + Action: "addforce" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage a contact subscription to a list @@ -1525,28 +1537,30 @@ curl -s \ * Add a contact to the list * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contactslist") - .id($LIST_ID) - .action("managecontact") - .request({ - "Email":"mrsmith@mailjet.com", - "Name":"MrSmith", - "Action":"addnoforce", - "Properties":{ - "property1": "value", - "propertyN": "valueN" - } - }) + .post('contactslist') + .id($LIST_ID) + .action('managecontact') + .request({ + Email: "mrsmith@mailjet.com", + Name: "MrSmith", + Action: "addnoforce", + Properties: { + property1: "value", + propertyN: "valueN" + } + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Add a contact to the list @@ -1851,25 +1865,27 @@ $response->success() && var_dump($response->getData()); * Create : CampaignDraft data * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .request({ - "Locale":"en_US", - "Sender":"MisterMailjet", - "SenderEmail":"Mister@mailjet.com", - "Subject":"Greetings from Mailjet", - "ContactsListID":"$ID_CONTACTSLIST", - "Title":"Friday newsletter" - }) + .post('campaigndraft') + .request({ + Locale: "en_US", + Sender: "MisterMailjet", + SenderEmail: "Mister@mailjet.com", + Subject: "Greetings from Mailjet", + ContactsListID: "$ID_CONTACTSLIST", + Title: "Friday newsletter" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : CampaignDraft data @@ -2107,23 +2123,25 @@ $response->success() && var_dump($response->getData()); * Modify : CampaignDraft content data. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .id($ID) - .action("detailcontent") - .request({ - "Html-part":"Hello world!", - "Text-part":"Hello world!" - }) + .post('campaigndraft') + .id($ID) + .action('detailcontent') + .request({ + 'Html-part': 'Hello world!', + 'Text-part': "Hello world!" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Modify : CampaignDraft content data. @@ -2334,27 +2352,29 @@ curl -s \ * Create : CampaignDraft test * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .id($ID) - .action("test") - .request({ - "Recipients":[ - { - "Email": "mailjet@example.org", - "Name": "Mailjet" - } - ] - }) + .post('campaigndraft') + .id($ID) + .action('test') + .request({ + Recipients: [ + { + Email: "mailjet@example.org", + Name: "Mailjet" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : CampaignDraft test @@ -2564,20 +2584,22 @@ curl -s \ * Send a CampaignDraft * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .id($ID) - .action("send") - .request() + .post('campaigndraft') + .id($ID) + .action('send') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Send a CampaignDraft @@ -2771,22 +2793,24 @@ curl -s \ * Create : CampaignDraft schedule * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .id($ID) - .action("schedule") - .request({ - "date":"2015-04-22T09:00:00+01:00" - }) + .post('campaigndraft') + .id($ID) + .action('schedule') + .request({ + Date: "2015-04-22T09:00:00+01:00" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : CampaignDraft schedule @@ -2982,19 +3006,21 @@ curl -s \ * View : CampaignDraft data. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("campaigndraft") - .id($ID) - .request() + .get('campaigndraft') + .id($ID) + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```python """ @@ -3206,22 +3232,24 @@ curl -s \ * Create : A filter expressions for use in newsletters. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("contactfilter") - .request({ - "Description":"Only contacts aged 40", - "Expression":"age=40", - "Name":"40 year olds" - }) + .post('contactfilter') + .request({ + Description: "Only contacts aged 40", + Expression: "age=40", + Name: "40 year olds" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : A filter expressions for use in newsletters. @@ -3504,26 +3532,28 @@ curl -s \ * Create : CampaignDraft data * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("campaigndraft") - .request({ - "Locale":"en_US", - "Sender":"MisterMailjet", - "SenderEmail":"Mister@mailjet.com", - "Subject":"Greetings from Mailjet", - "ContactsListID":"$ID_CONTACTSLIST", - "Title":"Friday newsletter", - "SegmentationID":"$ID_CONTACT_FILTER" - }) + .post('campaigndraft') + .request({ + Locale: "en_US", + Sender: "MisterMailjet", + SenderEmail: "Mister@mailjet.com", + Subject: "Greetings from Mailjet", + ContactsListID: "$ID_CONTACTSLIST", + Title: "Friday newsletter", + SegmentationID: "$ID_CONTACT_FILTER" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : CampaignDraft data @@ -3718,19 +3748,21 @@ $response->success() && var_dump($response->getData()); * View : Campaign linked to the Newsletter :NEWSLETTER_ID * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("campaign") - .id(mj.nl=$NEWSLETTER_ID) - .request() + .get('campaign') + .id($ID) + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Campaign linked to the Newsletter :NEWSLETTER_ID diff --git a/guides/_parse-api.md b/guides/_parse-api.md index 486bffc..4bc9beb 100644 --- a/guides/_parse-api.md +++ b/guides/_parse-api.md @@ -46,20 +46,22 @@ curl -s \ * Create : ParseRoute description * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("parseroute") - .request({ - "Url":"https://www.mydomain.com/mj_parse.php" - }) + .post('parseroute') + .request({ + Url: "https://www.mydomain.com/mj_parse.php" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : ParseRoute description @@ -397,21 +399,23 @@ curl -s \ * Create : ParseRoute description * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("parseroute") - .request({ - "Url":"https://www.mydomain.com/mj_parse.php", - "Email":"mjparse@mydomain.com" - }) + .post('parseroute') + .request({ + Url: "https://www.mydomain.com/mj_parse.php", + Email: "mjparse@mydomain.com" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : ParseRoute description diff --git a/guides/_send-api-V3.md b/guides/_send-api-V3.md index 517ba39..fb2b5db 100644 --- a/guides/_send-api-V3.md +++ b/guides/_send-api-V3.md @@ -144,25 +144,31 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!' + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```csharp using Mailjet.Client; @@ -250,6 +256,7 @@ After a successful `POST` request the response will include the recipient email, MessageID is the unique ID of the message (legacy format). You will be able to use this ID to get more information about your message.
+ ```php Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "To":"Name , Name2 ", - "CC":"Name3 " - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + To: "Name , Name2 ", + CC: "Name3 ", + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This calls sends an email to two recipients in To and one recipient in CC. @@ -632,25 +641,36 @@ func main () { * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger1@mailjet.com","Name":"passenger 1"},{"Email":"passenger2@mailjet.com","Name":"passenger 2"}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```csharp using Mailjet.Client; @@ -905,26 +925,38 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Attachments":[{"Content-type":"text/plain","Filename":"test.txt","content":"VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK"}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + Attachments: [ + { + 'Content-type': "text/plain", + Filename: "test.txt", + content: "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK" + } + ] + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log (err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```csharp using Mailjet.Client; @@ -1124,26 +1156,36 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Inline_attachments":[{"Content-type":"image/png","Filename":"logo.png","content":"iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wIIChcxurq5eQAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAABV0lEQVQokaXSPWtTYRTA8d9N7k1zm6a+RG2x+FItgpu66uDQxbFurrr5OQQHR9FZnARB3PwSFqooddAStCBoqmLtS9omx+ESUXuDon94tnP+5+1JYm057GyQjZFP+l+S6G2FzlNe3WHtHc2TNI8zOlUUGLxsD1kDyR+EEQE2P/L8Jm/uk6RUc6oZaYM0JxtnpEX9AGPTtM6w7yzVEb61EaSNn4QD3j5m4QabH6hkVFLSUeqHyCeot0ib6BdNVGscPM/hWWr7S4Tw9TUvbpFUitHTnF6XrS+sL7O6VBSausT0FZonSkb+nZUFFm+z8Z5up5Btr1Lby7E5Zq4yPrMrLR263ZV52g+LvfW3iy6PXubUNVrnhqYNF3bmiZ1i1MmLnL7OxIWh4T+IMpYeRNyrRzyZjWg/ioh+aVgZu4WfXxaixbsRve5fiwb8epTo8+kZjSPFf/sHvgNC0/mbjJbxPAAAAABJRU5ErkJggg=="}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + Inline_attachments: [{ + 'Content-type': "image/png", + Filename: "logo.png", + content: "iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wIIChcxurq5eQAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAABV0lEQVQokaXSPWtTYRTA8d9N7k1zm6a+RG2x+FItgpu66uDQxbFurrr5OQQHR9FZnARB3PwSFqooddAStCBoqmLtS9omx+ESUXuDon94tnP+5+1JYm057GyQjZFP+l+S6G2FzlNe3WHtHc2TNI8zOlUUGLxsD1kDyR+EEQE2P/L8Jm/uk6RUc6oZaYM0JxtnpEX9AGPTtM6w7yzVEb61EaSNn4QD3j5m4QabH6hkVFLSUeqHyCeot0ib6BdNVGscPM/hWWr7S4Tw9TUvbpFUitHTnF6XrS+sL7O6VBSausT0FZonSkb+nZUFFm+z8Z5up5Btr1Lby7E5Zq4yPrMrLR263ZV52g+LvfW3iy6PXubUNVrnhqYNF3bmiZ1i1MmLnL7OxIWh4T+IMpYeRNyrRzyZjWg/ioh+aVgZu4WfXxaixbsRve5fiwb8epTo8+kZjSPFf/sHvgNC0/mbjJbxPAAAAABJRU5ErkJggg==" + }] + }) + request - .then(result => { - console.log(result.body) - }) - .catch(error => { + .then(result => { + console.log(result.body) + }) + .catch(error => { console.log(error.statusCode) - }) + }) ``` ``` go /* @@ -1427,37 +1469,49 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "Messages":[ - { - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Recipients":[{"Email":"passenger1@mailjet.com","Name":"passenger 1"}], - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!" - }, - { - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Recipients":[{"Email":"passenger2@mailjet.com","Name":"passenger 2"}], - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger 2, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger 2, welcome to Mailjet!
May the delivery force be with you!" - } - ] - }) + .post('send') + .request({ + Messages: [ + { + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!' + }, + { + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger 2, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger 2, welcome to Mailjet!
May the delivery force be with you!' + } + ] + }) + request - .then(result => { - console.log(result.body) - }) - .catch(error => { - console.log (error.statusCode); - }) + .then(result => { + console.log(result.body) + }) + .catch(error => { + console.log(error.statusCode); + }) ``` ``` go /* @@ -1761,26 +1815,39 @@ curl -s \ * This calls sends an email to 2 given recipient with global personalization. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! On this [[var:day]], may the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
On this [[var:day]], may the delivery force be with you!", - "Vars":{"day":"Monday"}, - "Recipients":[{"Email":"passenger1@mailjet.com","Name":"passenger 1"},{"Email":"passenger2@mailjet.com","Name":"passenger 2"}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Vars: { + day: "Monday" + }, + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! On this [[var:day]], may the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
On this [[var:day]], may the delivery force be with you!', + }) + request - .then(result => { - console.log(result.body) - }) + .then(result => { + console.log(result.body) + }) .catch(e => { - console.log(e.statusCode) - }) + console.log(e.statusCode) + }) ``` ``` go /* @@ -2046,26 +2113,43 @@ curl -s \ * This calls sends an email to 2 recipients with global and contact personalization. * */ -var mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) -var request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! On this [[var:day]], may the delivery force be with you! [[var:personalmessage]]", - "Html-part":"

Dear passenger, welcome to Mailjet!
On this [[var:day]], may the delivery force be with you! [[var:personalmessage]]", - "Vars":{"day":"Monday"}, - "Recipients":[{"Email":"passenger1@mailjet.com","Name":"passenger 1","Vars":{"day":"Tuesday","personalmessage":"Happy birthday!"}},{"Email":"passenger2@mailjet.com","Name":"passenger 2"}] - }) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + +const request = mailjet + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Vars: { + day: "Monday" + }, + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1", + Vars: { + day: "Tuesday", + personalmessage: "Happy birthday!" + } + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! On this [[var:day]], may the delivery force be with you! [[var:personalmessage]]", + 'Html-part': '

Dear passenger, welcome to Mailjet!
On this [[var:day]], may the delivery force be with you! [[var:personalmessage]]', + }) + request - .then(result => { - console.log(result.body) - }) + .then(result => { + console.log(result.body) + }) .catch(error => { - console.log(error.statusCode) - }) + console.log(error.statusCode) + }) ``` ``` go /* @@ -2308,25 +2392,36 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear [[data:firstname:\"passenger\"]], welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear [[data:firstname:\"passenger\"]], welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger1@mailjet.com","Name":"passenger 1"},{"Email":"passenger2@mailjet.com","Name":"passenger 2"}] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear [[data:firstname:\"passenger\"]], welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear [[data:firstname:"passenger"]], welcome to Mailjet!
May the delivery force be with you!', + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ``` go /* @@ -2520,29 +2615,31 @@ curl -s \ * This call sends a message based on a template. * */ -var mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) -var request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Mj-TemplateID":"1", - "Mj-TemplateLanguage":"true", - "Recipients":[ - { - "Email": "passenger@mailjet.com" - } - ] - }); +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + +const request = mailjet + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Mj-TemplateID': 1, + 'Mj-TemplateLanguage': true, + }); + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message based on a template. @@ -2786,42 +2883,44 @@ curl -s \ * This calls sends an email to the given recipient with vars and custom vars. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Mj-TemplateLanguage":"true", - "Text-part":"Dear passenger, welcome to Mailjet! On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", - "Html-part":"

Dear passenger, welcome to Mailjet!
On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", - "Vars":{ - "day": "Monday" - }, - "Recipients":[ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1", - "Vars": { - "day": "Tuesday", - "personalmessage": "Happy birthday!" - } - }, - { - "Email": "passenger2@mailjet.com", - "Name": "passenger 2" - } - ] - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Vars: { + day: "Monday" + }, + Recipients: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1", + Vars: { + day: "Tuesday", + personalmessage: "Happy birthday!" + } + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", + 'Html-part': '

Dear passenger, welcome to Mailjet!
On this {{var:day:"monday"}}, may the delivery force be with you! {{var:personalmessage:""}}', + 'Mj-TemplateLanguage': true + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```ruby # This calls sends an email to the given recipient with vars and custom vars. @@ -3133,26 +3232,34 @@ curl -s \ * This calls sends an email to one recipient with a Reply-To address. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Headers": {"Reply-To":"copilot@mailjet.com"} - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + Headers: { + 'Reply-To': "copilot@mailjet.com" + } + }) + request - .then(result => { - console.log(result.body) - }) - .catch(error => { - console.log(error.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(error => { + console.log(error.statusCode) + }) ``` ``` go /* @@ -3365,26 +3472,32 @@ curl -s \ * This calls sends a message to one recipient with a CustomID. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Mj-CustomID":"PassengerEticket1234" - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + 'Mj-CustomID': "PassengerEticket1234" + }) + request - .then(result => { - console.log(result.body) - }) + .then(result => { + console.log(result.body) + }) .catch(error => { console.log(error.statusCode) - }) + }) ``` ``` go /* @@ -3475,6 +3588,7 @@ namespace Mailjet.ConsoleApplication Sometimes you need to use your own ID in addition to ours to be able to trace back the message in our system easily. For this purpose we let you insert your own ID in the message. To achieve this, just pass the ID you want to use in the Mj-CustomID property.
+ ```php { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : API Key Statistical campaign/message data. @@ -3751,26 +3865,32 @@ curl -s \ * This calls sends a message to one recipient with an EventPayload. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Mj-EventPayLoad":"Eticket,1234,row,15,seat,B" - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + 'Mj-EventPayLoad': "Eticket,1234,row,15,seat,B" + }) + request .then(result => { - console.log(result.body) - }) + console.log(result.body) + }) .catch(error => { console.log(error.statusCode) - }) + }) ``` ``` go /* @@ -3989,27 +4109,33 @@ curl -s \ * This calls sends an email to one recipient within a campaign blocking multiple email to same recipient * */ -var mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) -var request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Mj-campaign":"SendAPI_campaign", - "Mj-deduplicatecampaign":1 - }); +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + +const request = mailjet + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + 'Mj-campaign': "SendAPI_campaign", + 'Mj-deduplicatecampaign': 1 + }); + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ``` go /* @@ -4259,26 +4385,32 @@ curl -s \ * This calls sends an email to one recipient with Real-time Monitoring. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send") - .request({ - "FromEmail":"pilot@mailjet.com", - "FromName":"Mailjet Pilot", - "Subject":"Your email flight plan!", - "Text-part":"Dear passenger, welcome to Mailjet! May the delivery force be with you!", - "Html-part":"

Dear passenger, welcome to Mailjet!
May the delivery force be with you!", - "Recipients":[{"Email":"passenger@mailjet.com"}], - "Mj-MonitoringCategory": "Category1" - }) + .post('send') + .request({ + FromEmail: "pilot@mailjet.com", + FromName: "Mailjet Pilot", + Recipients: [ + { + Email: "passenger@mailjet.com" + } + ], + Subject: "Your email flight plan!", + 'Text-part': "Dear passenger, welcome to Mailjet! May the delivery force be with you!", + 'Html-part': '

Dear passenger, welcome to Mailjet!
May the delivery force be with you!', + 'Mj-MonitoringCategory': "Category1" + }) + request - .then(result => { - console.log(result.body) - }) - .catch(err => { - console.log(err.statusCode) - }) + .then(result => { + console.log(result.body) + }) + .catch(err => { + console.log(err.statusCode) + }) ``` ```csharp using Mailjet.Client; diff --git a/guides/_send-api.md b/guides/_send-api.md index 871f7bb..1fc58b1 100644 --- a/guides/_send-api.md +++ b/guides/_send-api.md @@ -72,20 +72,22 @@ curl -s \ * Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("sender") - .request({ - "Email":"anothersender@example.com" - }) + .post('sender') + .request({ + Email: "anothersender@example.com" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Manage an email sender for a single API key. An e-mail address or a complete domain (*) has to be registered and validated before being used to send e-mails. In order to manage a sender available across multiple API keys, see the related MetaSender resource. @@ -305,36 +307,38 @@ curl -s \ * This call sends a message to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!' + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient. @@ -682,52 +686,54 @@ curl -s \ * This call sends a message to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - }, - { - "Email": "passenger2@mailjet.com", - "Name": "passenger 2" - } - ], - "Cc": [ - { - "Email": "copilot@mailjet.com", - "Name": "Copilot" - } - ], - "Bcc": [ - { - "Email": "air-traffic-control@mailjet.com", - "Name": "Air traffic control" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + }, + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Cc: [ + { + Email: "copilot@mailjet.com", + Name: "Copilot" + } + ], + Bcc: [ + { + Email: "air-traffic-control@mailjet.com", + Name: "Air traffic control" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!' + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient. @@ -1128,43 +1134,45 @@ curl -s \ * This call sends a message to the given recipient with attachment. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!", - "Attachments": [ - { - "ContentType": "text/plain", - "Filename": "test.txt", - "Base64Content": "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK" - } - ] - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!', + Attachments: [ + { + ContentType: "text/plain", + Filename: "test.txt", + Base64Content: "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK" + } + ] + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to the given recipient with attachment. @@ -1484,44 +1492,46 @@ curl -s \ * This call sends a message to the given recipient with inline attachment. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!", - "InlinedAttachments": [ - { - "ContentType": "image/png", - "Filename": "logo.png", - "ContentID": "id1", - "Base64Content": "iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wIIChcxurq5eQAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAABV0lEQVQokaXSPWtTYRTA8d9N7k1zm6a+RG2x+FItgpu66uDQxbFurrr5OQQHR9FZnARB3PwSFqooddAStCBoqmLtS9omx+ESUXuDon94tnP+5+1JYm057GyQjZFP+l+S6G2FzlNe3WHtHc2TNI8zOlUUGLxsD1kDyR+EEQE2P/L8Jm/uk6RUc6oZaYM0JxtnpEX9AGPTtM6w7yzVEb61EaSNn4QD3j5m4QabH6hkVFLSUeqHyCeot0ib6BdNVGscPM/hWWr7S4Tw9TUvbpFUitHTnF6XrS+sL7O6VBSausT0FZonSkb+nZUFFm+z8Z5up5Btr1Lby7E5Zq4yPrMrLR263ZV52g+LvfW3iy6PXubUNVrnhqYNF3bmiZ1i1MmLnL7OxIWh4T+IMpYeRNyrRzyZjWg/ioh+aVgZu4WfXxaixbsRve5fiwb8epTo8+kZjSPFf/sHvgNC0/mbjJbxPAAAAABJRU5ErkJggg==" - } - ] - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: 'pilot@mailjet.com', + Name: 'Mailjet Pilot' + }, + To: [ + { + Email: 'passenger1@mailjet.com', + Name: 'passenger 1' + } + ], + Subject: 'Your email flight plan!', + TextPart: 'Dear passenger 1, welcome to Mailjet! May the delivery force be with you!', + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!', + InlinedAttachments: [ + { + ContentType: 'image/png', + Filename: 'logo.png', + ContentID: 'id1', + Base64Content: 'iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wIIChcxurq5eQAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAABV0lEQVQokaXSPWtTYRTA8d9N7k1zm6a+RG2x+FItgpu66uDQxbFurrr5OQQHR9FZnARB3PwSFqooddAStCBoqmLtS9omx+ESUXuDon94tnP+5+1JYm057GyQjZFP+l+S6G2FzlNe3WHtHc2TNI8zOlUUGLxsD1kDyR+EEQE2P/L8Jm/uk6RUc6oZaYM0JxtnpEX9AGPTtM6w7yzVEb61EaSNn4QD3j5m4QabH6hkVFLSUeqHyCeot0ib6BdNVGscPM/hWWr7S4Tw9TUvbpFUitHTnF6XrS+sL7O6VBSausT0FZonSkb+nZUFFm+z8Z5up5Btr1Lby7E5Zq4yPrMrLR263ZV52g+LvfW3iy6PXubUNVrnhqYNF3bmiZ1i1MmLnL7OxIWh4T+IMpYeRNyrRzyZjWg/ioh+aVgZu4WfXxaixbsRve5fiwb8epTo8+kZjSPFf/sHvgNC0/mbjJbxPAAAAABJRU5ErkJggg==' + } + ] + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to the given recipient with inline attachment. @@ -1863,51 +1873,53 @@ curl -s \ * This call sends 2 messages to 2 different recipients. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!" - }, - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger2@mailjet.com", - "Name": "passenger 2" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 2, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 2, welcome to Mailjet!
May the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!' + }, + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger2@mailjet.com", + Name: "passenger 2" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 2, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 2, welcome to Mailjet!
May the delivery force be with you!' + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends 2 messages to 2 different recipients. @@ -2346,40 +2358,42 @@ curl -s \ * This call sends a message to a recipient with global personalisation. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Variables": { - "day": "Monday" - }, - "TemplateLanguage": true, - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger, welcome to Mailjet! On this {{var:day}}, may the delivery force be with you!", - "HTMLPart": "

Dear passenger, welcome to Mailjet!


On this {{var:day}}, may the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Variables: { + day: "Monday" + }, + TemplateLanguage: true, + Subject: "Your email flight plan!", + TextPart: "Dear passenger, welcome to Mailjet! On this {{var:day}}, may the delivery force be with you!", + HTMLPart: '

Dear passenger, welcome to Mailjet!


On this {{var:day}}, may the delivery force be with you!' + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to a recipient with global personalisation. @@ -2642,37 +2656,39 @@ $response->success() && var_dump($response->getData()); * This call sends a message to the a recipient with contact property personalisation. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "TemplateLanguage": true, - "Subject": "Your email flight plan!", - "TextPart": "Dear {{data:firstname:\"passenger\"}}, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear {{data:firstname:\"passenger\"}}, welcome to Mailjet!
May the delivery force be with you!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + TemplateLanguage: true, + Subject: "Your email flight plan!", + TextPart: "Dear {{data:firstname:\"passenger\"}}, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear {{data:firstname:"passenger"}}, welcome to Mailjet!
May the delivery force be with you!' + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to the a recipient with contact property personalisation. @@ -2979,36 +2995,38 @@ curl -s \ * This call sends a message based on a template. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "TemplateID": 1, - "TemplateLanguage": true, - "Subject": "Your email flight plan!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + TemplateID: 1, + TemplateLanguage: true, + Subject: "Your email flight plan!" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message based on a template. @@ -3301,41 +3319,43 @@ curl -s \ * This call sends a message to the given recipient with vars and custom vars. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "TextPart": "Dear passenger, welcome to Mailjet! On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", - "HTMLPart": "

Dear passenger, welcome to Mailjet!
On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", - "TemplateLanguage": true, - "Subject": "Your email flight plan!", - "Variables": { - "day": "Tuesday", - "personalmessage": "Happy birthday!" - } - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + TextPart: "Dear passenger, welcome to Mailjet! On this {{var:day:\"monday\"}}, may the delivery force be with you! {{var:personalmessage:\"\"}}", + HTMLPart: '

Dear passenger, welcome to Mailjet!
On this {{var:day:"monday"}}, may the delivery force be with you! {{var:personalmessage:""}}', + TemplateLanguage: true, + Subject: "Your email flight plan!", + Variables: { + day: "Tuesday", + personalmessage: "Happy birthday!" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to the given recipient with vars and custom vars. @@ -3645,39 +3665,41 @@ curl -s \ * This call sends an email to one recipient with an additional SMTP header * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!", - "Headers": { - "X-My-header": "X2332X-324-432-534" - } - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!', + Headers: { + 'X-My-header': "X2332X-324-432-534" + } + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends an email to one recipient with an additional SMTP header @@ -3987,37 +4009,39 @@ curl -s \ * This call sends a message to one recipient with a CustomID * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!", - "CustomID": "PassengerEticket1234" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!', + CustomID: "PassengerEticket1234" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient with a CustomID @@ -4224,6 +4248,7 @@ namespace Mailjet.ConsoleApplication Sometimes you may need to use your own ID, in addition to ours, to be able to easily trace back the message in our system. To achieve this, just pass the ID you wish in the CustomID property.
+ ```shell # View : API Key Statistical campaign/message data. curl -s \ @@ -4252,13 +4277,13 @@ $response->success() && var_dump($response->getData()); * View : API Key Statistical campaign/message data. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("message") - .request({ - "CustomID":"PassengerEticket1234" - }) + .get('message') + .request({}, { CustomID: "PassengerEticket1234" }) + request .then((result) => { console.log(result.body) @@ -4485,37 +4510,39 @@ p variable.attributes['Messages'] * This call sends a message to one recipient with an EventPayload. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!", - "EventPayload": "Eticket,1234,row,15,seat,B" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!', + EventPayload: "Eticket,1234,row,15,seat,B" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```python """ @@ -4767,38 +4794,40 @@ curl -s \ * This call sends a message to one recipient within a campaign blocking multiple messages to same recipient * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!", - "CustomCampaign": "SendAPI_campaign", - "DeduplicateCampaign": true - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!', + CustomCampaign: "SendAPI_campaign", + DeduplicateCampaign: true + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient within a campaign blocking multiple messages to same recipient @@ -5083,37 +5112,39 @@ curl -s \ * This calls sends an email to one recipient. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!", - "URLTags": "param1=1¶m2=2" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!


May the delivery force be with you!', + URLTags: "param1=1¶m2=2" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This calls sends an email to one recipient. @@ -5401,37 +5432,39 @@ curl -s \ * This call sends a message to one recipient in sandbox mode. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!" - } - ], - "SandboxMode":true - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!' + } + ], + SandboxMode: true + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient in sandbox mode. @@ -5734,37 +5767,39 @@ curl -s \ * This call sends a message to one recipient with Real-time Monitoring. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "Subject": "Your email flight plan!", - "TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", - "HTMLPart": "

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!", - "MonitoringCategory": "Category1" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + Subject: "Your email flight plan!", + TextPart: "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!", + HTMLPart: '

Dear passenger 1, welcome to Mailjet!
May the delivery force be with you!', + MonitoringCategory: "Category1" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message to one recipient with Real-time Monitoring. diff --git a/guides/_statistics.md b/guides/_statistics.md index f359de6..eee0d2f 100644 --- a/guides/_statistics.md +++ b/guides/_statistics.md @@ -109,23 +109,25 @@ curl -s \ * View : Retrieve Key Delivery statistics for a Specific Campaign * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statcounters") - .request({ - "SourceId":"$Campaign_ID", - "CounterSource":"Campaign", - "CounterTiming":"Message", - "CounterResolution":"Lifetime" - }) + .get('statcounters') + .request({}, { + SourceId: "$Campaign_ID", + CounterSource: "Campaign", + CounterTiming: "Message", + CounterResolution: "Lifetime" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Retrieve Key Delivery statistics for a Specific Campaign @@ -382,23 +384,25 @@ curl -s \ * View : Retrieve Key Delivery statistics for a Specific Campaign * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statcounters") - .request({ - "SourceId":"$Campaign_ID", - "CounterSource":"Campaign", - "CounterTiming":"Message", - "CounterResolution":"Lifetime" - }) + .get('statcounters') + .request({}, { + SourceId: "$Campaign_ID", + CounterSource: "Campaign", + CounterTiming: "Message", + CounterResolution: "Lifetime" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Retrieve Key Delivery statistics for a Specific Campaign @@ -671,25 +675,27 @@ curl -s \ * View : View campaign evolution statistics, based on daily timeslices and with a defined timeframe * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statcounters") - .request({ - "SourceId":"$Campaign_ID", - "CounterSource":"Campaign", - "CounterTiming":"Event", - "CounterResolution":"Day", - "FromTS":123, - "ToTS":456 - }) + .get('statcounters') + .request({}, { + SourceId: "$Campaign_ID", + CounterSource: "Campaign", + CounterTiming: "Event", + CounterResolution: "Day", + FromTS: 123, + ToTS: 456 + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : View campaign evolution statistics, based on daily timeslices and with a defined timeframe @@ -1035,18 +1041,20 @@ curl -s \ * View : View message statistics for a given contact. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("contactstatistics") - .request() + .get('contactstatistics') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : View message statistics for a given contact. @@ -1226,21 +1234,21 @@ curl -s \ * View : View statistics for total and unique clicks for each clicked URL in a campaign email * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statistics") - .action("link-click") - .request({ - "CampaignId":"$Campaign_ID" - }) + .get('statistics') + .action('link-click') + .request({}, { CampaignId: "$Campaign_ID" }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : View statistics for total and unique clicks for each clicked URL in a campaign email @@ -1418,21 +1426,21 @@ $response->success() && var_dump($response->getData()); * View : View delivery and contact engagement statistics for a campaign across different Mailbox providers * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("statistics") - .action("recipient-esp") - .request({ - "CampaignId":"$Campaign_ID" - }) + .get('statistics') + .action('recipient-esp') + .request({}, { CampaignId: "$Campaign_ID" }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : View delivery and contact engagement statistics for a campaign across different Mailbox providers @@ -1676,18 +1684,20 @@ curl -s \ * View : Message click/open statistics grouped per country * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("geostatistics") - .request() + .get('geostatistics') + .request() + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Message click/open statistics grouped per country diff --git a/guides/_template.md b/guides/_template.md index 5bfe9b5..3519c7c 100644 --- a/guides/_template.md +++ b/guides/_template.md @@ -57,20 +57,22 @@ $response->success() && var_dump($response->getData()); * Create : * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("template") - .request({ - "Name":"First Template" - }) + .post('template') + .request({ + Name: "First Template" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : @@ -271,23 +273,25 @@ curl -s \ * Create : Template content * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("template") - .id($ID_TEMPLATE) - .action("detailcontent") - .request({ - "Html-part":"

Hello {{var:name}}

", - "Text-part":"Hello {{var:name}}" - }) + .post('template') + .id($ID_TEMPLATE) + .action('detailcontent') + .request({ + 'Html-part': '

Hello {{var:name}}

', + 'Text-part': "Hello {{var:name}}" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # Create : Template content @@ -542,36 +546,38 @@ curl -s \ * This call sends a message based on a template. * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .post("send", {'version': 'v3.1'}) - .request({ - "Messages":[ - { - "From": { - "Email": "pilot@mailjet.com", - "Name": "Mailjet Pilot" - }, - "To": [ - { - "Email": "passenger1@mailjet.com", - "Name": "passenger 1" - } - ], - "TemplateID": 1, - "TemplateLanguage": true, - "Subject": "Your email flight plan!" - } - ] - }) + .post('send', { version: 'v3.1' }) + .request({ + Messages: [ + { + From: { + Email: "pilot@mailjet.com", + Name: "Mailjet Pilot" + }, + To: [ + { + Email: "passenger1@mailjet.com", + Name: "passenger 1" + } + ], + TemplateID: 1, + TemplateLanguage: true, + Subject: "Your email flight plan!" + } + ] + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # This call sends a message based on a template. @@ -807,21 +813,23 @@ $response->success() && var_dump($response->getData()); * View : Find your personal templates * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("template") - .request({ - "OwnerType":"user", - "Limit":100 - }) + .get('template') + .request({}, { + OwnerType: "user", + Limit: 100 + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Find your personal templates @@ -975,22 +983,24 @@ $response->success() && var_dump($response->getData()); * View : Find your templates, created in Passport * */ -const mailjet = require ('node-mailjet') - .connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) +const mailjet = require('node-mailjet') + .apiConnect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE) + const request = mailjet - .get("template") - .request({ - "EditMode":"tool", - "Limit":100, - "OwnerType":"user" - }) + .get('template') + .request({}, { + EditMode: "tool", + Limit: 100, + OwnerType: "user" + }) + request - .then((result) => { - console.log(result.body) - }) - .catch((err) => { - console.log(err.statusCode) - }) + .then((result) => { + console.log(result.body) + }) + .catch((err) => { + console.log(err.statusCode) + }) ``` ```ruby # View : Find your templates, created in Passport