@chilkat/react-native 11.6.1

package/src/specs/Mailboxes.nitro.ts

@@ -0,0 +1,251 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Inspect IMAP mailbox names and attributes returned by Chilkat.Imap.
+ *
+ * `Mailboxes` is a read-only result collection populated by
+ * `Chilkat.Imap.MbxList`. Applications inspect the returned mailbox
+ * names and attributes but do not directly add, remove, or modify entries. The
+ * class provides indexed access to mailbox flags, selectable status, marked
+ * status, whether child mailboxes exist, and whether child mailboxes may be
+ * created.
+ *
+ * **Mailbox collection**
+ *
+ * Receive the read-only list of IMAP mailboxes populated by
+ * `Chilkat.Imap.MbxList`.
+ *
+ * **Indexed mailbox access**
+ *
+ * Use the mailbox count and index-based methods to retrieve each mailbox
+ * name in the returned collection.
+ *
+ * **Mailbox flags**
+ *
+ * Inspect IMAP flags associated with each mailbox, including standard and
+ * server-specific attributes.
+ *
+ * **Selectable status**
+ *
+ * Determine whether a mailbox can be selected and opened for message
+ * access.
+ *
+ * **Hierarchy information**
+ *
+ * Check whether a mailbox has child mailboxes or whether children may be
+ * created beneath it.
+ *
+ * **Marked status**
+ *
+ * Detect whether a mailbox is marked or unmarked according to the
+ * attributes returned by the IMAP server.
+ *
+ * **Common pattern:**
+ * Call `Chilkat.Imap.MbxList` to populate a
+ * `Mailboxes` object, loop from `0` to
+ * `Count - 1`, retrieve each mailbox name, and inspect its flags or
+ * selectable status. Mailbox names are exposed as normal Unicode text; Chilkat
+ * automatically handles modified UTF-7 or IMAP UTF-8 at the protocol level.
+ *
+ * For an extended overview, see
+ * [Mailboxes Class Overview](https://www.chilkatsoft.com/mailboxes_class_overview.asp).
+ *
+ * Each `Mailboxes` instance owns a native Chilkat object. It is released when the JavaScript object
+ * is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new Mailboxes()`.
+ */
+export interface Mailboxes extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * Returns the number of mailboxes in this collection. An empty collection has a count of `0`.
+   *
+   * `Mailboxes` is a read-only result container populated by `Imap.MbxList`. Applications inspect
+   * the returned entries but do not directly add, remove, or modify mailboxes in this object.
+   *
+   * This property is read-only.
+   */
+  readonly count: number
+
+  // ---- Methods ----
+
+  /**
+   * Returns a comma-separated list of flags for the mailbox at the zero-based index specified by
+   * `index`.
+   *
+   * For example:
+   *
+   * ```
+   * \HasNoChildren,\Important
+   * ```
+   *
+   * To inspect the flags individually, use {@link Mailboxes.getNumFlags} and {@link
+   * Mailboxes.getNthFlag}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mailboxes.lastErrorText}.
+   */
+  getFlags(index: number): string
+
+  /**
+   * Returns the zero-based index of the mailbox whose name matches `mbxName`.
+   *
+   * Pass `mbxName` as a normal Unicode mailbox name. Chilkat automatically handles the
+   * protocol-level modified UTF-7 or IMAP UTF-8 representation; the application should not encode
+   * the mailbox name manually.
+   *
+   * The returned index can be used with methods such as {@link Mailboxes.getName}, {@link
+   * Mailboxes.getFlags}, and {@link Mailboxes.isSelectable}.
+   */
+  getMailboxIndex(mbxName: string): number
+
+  /**
+   * Returns the name of the mailbox at the zero-based index specified by `index`.
+   *
+   * The name is returned as normal Unicode text. Chilkat automatically decodes modified UTF-7 or
+   * IMAP UTF-8 mailbox names received from the server and automatically performs the corresponding
+   * encoding when the name is passed to an `Imap` method.
+   *
+   * The returned name can therefore be passed directly to methods that select, examine, create,
+   * rename, delete, copy to, or otherwise operate on a mailbox. Do not manually encode or decode
+   * the mailbox name.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mailboxes.lastErrorText}.
+   */
+  getName(index: number): string
+
+  /**
+   * Returns one flag from a mailbox in the collection.
+   *
+   * - `index` is the zero-based mailbox index.
+   *
+   * - `flagIndex` is the zero-based flag index within that mailbox.
+   *
+   * Call {@link Mailboxes.getNumFlags} to determine the number of flags available for the mailbox.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Mailboxes.lastErrorText}.
+   */
+  getNthFlag(index: number, flagIndex: number): string
+
+  /**
+   * Returns the number of flags associated with the mailbox at the zero-based index specified by
+   * `index`.
+   *
+   * Returns `-1` if `index` is outside the valid mailbox-index range. Use {@link
+   * Mailboxes.getNthFlag} to retrieve the individual flags.
+   */
+  getNumFlags(index: number): number
+
+  /**
+   * Returns `true` if the mailbox at the zero-based index specified by `index` contains the flag
+   * named by `flagName`.
+   *
+   * Flag-name comparison is case-insensitive. Include the leading backslash when checking an IMAP
+   * system flag or mailbox attribute, for example `\Marked`, `\Noselect`, or `\HasChildren`.
+   */
+  hasFlag(index: number, flagName: string): boolean
+
+  /**
+   * Returns `true` if the mailbox at the zero-based index specified by `index` either has child
+   * mailboxes or permits child mailboxes to be created beneath it.
+   *
+   * **Important distinction:**
+   * `\HasNoChildren` means that no child mailboxes currently exist. It does not mean that children
+   * cannot be created. The IMAP `\Noinferiors` attribute means that child mailboxes cannot be
+   * created.
+   */
+  hasInferiors(index: number): boolean
+
+  /**
+   * Returns `true` if the mailbox at the zero-based index specified by `index` has the IMAP
+   * `\Marked` attribute.
+   *
+   * `\Marked` is a server-provided hint that the mailbox may contain messages added since it was
+   * last selected. It is advisory information returned by the mailbox-listing operation.
+   */
+  isMarked(index: number): boolean
+
+  /**
+   * Returns `true` if the mailbox at the zero-based index specified by `index` can be selected or
+   * examined for message access.
+   *
+   * A mailbox having the IMAP `\Noselect` attribute is not selectable, even though it may appear in
+   * the mailbox hierarchy and may contain selectable child mailboxes.
+   */
+  isSelectable(index: number): boolean
+}