Service zimbraMail

Command Summary
AddAppointmentInvite Add an invite to an appointment.
AddComment Add a comment to the specified item. Currently comments can only be added to documents.
AddMsg Add a message.
AddTaskInvite Add a task invite.
AnnounceOrganizerChange Announce change of organizer.
ApplyFilterRules Applies one or more filter rules to messages specified by a comma-separated ID list, or returned by a search query. One or the other can be specified, but not both. Returns the list of ids of existing messages that were affected.
ApplyOutgoingFilterRules Applies one or more filter rules to messages specified by a comma-separated ID list, or returned by a search query. One or the other can be specified, but not both. Returns the list of ids of existing messages that were affected.
AutoComplete AutoComplete.
BounceMsg Resend a message.
Browse Browse.
CancelAppointment Cancel appointment.
CancelTask Cancel Task request.
CheckDeviceStatus Check device status.
CheckPermission Check if the authed user has the specified right(s) on a target.
Note: to be deprecated in Zimbra 9. Use zimbraAccount CheckRights instead.
CheckRecurConflicts Check conflicts in recurrence against list of users.
CheckSpelling Check spelling.
CompleteTaskInstance Complete a task instance.
ContactAction Contact Action.
ConvAction Conv Action.
CounterAppointment Propose a new time/location. Sent by meeting attendee to organizer.
CreateAppointment This is the API to create a new Appointment, optionally sending out meeting Invitations to other people.
CreateAppointmentException Create Appointment Exception.
CreateContact Create a contact.
CreateDataSource Creates a data source that imports mail items into the specified folder, for example via the POP3 or IMAP protocols. Only one data source is allowed per request.
CreateFolder Create folder.
CreateMountpoint Create mountpoint.
CreateNote Create a note.
CreateSearchFolder Create a search folder.
CreateTag Create a tag.
CreateTask This is the API to create a new Task.
CreateTaskException Create Task Exception.
CreateWaitSet Create a waitset to listen for changes on one or more accounts.
DeclineCounterAppointment Decline a change proposal from an attendee. Sent by organizer to an attendee who has previously sent a COUNTER message. The syntax of the request is very similar to CreateAppointmentRequest.
DeleteDataSource Deletes the given data sources. The name or id of each data source must be specified.
DeleteDevice Permanently deletes mapping for indicated device.
DestroyWaitSet Use this to close out the waitset. Note that the server will automatically time out a wait set if there is no reference to it for (default of) 20 minutes.
DiffDocument Performs line by line diff of two revisions of a Document then returns a list of <chunk/> containing the result. Sections of text that are identical to both versions are indicated with disp="common". For each conflict the chunk will show disp="first", disp="second" or both.
DismissCalendarItemAlarm Dismiss calendar item alarm.
DocumentAction Document Action.
EmptyDumpster Empty dumpster.
EnableSharedReminder Enable/disable reminders for shared appointments/tasks on a mountpoint.
ExpandRecur Expand recurrences.
ExportContacts Export contacts.
FolderAction Perform an action on a folder.
ForwardAppointment Used by an attendee to forward an instance or entire appointment to another user who is not already an attendee.
ForwardAppointmentInvite Used by an attendee to forward an appointment invite email to another user who is not already an attendee.
GenerateUUID Ajax client can use this request to ask the server for help in generating a proper, globally unique UUID.
GetActivityStream Get activity stream.
GetAllDevices Get all devices.
GetAppointment Get Appointment. Returns the metadata info for each Invite that makes up this appointment.
GetApptSummaries Get appointment summaries.
Note: This API is deprecated Use <SearchRequest> with the calExpandInstStart and calExpandInstEnd parameters
GetCalendarItemSummaries Get Calendar item summaries.
GetComments Get comments.
GetContacts Get contacts.
GetConv Get Conversation.
GetCustomMetadata Get Custom metadata.
GetDataSourceUsage
GetDataSources Returns all data sources defined for the given mailbox. For each data source, every attribute value is returned except password.
GetDocumentShareURL Get the download URL of shared document.
GetEffectiveFolderPerms Returns the effective permissions of the specified folder.
GetFilterRules Get filter rules.
GetFolder Get Folder.
GetFreeBusy Get Free/Busy information.
GetICal Retrieve the unparsed (but XML-encoded (&quot)) iCalendar data for an Invite.
GetImportStatus Returns current import status for all data sources. Status values for a data source are reinitialized when either (a) another import process is started or (b) when the server is restarted. If import has not run yet, the success and error attributes are not specified in the response.
GetItem Get item.
GetMailboxMetadata Get Mailbox metadata.
GetMiniCal Get information needed for Mini Calendar.
GetMsg Get Message.
GetMsgMetadata Get message metadata.
GetNote Get Note.
GetNotifications Get notifications.
GetOutgoingFilterRules Get outgoing filter rules.
GetPermission Get account level permissions.
Note: to be deprecated in Zimbra 9. Use zimbraAccount GetRights instead.
GetRecur Retrieve the recurrence definition of an appointment.
GetSearchFolder Get all search folders.
GetShareDetails Get item acl details.
GetShareNotifications Get Share notifications.
GetSpellDictionaries Returns the list of dictionaries that can be used for spell checking.
GetSystemRetentionPolicy Get system retention policy.
GetTag Get information about Tags.
GetTask Get Task.
GetTaskSummaries Get Task summaries.
GetWatchers Returns a list of items in the user's mailbox currently being watched by other users.
GetWatchingItems Returns a list of items the user is currently watching.
GetWorkingHours User's working hours within the given time range are expressed in a similar format to the format used for GetFreeBusy.
GetYahooAuthToken Get Yahoo Auth Token.
GetYahooCookie Get Yahoo cookie.
GrantPermission Grant account level permissions.
Note: to be deprecated in Zimbra 9. Use zimbraAccount GrantRights instead.
ICalReply Do an iCalendar Reply.
ImportAppointments Import appointments.
ImportContacts Import contacts.
ImportData Triggers the specified data sources to kick off their import processes. Data import runs asynchronously, so the response immediately returns. Status of an import can be queried via the <GetImportStatusRequest> message. If the server receives an <ImportDataRequest> while an import is already running for a given data source, the second request is ignored.
InvalidateReminderDevice Invalidate reminder device.
ItemAction Perform an action on an item.
ListDocumentRevisions Returns {num} number of revisions starting from {version} of the requested document. {num} defaults to 1. {version} defaults to the current version.
ModifyAppointment Modify an appointment, or if the appointment is a recurrence then modify the "default" invites. That is, all instances that do not have exceptions.
ModifyContact Modify Contact.
ModifyDataSource Changes attributes of the given data source. Only the attributes specified in the request are modified. If the username, host or leaveOnServer settings are modified, the server wipes out saved state for this data source. As a result, any previously downloaded messages that are still stored on the remote server will be downloaded again.
ModifyFilterRules Modify Filter rules.
ModifyMailboxMetadata Modify Mailbox Metadata.
ModifyOutgoingFilterRules Modify Outgoing Filter rules.
ModifySearchFolder Modify Search Folder.
ModifyTask Modify Task.
MsgAction Perform an action on a message.
NoOp A request that does nothing and always returns nothing. Used to keep a session alive, and return any pending notifications.
NoteAction Perform an action on an note.
PurgeRevision Purge revision.
RankingAction Perform an action on the contact ranking table.
RegisterDevice Register a device.
RemoveAttachments Remove attachments from a message body.
RevokePermission Revoke account level permissions.
Note: to be deprecated in Zimbra 9. Use zimbraAccount RevokeRights instead.
SaveDocument Save Document.
SaveDraft Save draft.
Search Search.
SearchConv Search a conversation.
SendDeliveryReport Send a delivery report.
SendInviteReply Send a reply to an invite.
SendMsg Send message.
SendSecureMsg
SendShareNotification Send share notification.
SendVerificationCode SendVerificationCodeRequest results in a random verification code being generated and sent to a device.
SetAppointment Directly set status of an entire appointment. This API is intended for mailbox Migration (ie migrating a mailbox onto this server) and is not used by normal mail clients.
SetCustomMetadata Set Custom Metadata.
SetMailboxMetadata Set Mailbox Metadata.
SetTask Directly set status of an entire task.
SnoozeCalendarItemAlarm Snooze alarm(s) for appointments or tasks.
Sync Sync.
TagAction Perform an action on a tag.
TestDataSource Tests the connection to the specified data source. Does not modify the data source or import data. If the id is specified, uses an existing data source. Any values specified in the request are used in the test instead of the saved values.
UpdateDeviceStatus Update device status.
VerifyCode Validate the verification code sent to a device. After successful validation the server sets the device email address as the value of zimbraCalendarReminderDeviceEmail account attribute.
WaitSet WaitSetRequest optionally modifies the wait set and checks for any notifications. If block is set and there are no notificatins, then this API will BLOCK until there is data.

Copyright 2012 Zimbra, Inc. All rights reserved.