Skip to content

Latest commit

 

History

History
171 lines (95 loc) · 3.57 KB

messengerUtilities.rst

File metadata and controls

171 lines (95 loc) · 3.57 KB

≡ messengerUtilities API

messengerUtilities API

.. rst-class:: api-main-section

Functions

convertToPlainText(body, [options])

.. api-section-annotation-hack::

Converts the provided body to readable plain text, without tags and leading/trailing whitespace.

.. api-header::
   :label: Parameters


   .. api-member::
      :name: ``body``
      :type: (string)

      The to-be-converted body.


   .. api-member::
      :name: [``options``]
      :type: (object, optional)

      .. api-member::
         :name: [``flowed``]
         :type: (boolean, optional)

         The converted plain text will be wrapped to lines not longer than 72 characters and use format flowed, as defined by RFC 2646.




.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: string


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

formatFileSize(sizeInBytes)

.. api-section-annotation-hack::

Returns the provided file size in a human readable format (e.g. 12 bytes or 11,4 GB).

.. api-header::
   :label: Parameters


   .. api-member::
      :name: ``sizeInBytes``
      :type: (integer)

      The size in bytes.



.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: string


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

parseMailboxString(mailboxString, [preserveGroups])

.. api-section-annotation-hack::

Parse a mailbox string containing one or more email addresses (see RFC 5322, section 3.4).

.. api-header::
   :label: Parameters


   .. api-member::
      :name: ``mailboxString``
      :type: (string)

      The string to be parsed (e.g. :value:`User <[email protected]>, [email protected]`)


   .. api-member::
      :name: [``preserveGroups``]
      :type: (boolean, optional)

      Keep grouped hierachies. Groups may be specified in a mailbox string as follows: :value:`GroupName : user1 <[email protected]>, user2@example,com ;`.



.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: array of :ref:`messengerUtilities.ParsedMailbox`


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise


.. rst-class:: api-main-section

Types

ParsedMailbox

.. api-section-annotation-hack::

Representation of a parsed mailbox string (see RFC 5322, section 3.4).

.. api-header::
   :label: object


   .. api-member::
      :name: [``email``]
      :type: (string, optional)

      The :value:`addr-spec` associated with the provided address, if available.


   .. api-member::
      :name: [``group``]
      :type: (array of :ref:`messengerUtilities.ParsedMailbox`, optional)

      The members of the group, if available.


   .. api-member::
      :name: [``name``]
      :type: (string, optional)

      The :value:`display-name` associated with the provided address or group, if available.