In this guide:
Description
This endpoint returns journaling connectors, their configuration and current status.
Pre-requisites
- In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Services | Journaling | Reading permission.
URI
To use this endpont you send a POST request to:
- /api/journaling/get-service
Request Headers
The following request headers must be included in your request:
Field | Description |
---|---|
Authorization | Please see the Authorization guide for more information on building the Authorization header. |
x-mc-req-id |
A randomly generated GUID, for example,
|
x-mc-app-id | The Application ID provided with your Registered API Application. |
x-mc-date |
The current date and time in the following format, for example,
|
Request Body
{
"data": [
{
"id": "String"
}
]
}
data
Field | Type | Required | Description |
---|---|---|---|
id | String | Optional | The secure id of an existing journal connector. A connecter's id can be found by running the call once to return all connectors. |
Response
{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"description": "String",
"journalUnknownInternalAddresses": true,
"transferProtocol": "String",
"journalNonInternalAddresses": true,
"id": "String",
"enabled": true,
"messageFormat": "String",
"smtpJournalingConnection": {
"inactivityTimeout": 180,
"emailAddress": "String",
"ipRanges": [
"String"
],
"extendedDeduplication": false,
"usesTls": true,
"deliveryWaitAttempts": 3,
"processInitialDelay": 0,
"usesAuthentication": false,
"prefersClearText": false
},
"removeJournalHeaders": false,
"statusInfo": {
"status": "String",
"queueSize": 0,
"id": "String",
"lastReceived": "Date String"
},
"queueSize": 0
}
]
}
meta object
Field | Type | Description |
---|---|---|
status | Number | The function level status of the request. |
meta
Field | Type | Description |
---|---|---|
status | Number | The function level status of the request. |
data
Field | Type | Description |
---|---|---|
id | String | The Mimecast secure ID of the connector |
description | String | The description text entered when creating or modifying the journal connector |
messageFormat | String | The message journaling format. Will be 'eml' for standard eml messages, or 'exchange_env' for Exchange envelope messages |
queueSize | Number | The number of messages in the journaling queue |
removeJournalHeaders | Boolean | If set to true, Mimecast will remove any 'X-MS-Exchange-Organization-BCC' and 'X-MS-Exchange-CrossPremises-BCC' headers added by Microsoft Exchange |
transferProtocol | String | The email transfer protocol for the journaling service. Will be 'pop3' for POP3 or 'smtp' for SMTP journaling. |
enabled | Boolean | The configured status of the journaling connector |
journalNonInternalAddresses | Boolean | If true, the journal connector will process messages that do not have an internal address. If false, non-internal messages will be dropped. |
journalUnknownInternalAddresses | Boolean | If true, the journal connector will process messages that contain an unknown user address, but a known internal domain. If false, these messages will be dropped. |
smtpJournalingConnection | SMTP Journaling Connection Object | An object containing SMTP Journaling configuration information |
pop3JournalingConnection | POP3 Journaling Connection Object | An object containing POP3 Journaling configuration information |
statusInfo | Journaling Service Status Object | An object with the journaling service status |
SMTP Journaling Connection Object
Field | Type | Description |
---|---|---|
emailAddress | String | The email address configured to recieve journaled messages. Each journal connector's address must be unique. |
ipRanges | Array of Strings | The IP addresses that are allowed to submit journaled messages in addition to an account's Authorized Outbound IP ranges |
usesAuthentication | Boolean | If true, authentication is enabled when transmitting messages to Mimecast. If false, authentication relies only on IP ranges. |
useTls | Boolean | If true, Transport Layer Security (TLS) is enforced for message journaling. If false, un-encrypted connections will be accepted. |
prefersClearText | Boolean | If true, messages should be Active Directory protected journal items. |
extendedDeduplication | Boolean | If true, messages are assumed to be both journaled and processed by the Mimecast gateway, and a 10 minute delay will be introduced to wait for the gateway to process a message. This option is not enabled by default. |
deliveryWaitAttempts | Number | The number of times Mimecast will attempt to match journaled messages before archiving |
inactivityTimeout | Number | The maximum amount of time in minutes to wait between journaled messages before changing the status of the connector |
processInitialDelay | Number | The duration in minutes to wait before attempting to match an existing message in the archive |
POP3 Journaling Connection Object
Field | Type | Description |
---|---|---|
emailAddress | String | The email address of the journal connector. Each journal connector's address must be unique. |
mailbox | String | The mailbox/username used to log in to the remote journaling mailbox. |
host | String | The hostname or IP address used to connect to the remote journaling mailbox. |
port | number | The TCP/IP port used to connect to the remote journaling mailbox. |
usesPOP3S | Boolean | Determines if the remote journaling mailbox will be accessed over an encrypted connection. Default value is true. |
encryptionIsRelaxed | Boolean | Relaxed encryption allows use of self-signed certificates to encrypt the connection to a remote journal mailbox. If false, the certificate used must be valid and signed by a third-party. Default value is false. |
detailedLoggingIsEnabled | Boolean | Detailed logging helps Mimecast Support to troubleshoot a failed journal connector. Default value is false. |
Sample Code
Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE. Please see the Global Base URL's page to find the correct base URL to use for your account.
POST {base_url}/api/journaling/get-service
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data":[
{
"id": "String"
}
]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests
# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/journaling/get-service"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"
# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"
# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])
# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()
# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.b64encode(hmac_sha1).rstrip()
# Create request headers
headers = {
'Authorization': 'MC ' + access_key + ':' + sig.decode(),
'x-mc-app-id': app_id,
'x-mc-date': hdr_date,
'x-mc-req-id': request_id,
'Content-Type': 'application/json'
}
payload = {
'data': [
{
"id": "String"
}
]
}
r = requests.post(url=url, headers=headers, data=str(payload))
print(r.text)
static void Main(string[] args)
{
//Setup required variables
string baseUrl = "https://xx-api.mimecast.com";
string uri = "/api/journaling/get-service";
string accessKey = "YOUR ACCESS KEY";
string secretKey = "YOUR SECRET KEY";
string appId = "YOUR APPLICATION ID";
string appKey = "YOUR APPLICATION KEY";
//Generate request header values
string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
string requestId = System.Guid.NewGuid().ToString();
//Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));
//Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));
//Build the signature to be included in the Authorization header in your request
string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);
//Build Request
System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
request.Method = "POST";
request.ContentType = "application/json";
//Add Headers
request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
request.Headers.Add("x-mc-date", hdrDate);
request.Headers.Add("x-mc-req-id", requestId);
request.Headers.Add("x-mc-app-id", appId);
//Add request body
//Create and write data to stream
string postData = @"{
""data"": [
{
""id"": ""String""
}
]
}";
byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);
System.IO.Stream stream = request.GetRequestStream();
stream.Write(payload, 0, payload.Length);
stream.Close();
//Send Request
System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
//Output response to console
System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
string responseBody = "";
string temp = null;
while ((temp = reader.ReadLine()) != null)
{
responseBody += temp;
};
System.Console.WriteLine(responseBody);
System.Console.ReadLine();
}
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/journaling/get-service"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION KEY"
#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid
#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)
#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
"x-mc-date" = $hdrDate;
"x-mc-app-id" = $appId;
"x-mc-req-id" = $requestId;
"Content-Type" = "application/json"}
#Create post body
$postBody = "{
""data"": [
{
""id"": ""String""
}
]
}"
#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url
#Print the response
$response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {
//set up variables for request
String baseUrl = "https://xx-api.mimecast.com";
String uri = "/api/journaling/get-service";
String url = "https://" + baseUrl + uri;
String accessKey = "YOUR ACCESS KEY";
String secretKey = "YOUR SECRET KEY";
String appId = "YOUR APPLICATION ID";
String appKey = "YOUR APPLICATION KEY";
//create URL object
java.net.URL obj = new java.net.URL(url);
// set guid for x-mc-req-id header
String guid = java.util.UUID.randomUUID().toString();
// set date for x-mc-date header
java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
String date = sdf.format(new java.util.Date());
//create signature for the Authorization header
String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
String hmacSHA1 = "HmacSHA1";
javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
mac.init(signingKey);
String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));
// create request object
javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();
//set request type to POST
con.setRequestMethod("POST");
con.setDoOutput(true);
//add reuqest headers
con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
con.setRequestProperty("x-mc-req-id", guid);
con.setRequestProperty("x-mc-app-id", appId);
con.setRequestProperty("x-mc-date", date);
con.setRequestProperty("Content-Type", "application/json");
con.setRequestProperty("Accept", "application/json");
//Add post body to the request
String postBody = "{\n" +
" \"data\": [\n" +
" {\n" +
" \"id\": \"String\" +
" }\n" +
" ]\n" +
"}";
java.io.OutputStream os = con.getOutputStream();
os.write(postBody.getBytes("UTF-8"));
os.close();
//process response
java.io.BufferedReader in = new java.io.BufferedReader(
new java.io.InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
//return result
java.lang.System.out.println(response.toString());
}