snip_import_emails
Overview
Used to imports an email record from the SNIP archiving service.
Available APIs
Definition
snip_import_emails(session, email)
Parameters
| Name |
Type |
Description |
|---|
| session |
String |
Session ID returned by a previous login call. |
| email |
Array |
The contents of the email being imported. |
| email.message |
Array |
Contains the email attributes. |
| email.message.message_id |
String |
The ID of the email message. |
| email.message.subject |
String |
Email subject. |
| email.message.attachments |
Array |
The list of attachments to be imported |
| email.message.from_name |
String |
From sender name. |
| email.message.description |
String |
Plain text content body. |
| email.message.description_html |
String |
HTML email content body. |
| email.message.to_addrs |
String |
Email addresses the email was sent to. |
| email.message.cc_addrs |
String |
Email addresses the email was CCed to. |
| email.message.bcc_addrs |
String |
Email addresses the email was BCCed to. |
| email.message.date_sent |
String |
Date the email was sent. |
Result
| Name |
Type |
Description |
|---|
| result |
Array |
The call result. |
| result.results |
Boolean |
The success of the import. |
| result.count |
Integer |
The count of records imported. |
| result.message |
String |
The return message. |
Change Log
| Version |
Change |
|---|
| v4 |
Added snip_import_emails method. |