This repository has been archived by the owner on Feb 21, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 174
/
mail_api.json
178 lines (178 loc) · 6.34 KB
/
mail_api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
{
"category": "Public Mail Server Methods",
"methods" :
[
{
"method_name": "mail_store_message",
"description": "Store a message on the mail server.",
"return_type": "void",
"parameters" : [
{
"name" : "owner",
"type" : "address",
"description" : "The address of the message's recipient."
},
{
"name" : "message",
"type" : "message",
"description" : "The message to store."
}
],
"is_const" : false,
"prerequisites" : []
},
{
"method_name": "mail_fetch_inventory",
"description": "Get inventory of all messages belonging to a given address received after a given time.",
"return_type": "mail_inventory",
"parameters" : [
{
"name" : "owner",
"type" : "address",
"description" : "The owner whose message inventory should be retrieved."
},
{
"name" : "start_time",
"type" : "timestamp",
"description" : "No messages received before this time will be returned."
},
{
"name" : "limit",
"type" : "uint32_t",
"description" : "Maximum number of messages to retrieve.",
"default_value" : "1000"
}
],
"is_const" : true,
"prerequisites" : []
},
{
"method_name": "mail_fetch_message",
"description": "Get a specific message from the server.",
"return_type": "message",
"parameters" : [
{
"name" : "inventory_id",
"type" : "message_id",
"description" : "The ID of the message to retrieve."
}
],
"is_const" : true,
"prerequisites" : []
},
{
"method_name": "mail_get_processing_messages",
"description": "Get all messages in the mail client which are still in processing.",
"return_type": "message_status_list",
"parameters" : [],
"is_const" : true,
"prerequisites" : ["json_authenticated"]
},
{
"method_name": "mail_get_archive_messages",
"description": "Get all messages in the mail client which are not in processing (sent and received).",
"return_type": "message_status_list",
"parameters" : [],
"is_const" : true,
"prerequisites" : ["json_authenticated"]
},
{
"method_name": "mail_inbox",
"description": "Get headers of all messages in the inbox.",
"return_type": "message_header_list",
"parameters" : [],
"is_const" : true,
"prerequisites" : ["json_authenticated"],
"aliases" : ["inbox"]
},
{
"method_name": "mail_retry_send",
"description": "Retries sending the specified message.",
"return_type": "void",
"parameters" : [
{
"name" : "message_id",
"type" : "message_id",
"description" : "ID of the failed message to retry sending."
}
],
"prerequisites" : ["json_authenticated"]
},
{
"method_name": "mail_remove_message",
"description": "Removes the message from the local database.",
"return_type": "void",
"parameters" : [
{
"name" : "message_id",
"type" : "message_id",
"description" : "ID of the message to remove."
}
],
"prerequisites" : ["json_authenticated"]
},
{
"method_name": "mail_archive_message",
"description": "Removes the message from the inbox.",
"return_type": "void",
"parameters" : [
{
"name" : "message_id",
"type" : "message_id",
"description" : "ID of the message to archive."
}
],
"prerequisites" : ["json_authenticated"],
"aliases" : ["archive"]
},
{
"method_name": "mail_check_new_messages",
"description": "Check mail server for new mail.",
"return_type": "void",
"parameters" : [],
"prerequisites" : ["json_authenticated","wallet_unlocked"]
},
{
"method_name": "mail_get_message",
"description": "Get a specific message from the client.",
"return_type": "email_record",
"parameters" : [
{
"name" : "message_id",
"type" : "message_id",
"description" : "The ID of the message to retrieve."
}
],
"is_const" : true,
"prerequisites" : ["json_authenticated","wallet_unlocked"]
},
{
"method_name": "mail_send",
"description": "Create a new email, encrypt it, and send it to the recipient's mail server.",
"return_type": "message_id",
"parameters" : [
{
"name" : "from",
"type" : "string",
"description" : "The sender's name."
},
{
"name" : "to",
"type" : "string",
"description" : "The recipient's name."
},
{
"name" : "subject",
"type" : "string",
"description" : "The subject of the email."
},
{
"name" : "body",
"type" : "string",
"description" : "The body of the email."
}
],
"prerequisites" : ["json_authenticated","wallet_unlocked"]
}
]
}