Skip to content

Latest commit

 

History

History
190 lines (133 loc) · 6.96 KB

InboundParsingApi.md

File metadata and controls

190 lines (133 loc) · 6.96 KB

SibApiV3Sdk.InboundParsingApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
getInboundEmailAttachment GET /inbound/attachments/{downloadToken} Retrieve inbound attachment with download token.
getInboundEmailEvents GET /inbound/events Get the list of all the events for the received emails.
getInboundEmailEventsByUuid GET /inbound/events/{uuid} Fetch all events history for one particular received email.

getInboundEmailAttachment

File getInboundEmailAttachment(downloadToken)

Retrieve inbound attachment with download token.

This endpoint will retrieve inbound attachment with download token.

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.InboundParsingApi();

var downloadToken = "downloadToken_example"; // String | Token to fetch a particular attachment

apiInstance.getInboundEmailAttachment(downloadToken).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
downloadToken String Token to fetch a particular attachment

Return type

File

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getInboundEmailEvents

GetInboundEmailEvents getInboundEmailEvents(opts)

Get the list of all the events for the received emails.

This endpoint will show the list of all the events for the received emails.

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.InboundParsingApi();

var opts = { 
  'sender': "sender_example", // String | Email address of the sender.
  'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
  'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
  'limit': 100, // Number | Number of documents returned per page
  'offset': 0, // Number | Index of the first document on the page
  'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
};
apiInstance.getInboundEmailEvents(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
sender String Email address of the sender. [optional]
startDate Date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. [optional]
endDate Date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. [optional]
limit Number Number of documents returned per page [optional] [default to 100]
offset Number Index of the first document on the page [optional] [default to 0]
sort String Sort the results in the ascending/descending order of record creation [optional] [default to desc]

Return type

GetInboundEmailEvents

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getInboundEmailEventsByUuid

GetInboundEmailEventsByUuid getInboundEmailEventsByUuid(uuid)

Fetch all events history for one particular received email.

This endpoint will show the list of all events history for one particular received email.

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.InboundParsingApi();

var uuid = "uuid_example"; // String | UUID to fetch events specific to recieved email

apiInstance.getInboundEmailEventsByUuid(uuid).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
uuid String UUID to fetch events specific to recieved email

Return type

GetInboundEmailEventsByUuid

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json