{ "variables": [], "info": { "name": "SpectreMail API", "_postman_id": "9c3c8b4d-24bd-4e9a-b518-ddda6023401d", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json" }, "item": [{ "name": "Domain Manager", "description": "", "item": [{ "name": "Get Public Domains\n\nThis request will return an array of public domains", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/domains", "query": [] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get Your Private Domains\n\nThis request will return: 1- An array of objects where each one contains your domain information. 2- An array of domains", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/domains\/private\/:array", "query": [] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Add Private Domains\n\nThis request will add your private domain to your account so you can create mails and you will be able to send messages from these mails", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/domains\/private\/add", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain_name\": \"et\"\n}" }, "description": "", "response": [] } }, { "name": "Remove Private Domains\n\nThis request will remove your private domain with all its mails and messages", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/domains\/private\/remove", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain_name\": \"expedita\"\n}" }, "description": "", "response": [] } }, { "name": "Refresh Private Domains\n\nThis request will check if your private domain is pointing to our server and return the status of the private domain.", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/domains\/private\/refresh", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain_name\": \"animi\"\n}" }, "description": "", "response": [] } } ] }, { "name": "Mail Manager", "description": "", "item": [{ "name": "Get All Accounts\n\nThis request will return all mails accounts", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/accounts\/all", "query": [] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get Domain Mails Accounts\n\nThis request will return all mails accounts belonging to a specific domain", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/accounts\/:domain\/all", "query": [], "variable": [{ "id": "domain", "key": "domain", "value": "4", "description": "The domain which you want to get its mails accounts" }] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get Mail By Token\n\nThis request will return the mail assigned with the given token with latest received messages.", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/token\/:mailToken", "query": [] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get a Specific Mail Account\n\nThis request will return a specific mail account info", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/:domain\/:name", "query": [], "variable": [{ "id": "domain", "key": "domain", "value": "14", "description": "The domain of the account you want to get its info" }, { "id": "name", "key": "name", "value": "11", "description": "The name of the account you want to get its info" } ] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Activate\/Deactivate Forwarding\n\nThis request will activate or deactivate forwarding on specific mail.", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/forward", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"activate\": true,\n \"from\": \"natus\",\n \"to\": \"mollitia\"\n}" }, "description": "", "response": [] } }, { "name": "Change Mail Password\n\nThis request will change your mail password.", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/password", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"vero\",\n \"password\": \"eaque\"\n}" }, "description": "", "response": [] } }, { "name": "Create a New Mail Account\n\nThis request create a new mail account and return new mail info", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/add", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"rem\",\n \"name\": \"nam\",\n \"duration\": \"consequuntur\"\n}" }, "description": "", "response": [] } }, { "name": "Create a New Mutiple Mails Accounts\n\nThis request will create mutiple new mails accounts and return the mails info", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/add\/multiple", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"number\": 4,\n \"name_length\": 6,\n \"domain\": \"non\",\n \"duration\": \"vitae\"\n}" }, "description": "", "response": [] } }, { "name": "Drop Mail Account\n\nThis request will delete a specified mail account", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/drop", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"error\",\n \"name\": \"cumque\"\n}" }, "description": "", "response": [] } }, { "name": "Drop Mails Accounts\n\nThis request will delete a group of selected mails accounts", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/drop\/multiple", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"enim\",\n \"names\": []\n}" }, "description": "", "response": [] } } ] }, { "name": "Message Manager", "description": "", "item": [{ "name": "Refresh Inbox\n\nThis request will check your inbox to search only for new messages, and return the number of new messages", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/:domain\/:name\/inbox\/refresh", "query": [], "variable": [{ "id": "domain", "key": "domain", "value": "6", "description": "The domain of the mail account which the inbox you want to refresh belongs to" }, { "id": "name", "key": "name", "value": "11", "description": "The name of the mail account which the inbox you want to refresh belongs to" } ] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get Messages\n\nThis request will return a group of messages. You can choose to return all, read or unread messages, then you can choose an action to apply to these messages, such as marking them as read, unread or delete them", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/:domain\/:name\/inbox\/messages\/:tag\/:action", "query": [], "variable": [{ "id": "domain", "key": "domain", "value": "11", "description": "The domain of the mail account which the messages you want to get belong to" }, { "id": "name", "key": "name", "value": "6", "description": "The name of the mail account which the messages you want to get belong to" } ] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Get a Message\n\nThis request will return a specific message by message id, then you can choose an action to apply to this message, such as marking the message as read, unread, delete or send it to a new email address", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/account\/:domain\/:name\/inbox\/message\/:msgID\/:action\/:sendTo", "query": [], "variable": [{ "id": "domain", "key": "domain", "value": "20", "description": "The domain of the mail account which the message you want to get belongs to" }, { "id": "name", "key": "name", "value": "2", "description": "The name of the mail account which the message you want to get belongs to" }, { "id": "msgID", "key": "msgID", "value": "18", "description": "The id of the message you want to get. The id must be in the following form \"msg-{id}\" where id the message number you get from the previous requests" } ] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "", "response": [] } }, { "name": "Send Custom Message\n\nOnly available for private domains. This request will send a new message to a choosen email address. You can send to up 100 recipients and you can send attachments too.", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/message\/send", "query": [] }, "method": "POST", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "{\n \"send_to\": [],\n \"subject\": \"magni\",\n \"from_name\": \"nulla\",\n \"from_email\": \"aut\",\n \"message\": \"et\",\n \"attachments\": []\n}" }, "description": "", "response": [] } } ] }, { "name": "User Data", "description": "\nAPIs for managing token and getting general info", "item": [{ "name": "Get Your Requests", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/requests\/:total", "query": [], "variable": [{ "id": "total", "key": "total", "value": "autem", "description": "Use the parameter total = \"total\" to get the total remaning requests in your package, or total = \"today\" to get the total requests you have sent today. For ex: api\/requests\/total or api\/requests\/today" }] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Get the number of your requests.", "response": [] } }, { "name": "Get Your Sent Messages Number", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/messages\/sent\/:total", "query": [], "variable": [{ "id": "total", "key": "total", "value": "tempore", "description": "Use the parameter total = \"total\" to get the total messages you have sent since your registeration, or total = \"today\" to get the total messages you have sent today. . For ex: api\/messages\/sent\/total or api\/messages\/sent\/today" }] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Get the number of the messages you have sent.", "response": [] } }, { "name": "Get Your Received Messages Number", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/messages\/received\/:total", "query": [], "variable": [{ "id": "total", "key": "total", "value": "itaque", "description": "Use the parameter total = \"total\" to get the total messages you have received since your registeration, or total = \"today\" to get the total messages you have received today. For ex: api\/messages\/received\/total or api\/messages\/received\/today" }] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Get the number of the messages you have received.", "response": [] } }, { "name": "Get Mails Number", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/mails\/created\/:total", "query": [], "variable": [{ "id": "total", "key": "total", "value": "officiis", "description": "Use the parameter total = \"total\" to get the total mails you have created since your registeration, or total = \"today\" to get the total mails you have created today. For ex: api\/mails\/created\/total or api\/mails\/created\/today" }] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Get the number of the mails you have created.", "response": [] } }, { "name": "Refresh Your Token", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/token\/new", "query": [] }, "method": "GET", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "This request will remove your current token and create a new one", "response": [] } }, { "name": "Remove Your Token", "request": { "url": { "protocol": "https", "host": "www.spectremail.com", "path": "api\/token", "query": [] }, "method": "DELETE", "header": [{ "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Bearer {API Token}" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "This request will remove your current token without creating a new one", "response": [] } } ] } ] }