https://github.com/miyako/4d-plugin-gmime
Parse MIME using the GMIME library
https://github.com/miyako/4d-plugin-gmime
4d-plugin mime
Last synced: 29 days ago
JSON representation
Parse MIME using the GMIME library
- Host: GitHub
- URL: https://github.com/miyako/4d-plugin-gmime
- Owner: miyako
- License: mit
- Created: 2017-06-19T03:49:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-10-03T13:20:16.000Z (9 months ago)
- Last Synced: 2025-10-03T15:26:37.208Z (9 months ago)
- Topics: 4d-plugin, mime
- Language: C
- Homepage:
- Size: 363 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
# 4d-plugin-gmime
Parse MIME using the [GMIME](https://github.com/GNOME/gmime) library.
switched from libjson.7.6.1.lib to jsoncpp (`4.0.0`).
**Notes on building static GLIB for MSVC**:
link gmime with static idn2 +``IDN2_STATIC``
link glib with static pcre -``USE_SYSTEM_PCRE``
link gio with static ffi +``FFI_BUILDING``
force static iconv in iconv.h and charset.h -``LIBICONV_DYNAMIC``
uninstall Japanese version of Visual Studio ([zlib build fails with vcpkg](https://github.com/Microsoft/vcpkg/issues/1939))
use [VisualStudioUninstaller](https://github.com/Microsoft/VisualStudioUninstaller) and manually delete surviving registry keys
create ``DllMain`` wrappers for glib, gio, gobject
## Syntax
```
MIME PARSE MESSAGE (mime;json;data)
```
Parameter|Type|Description
------------|------------|----
mime|BLOB|Raw MIME data (``.eml`` or ``.mbox``)
json|TEXT|The parsed MIME content
data|ARRAY BLOB|Raw data (images, attachments) linked to the MIME content
```
mime:=MIME Create message (json;data)
```
Parameter|Type|Description
------------|------------|----
json|TEXT|The parsed MIME content
data|ARRAY BLOB|Raw data (images, attachments) linked to the MIME content
mime|BLOB|Raw MIME data
### The parsed MIME content
**Note**: The [JSON schema](https://github.com/miyako/4d-plugin-gmime/blob/master/MIME.4dbase/Resources/schema.json) is attached to the sample database.
Use it like
```
$path:=Get 4D folder(Current resources folder)+"schema.json"
$schema_json:=Document to text($path;"utf-8")
$schema:=JSON Parse($schema_json)
$errors:=JSON Validate($mime;$schema)
```
* Properties of the root ``message`` object
``from`` : ``address`` array (optional)
``cc`` : ``address`` array (optional)
``to`` : ``address`` array (optional)
``bcc`` : ``address`` array (optional)
``sender`` : ``address`` array (optional)
``reply_to`` : ``address`` array (optional)
``all_recipients`` : ``address`` array (optional)
``local_date`` : ``string`` (ISO)
``utc_date`` : ``string`` (ISO)
``local_time`` : ``number`` (milliseconds)
``utc_time`` : ``number`` (milliseconds)
``id`` : ``string``
``headers`` : ``header`` array
``subject`` : ``string``
``body`` : ``part`` array
``attachments`` : ``part`` array
When creating MIME, you can also specify a ``subject_charset`` and ``mime_type``. Both are ``string``.
When creating MIME, the ``Date`` header is decided by ``utc_date``. If omitted, ``local_date`` is used instead.
When creating MIME, ``subject``, ``id``, ``mime_type`` take precedence over header definition.
---
* Properties of an ``address`` object
``name`` : ``string``
``string`` : ``string``
``encoded_string`` : ``string``
``addr`` : ``string``
``idn_addr`` : ``string``
When creating a MIME, the only properties needed are ``name`` and ``addr``.
---
* Properties of a ``header`` object
``name`` : ``string``
``value`` : ``string``
---
* Parsing ``multipart/*`` messages
Parts that have a ``Content-Disposition`` of ``attachment`` are included in ``attachment``.
Otherwise, they are included in ``body`` (``multipart-related``, ``multipart/alternative``).
---
* Creating ``multipart/*`` messages
``body`` and ``attachments`` are processed separately
* To create ``multipart/related``
pass all inline images in ``body``, not ``attachment``
* To create ``multipart/mixed``
pass all attachments in ``attachment``
* To create ``multipart/alternative``
pass text and html in ``body``
* To create ``multipart/alternative`` inside ``multipart/related``
pass text, html and all inline images in ``body``
---
* Properties of a ``part`` object
``mime_type`` : ``string``
``media_type`` : ``string``
``media_subtype`` : ``string``
``file_name`` : ``string``
``data`` : ``string`` for ``text/*``, ``number`` for other types
``content_description`` : ``string`` (optional)
``content_md5`` : ``string`` (optional)
``content_location`` : ``string`` (optional)
``content_encoding`` : ``string``
``headers`` : ``header`` array
When creating a MIME, make sure you specifiy the ``content_encoding`` in ``part``, not just as a header value.
When creating a MIME, you can also specify a ``charset`` as ``string``.
When creating MIME, ``mime_type``, ``content_id``, ``content_location``, ``content_description``, ``file_name``, ``content_md5`` take precedence over header values. ``content_encoding`` is always base64 for binary parts.
## Example of parsing MIME
```
$path:=Get 4D folder(Current resources folder)+"test.eml"
DOCUMENT TO BLOB($path;$eml)
C_TEXT($mime_json)
ARRAY BLOB($mime_blobs;0)
MIME PARSE MESSAGE ($eml;$mime_json;$mime_blobs)
$mime:=JSON Parse($mime_json)
ARRAY OBJECT($body;0)
OB GET ARRAY(OB Get($mime;"message";Is object);"body";$body)
$subject:=ob get (OB Get($mime;"message";Is object);"subject";Is text)
$plain:=OB Get($body{1};"data";Is text)
$html:=OB Get($body{2};"data";Is text)
```
## Example of creating MIME
```
$path:=Get 4D folder(Current resources folder)+"test.eml"
DOCUMENT TO BLOB($path;$eml)
C_TEXT($mime_json)
ARRAY BLOB($mime_blobs;0)
MIME PARSE MESSAGE ($eml;$mime_json;$mime_blobs)
$preview:=JSON Parse($mime_json)
//add an attachment
$path:=Get 4D folder(Current resources folder)+"wakanda-mascot-walking.png"
DOCUMENT TO BLOB($path;$image)
APPEND TO ARRAY($mime_blobs;$image)
$message:=OB Get($preview;"message")
ARRAY OBJECT($body;0)
OB GET ARRAY($message;"body";$body)
C_OBJECT($b)
OB SET($b;\
"file_name";"わかんだちゃん.png";\
"content_description";"わかんだちゃん";\
"content_location";"http://www.4d.com";\
"content_md5";Generate digest("わかんだちゃん";MD5 digest);\
"mime_type";"image/png";\
"data";1) //element number of this blob in $2
ARRAY OBJECT($headers;0)
C_OBJECT($h)
OB SET($h;"name";"Content-Disposition";"value";"inline")
APPEND TO ARRAY($headers;$h)
OB SET ARRAY($b;"headers";$headers)
APPEND TO ARRAY($body;$b)
OB SET ARRAY($message;"body";$body)
OB SET($message;"mime_type";"multipart/mixed")
$mime_json:=JSON Stringify($preview)
$eml:=MIME Create message ($mime_json;$mime_blobs)
$path:=System folder(Desktop)+"1.eml"
BLOB TO DOCUMENT($path;$eml)
```