MFT 
===

.. _InboxRoot:

InboxRoot
---------

Represents Inbox root object

.. code-block:: json

 message InboxRoot {
  string id = 1;
  string name = 2;
  string username = 6;
  string title = 7;
  uint32 num_children = 13; // collections only => subDocs
  optional uint32 sub_docs = 17;
  EffectivePermission effective_permission = 14;
  string description = 15;
  ItemType item_type = 31;
 }

+--------------------------+-------------------------+------------------------------------------------------+
| Field                    | Type                    | Description                                          |
+==========================+=========================+======================================================+
| ``id``                   | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``name``                 | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``username``             | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``title``                | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``num_children``         | ``uint32``              | collections only -> subDocs                          |
+--------------------------+-------------------------+------------------------------------------------------+
| ``sub_docs``             | ``uint32``              | **Optional**                                         |
+--------------------------+-------------------------+------------------------------------------------------+
| ``effective_permission`` | ``EffectivePermission`` | See :ref:`EffectivePermission <EffectivePermission>` |
+--------------------------+-------------------------+------------------------------------------------------+
| ``description``          | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``item_type``            | ``ItemType``            | See :ref:`ItemType <ItemType>`                       |
+--------------------------+-------------------------+------------------------------------------------------+

.. _OutboxRoot:

OutboxRoot
----------

Represents Outbox root object

.. code-block:: json

 message OutboxRoot {
  string id = 1;
  string name = 2;
  string username = 6;
  string title = 7;
  uint32 num_children = 13; // collections only => subDocs
  optional uint32 sub_docs = 17;
  EffectivePermission effective_permission = 14;
  string description = 15;
  ItemType item_type = 31;
 }

+--------------------------+-------------------------+------------------------------------------------------+
| Field                    | Type                    | Description                                          |
+==========================+=========================+======================================================+
| ``id``                   | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``name``                 | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``username``             | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``title``                | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``num_children``         | ``uint32``              | collections only => subDocs                          |
+--------------------------+-------------------------+------------------------------------------------------+
| ``sub_docs``             | ``uint32``              | **Optional**                                         |
+--------------------------+-------------------------+------------------------------------------------------+
| ``effective_permission`` | ``EffectivePermission`` | See :ref:`EffectivePermission <EffectivePermission>` |
+--------------------------+-------------------------+------------------------------------------------------+
| ``description``          | ``string``              |                                                      |
+--------------------------+-------------------------+------------------------------------------------------+
| ``item_type``            | ``ItemType``            | See :ref:`ItemType <ItemType>`                       |
+--------------------------+-------------------------+------------------------------------------------------+

.. _MFTMessage:

MFTMessage
----------

One entry of an inbox message. An inbox item can have several of them, one created whenever an upload to this inbox item is made

.. code-block:: json

 message MFTMessage {
  string name = 1;
  string message = 2;
  google.protobuf.Timestamp messagedate = 3;
 }

+-----------------+-------------------------------+--------------------+
| Field           | Type                          | Description        |
+=================+===============================+====================+
| ``name``        | ``string``                    |                    |
+-----------------+-------------------------------+--------------------+
| ``message``     | ``string``                    | The actual message |
+-----------------+-------------------------------+--------------------+
| ``messagedate`` | ``google.protobuf.Timestamp`` |                    |
+-----------------+-------------------------------+--------------------+

.. _GroupsWithAccess:

GroupsWithAccess
----------------

Represents groups that have access an outbox object

.. code-block:: json

 message GroupsWithAccess {
  repeated Group groups = 1;
 }

+-----------+-----------+--------------------------+
| Field     | Type      | Description              |
+===========+===========+==========================+
| ``group`` | ``Group`` | See :ref:`Group <Group>` |
+-----------+-----------+--------------------------+

.. _MFTInboxItem:

MFTInboxItem
------------

Represents one InboxItem (one 'received' entry)

.. code-block:: json

 message MFTInboxItem {
  string id = 1;
  string name = 2;
  string username = 6;
  google.protobuf.Timestamp creation_date = 7;
  google.protobuf.Timestamp modification_date = 8;
  optional string real_name = 32;
  string title = 9;
  optional uint32 sub_docs = 17;
  EffectivePermission effective_permission = 14;
  string subject = 15;
  repeated MFTMessage messages = 16;
  string receiver_email = 18;
  optional Language receiver_language = 19;
  optional string password = 20;
  optional bool password_required = 21;
  optional bool email_verification_required = 22;
  google.protobuf.Timestamp restrict_access_from = 23;
  google.protobuf.Timestamp restrict_access_to = 24;
  optional string link = 25;
  optional bool create_link_only = 26;
  optional GroupsWithAccess groups_with_access = 27;
  bool is_locked = 28;
  string activity_log_id = 29;
  optional uint32 failed_logins = 30;
  ItemType item_type = 31;
  optional string dataroom_id = 33;
  optional LogoType dataroom_logo = 34;
 }

+---------------------------------+-------------------------------+-------------------------------------------------------------+
| Field                           | Type                          | Description                                                 |
+=================================+===============================+=============================================================+
| ``id``                          | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``name``                        | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``username``                    | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``creation_date``               | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``modification_date``           | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``real_name``                   | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``title``                       | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``sub_docs``                    | ``uint32``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``effective_permission``        | ``EffectivePermission``       | See :ref:`EffectivePermission <EffectivePermission>`        |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``subject``                     | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``messages``                    | array of ``MFTMessage``       | See :ref:`MFTMessage <MFTMessage>`                          |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``receiver_email``              | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``receiver_language``           | ``Language``                  | **Optional** See :ref:`Language <Language>`                 |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``password``                    | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``password_required``           | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``email_verification_required`` | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``restrict_access_from``        | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``restrict_access_to``          | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``link``                        | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``create_link_only``            | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``groups_with_access``          | ``GroupsWithAccess``          | **Optional** See :ref:`GroupsWithAccess <GroupsWithAccess>` |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``is_locked``                   | ``bool``                      |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``activity_log_id``             | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``failed_logins``               | ``uint32``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``item_type``                   | ``ItemType``                  |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``dataroom_id``                 | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``dataroom_logo``               | ``LogoType``                  | **Optional** See :ref:`LogoType <LogoType>`                 |
+---------------------------------+-------------------------------+-------------------------------------------------------------+

.. _MFTOutboxItem:

MFTOutboxItem
-------------

Represents one OutboxItem (one 'send' item)

.. code-block:: json

 message MFTOutboxItem {
  string id = 1;
  string name = 2;
  string username = 6;
  google.protobuf.Timestamp creation_date = 7;
  google.protobuf.Timestamp modification_date = 8;
  optional string real_name = 9;
  string title = 10;
  optional uint32 sub_docs = 17;
  EffectivePermission effective_permission = 14;
  string subject = 15;
  optional string message = 16;
  repeated string receiver_emails = 18;
  optional Language receiver_language = 19;
  optional string password = 20;
  optional bool password_required = 21;
  optional bool email_verification_required = 22;
  optional google.protobuf.Timestamp restrict_access_to = 23;
  optional string link = 25;
  optional bool create_link_only = 26;
  repeated string linked_items = 27;
  optional bool notify_after_download = 28;
  optional bool email_bcc_to_me = 29;
  optional bool email_text_only = 30;
  optional bool use_secure_pdf = 31;
  optional bool use_secure_pdf_watermarks = 32;
  optional GroupsWithAccess groups_with_access = 33;
  bool is_locked = 34;
  ItemType item_type = 35;
  string activity_log_id = 36;
  optional google.protobuf.Timestamp mft_deleted = 37;
  optional uint32 failed_logins = 38;
  optional string dataroom_id = 39;
  optional LogoType dataroom_logo = 40;
 }

+---------------------------------+-------------------------------+-------------------------------------------------------------+
| Field                           | Type                          | Description                                                 |
+=================================+===============================+=============================================================+
| ``id``                          | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``name``                        | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``username``                    | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``creation_date``               | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``modification_date``           | ``google.protobuf.Timestamp`` |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``real_name``                   | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``title``                       | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``sub_docs``                    | ``uint32``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``effective_permission``        | ``EffectivePermission``       | See :ref:`EffectivePermission <EffectivePermission>`        |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``subject``                     | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``message``                     | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``receiver_emails``             | ``repeated string``           |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``receiver_language``           | ``Language``                  | **Optional** See :ref:`Language <Language>`                 |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``password``                    | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``password_required``           | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``email_verification_required`` | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``restrict_access_to``          | ``google.protobuf.Timestamp`` | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``link``                        | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``create_link_only``            | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``linked_items``                | array of ``string``           |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``notify_after_download``       | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``email_bcc_to_me``             | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``email_text_only``             | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``use_secure_pdf``              | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``use_secure_pdf_watermarks``   | ``bool``                      | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``groups_with_access``          | ``GroupsWithAccess``          | **Optional** See :ref:`GroupsWithAccess <GroupsWithAccess>` |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``is_locked``                   | ``bool``                      |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``item_type``                   | ``ItemType``                  | See :ref:`ItemType <ItemType>`                              |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``activity_log_id``             | ``string``                    |                                                             |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``mft_deleted``                 | ``google.protobuf.Timestamp`` | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``failed_logins``               | ``uint32``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``dataroom_id``                 | ``string``                    | **Optional**                                                |
+---------------------------------+-------------------------------+-------------------------------------------------------------+
| ``dataroom_logo``               | ``LogoType``                  | **Optional** See :ref:`LogoType <LogoType>`                 |
+---------------------------------+-------------------------------+-------------------------------------------------------------+