Zimbra REST API Reference:Import Message: Difference between revisions
(New page: << Back to Zimbra REST API Reference == REST API Method: Import Message == Imports a message to a mail folder in MIME RFC822 format. Default (inbox/...) |
Malte Stretz (talk | contribs) No edit summary |
||
(12 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | {{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{devel}}|{{ZCS 8.0}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | |||
== REST API Method: Import Message == | == REST API Method: Import Message == | ||
Line 10: | Line 26: | ||
http://localhost:7070/home/john.doe/{folder-name} | http://localhost:7070/home/john.doe/{folder-name} | ||
</pre> | </pre> | ||
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | |||
=== HTTP Method === | === HTTP Method === | ||
Line 25: | Line 43: | ||
=== Parameters === | === Parameters === | ||
<code> | === Folder Name === | ||
<code>{folder-name}</code>. The name of the mail folder. This can be a default or a user-defined folder. Default folders include: | |||
<ul> | |||
<li><code>inbox</code>. The inbox folder.</li> | |||
<li><code>drafts</code>. The drafts folder.</li> | |||
<li><code>sent</code>. The sent items folder.</li> | |||
<li><code>trash</code>. The trash folder.</li> | |||
<li><code>junk</code>. The junk/spam folder.</li> | |||
</ul> | |||
=== Usage Examples === | === Usage Examples === | ||
Line 31: | Line 59: | ||
The following examples show using the [http://en.wikipedia.org/wiki/CURL curl] utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password. | The following examples show using the [http://en.wikipedia.org/wiki/CURL curl] utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password. | ||
Import | Import the message into the "inbox" folder: | ||
<pre> | <pre> | ||
curl -{username}:{password} --upload-file /tmp/ | curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/inbox | ||
</pre> | </pre> | ||
Import | Import the message into the user-defined "mymessages" folder: | ||
<pre> | <pre> | ||
curl -{username}:{password} --upload-file /tmp/ | curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/mymessages | ||
</pre> | </pre> | ||
{{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | |||
[[Category:REST]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:Developers]] |
Latest revision as of 17:22, 5 August 2014
Article Information |
---|
This article applies to the following ZCS versions. |
<< Back to Zimbra REST API Reference
REST API Method: Import Message
Imports a message to a mail folder in MIME RFC822 format. Default (inbox/sent/trash/junk) and user-defined folders are supported.
URL
http://localhost:7070/home/john.doe/{folder-name}
Go to Command Format
HTTP Method
POST
Formats
N/A
Requires Authentication
true
(Go to Authentication)
Parameters
Folder Name
{folder-name}
. The name of the mail folder. This can be a default or a user-defined folder. Default folders include:
inbox
. The inbox folder.drafts
. The drafts folder.sent
. The sent items folder.trash
. The trash folder.junk
. The junk/spam folder.
Usage Examples
The following examples show using the curl utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password.
Import the message into the "inbox" folder:
curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/inbox
Import the message into the user-defined "mymessages" folder:
curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/mymessages