API Guide Home (Online version only) |

# PalmVMPlugin.h File Reference

## Detailed Description

Defines APIs and structures for the VersaMail Plugin Service which lets users write plugins to view/send attachments.

Version:
  1.0

Definition in file PalmVMPlugin.h.

Include dependency graph for PalmVMPlugin.h:

Go to the source code of this file.

## Data Structures

- struct _pluginGetInfoParams
    Structure used for launch code MMPRO_PLUGIN_GET_INFO_LAUNCHCODE. More...
- struct _dataLinks
    Structure used for datalinks while sending /rcving data. More...
- struct _pluginParams
    Structure used for launch code MMPRO_PLUGIN_RECEIVE_LAUNCHCODE. More...
- struct _pluginQueryParams
    Structure used for launch code MMPRO_PLUGIN_QUERY_LAUNCHCODE. More...
- struct _pluginSendParams
    Structure used for launch code MMPRO_PLUGIN_SEND_LAUNCHCODE. More...
- struct _pluginExtendedQueryParams
    Structure used for launch code MMPRO_PLUGIN_EXTENDED_QUERY_LAUNCHCODE. More...

## Defines

- #define ATTYPE_MAX_NAME_LEN 32

Application Launch Codes

- #define MMPRO_PLUGIN_LAUNCHCODE (sysAppLaunchCmdCustomBase + 2)
- #define MMPRO_PLUGIN_RECEIVE_LAUNCHCODE MMPRO_PLUGIN_LAUNCHCODE
- #define MMPRO_PLUGIN_QUERY_LAUNCHCODE (sysAppLaunchCmdCustomBase + 3)
- #define MMPRO_PLUGIN_SEND_LAUNCHCODE (sysAppLaunchCmdCustomBase + 4)
- #define MMPRO_PLUGIN_EXTENDED_QUERY_LAUNCHCODE (sysAppLaunchCmdCustomBase + 5)
- #define MMPRO_PLUGIN_GET_INFO_LAUNCHCODE (sysAppLaunchCmdCustomBase + 8)

## Typedefs

- typedef _pluginGetInfoParams pluginGetInfoParams
    Structure used for launch code MMPRO_PLUGIN_GET_INFO_LAUNCHCODE.
- typedef _dataLinks dataLinks
    Structure used for datalinks while sending /rcving data.
- typedef _pluginParams pluginParams
    Structure used for launch code MMPRO_PLUGIN_RECEIVE_LAUNCHCODE.
- typedef _pluginQueryParams pluginQueryParams
    Structure used for launch code MMPRO_PLUGIN_QUERY_LAUNCHCODE.
- typedef _pluginSendParams pluginSendParams
    Structure used for launch code MMPRO_PLUGIN_SEND_LAUNCHCODE.
- typedef _pluginExtendedQueryParams pluginExtendedQueryParams
    Structure used for launch code MMPRO_PLUGIN_EXTENDED_QUERY_LAUNCHCODE.

## Enumerations

- enum PluginInfo {
  plugin_sendInfo,
  plugin_receiveInfo,
  plugin_allInfo
  }
    PluginInfo is specifies what plugin information is needed. More...

## Define Documentation

#define ATTYPE_MAX_NAME_LEN 32

Maximum array size for name of an attachment in listSendNames pointer

Definition at line 45 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_EXTENDED_QUERY_LAUNCHCODE (sysAppLaunchCmdCustomBase + 5)

Plugin should support selection of attachment and should return

Definition at line 39 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_GET_INFO_LAUNCHCODE (sysAppLaunchCmdCustomBase + 8)

VersaMail queries the plugin to get the details of Plugin information

Definition at line 40 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_LAUNCHCODE (sysAppLaunchCmdCustomBase + 2)

Plugin receives data from VersaMail and do whatever it deems appropriate with it.

Definition at line 34 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_QUERY_LAUNCHCODE (sysAppLaunchCmdCustomBase + 3)

Plugin should return a list of attachments for the user to select from.

Definition at line 37 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_RECEIVE_LAUNCHCODE MMPRO_PLUGIN_LAUNCHCODE

Definition at line 35 of file PalmVMPlugin.h.

#define MMPRO_PLUGIN_SEND_LAUNCHCODE (sysAppLaunchCmdCustomBase + 4)

The plugin should return the name of ? selected attachment for sending

Definition at line 38 of file PalmVMPlugin.h.

## Typedef Documentation

typedef struct _dataLinks dataLinks

Structure used for datalinks while sending /rcving data.

typedef struct _pluginExtendedQueryParams pluginExtendedQueryParams

Structure used for launch code MMPRO_PLUGIN_EXTENDED_QUERY_LAUNCHCODE.

typedef struct _pluginGetInfoParams pluginGetInfoParams

Structure used for launch code MMPRO_PLUGIN_GET_INFO_LAUNCHCODE.

typedef struct _pluginParams pluginParams

Structure used for launch code MMPRO_PLUGIN_RECEIVE_LAUNCHCODE.

typedef struct _pluginQueryParams pluginQueryParams

Structure used for launch code MMPRO_PLUGIN_QUERY_LAUNCHCODE.

typedef struct _pluginSendParams pluginSendParams

Structure used for launch code MMPRO_PLUGIN_SEND_LAUNCHCODE.

## Enumeration Type Documentation

enum PluginInfo

PluginInfo is specifies what plugin information is needed.

Enumerator:

  plugin_sendInfo | Provides info about what can be passed as an email attachment.
  plugin_receiveInfo | Provides info about what file types can be viewed.
  plugin_allInfo | Provides sendInfo and receiveInfo.

Definition at line 52 of file PalmVMPlugin.h.

    00052              {
    00053
    00054     plugin_sendInfo,    /**< Provides info about what can be passed as an email attachment. */
    00055     plugin_receiveInfo,     /**< Provides info about what file types can be viewed. */
    00056     plugin_allInfo      /**< Provides sendInfo and receiveInfo. */
    00057
    00058 } PluginInfo;

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:58 2008 for Palm API Guide