Email

HiveSocial platform has the ability to sent emails on many occasions, managed by the user from its notification screen. All these emails are part of the email content item and you can manage them with the methods below.

If you are not using a third party SMTP server settings, but the local web server to send your emails you need to check some mail settings. In order to comply with the spam filters of the recipient mail servers you should make sure that:

• In your system settings, set a "default administrator's email" with one, which has a domain name authorizing this server for sending emails. This email will appear as FROM field for all emails sent by the system.
• To authorize the server, you have to add in your domain zone a TXT record allowing your local server to send emails on behalf of the FROM email's domain. The record contents for the IP 111.111.111.111 for example are v=spf1 ip4:111.111.111.111 ~all
• Contact your server internet provider to create a "back resolve" for the server's IP with the FROM's email domain

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/email/sent/list?offset={offset}&pageSize={pageSize}&filter={filter}&target={target}&state={state}&startDate={startDate}&endDate={endDate}

Parameters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Laborum magna dolore excepteur irure eu.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "a7c874f1-c2dd-4b5c-b7c1-758addd0a037",
    "emails": [
      {
        "id": "3BCB2CD8-9A58-41F8-B1D1-0811F5F9833D",
        "type": "email",
        "fromEmail": "test@hivesocial.com",
        "fromName": "HiveSocial support",
        "toEmail": "test2@hivesocial.com",
        "replyToEmail": "test@hivesocial.com",
        "subject": "Stet clita kasd gubergren no",
        "content": "Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit.",
        "sendOn": "2014-03-03T23:20:23Z",
        "stateId": 2,
        "stateName": "Failed",
        "errorMessage": "at System.Net.Mail.SmtpClient.Send(MailMessage message)nat BTWF.Client.Components.Scheduler.MailSenderTask.Execute(ThreadPool tp) in c:\\source\\HS4\\Libraries\\BTWF.Client\\Components\\Scheduler\\MailSenderTask.cs:line 228",
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: pending list

Authorization is required. This list represents all emails that are not yet send.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/email/pending/list?offset={offset}&pageSize={pageSize}

Parameters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Laborum magna dolore excepteur irure eu.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "a7c874f1-c2dd-4b5c-b7c1-758addd0a037",
    "emails": [
      {
        "id": "3BCB2CD8-9A58-41F8-B1D1-0811F5F9833D",
        "type": "email",
        "fromEmail": "test@hivesocial.com",
        "fromName": "HiveSocial support",
        "toEmail": "test2@hivesocial.com",
        "replyToEmail": "test@hivesocial.com",
        "subject": "Stet clita kasd gubergren no",
        "content": "Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper.",
        "sendOn": null,
        "stateId": null,
        "stateName": null,
        "errorMessage": null,
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: resend

Authorization is required. Send an email again.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/email/sent/{emailId}/resend

Parameters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "The announcement was not created. Validation error occured!",
  "errors": [],
  "object": {
    "id": "3BCB2CD8-9A58-41F8-B1D1-0811F5F9833D",
    "type": "email",
    "fromEmail": "test@hivesocial.com",
    "fromName": "HiveSocial support",
    "toEmail": "test2@hivesocial.com",
    "replyToEmail": "test@hivesocial.com",
    "subject": "Stet clita kasd gubergren no",
    "content": "Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper.",
    "sendOn": "2014-03-03T23:20:23Z",
    "stateId": 2,
    "stateName": "Failed",
    "errorMessage": "at System.Net.Mail.SmtpClient.Send(MailMessage message)nat BTWF.Client.Components.Scheduler.MailSenderTask.Execute(ThreadPool tp) in c:\\source\\HS4\\Libraries\\BTWF.Client\\Components\\Scheduler\\MailSenderTask.cs:line 228",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.