{"_id":"56b22157a5a1020d00cf4c60","version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"56b00ad88f7a4f0d0029dc92","version":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":10,"pages":["56b00b4d3c70b01700facf68","56b00b9d3c70b01700facf6a","56b016f43a5b810d00745dca","56b0e8cabf040b0d00588a96","56b0ef73135ec20d00baf9b8","56b21ce83b6f690d00bdb6b6","56b21ea99621f20d00efb273","56b22157a5a1020d00cf4c60","56b224b29621f20d00efb287","56b226677ae4550d00062954"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-02T01:48:08.558Z","from_sync":false,"order":5,"slug":"domain-methods","title":"Domain methods"},"__v":14,"githubsync":"","user":"5582e90181672a3900bb4fc7","project":"569f9cf6650e1d1900f96b5b","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T15:48:39.449Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"To get a list of all current bulletins, use the [get_domain](https://api-opensrs-email.readme.io/v1.0/docs/get_domain?bypass=8272e34bb5) method.\",\n \"title\": \"Note:\"\n}\n[/block]\n## Syntax \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n <credentials object>, \\n \\\"domain\\\": <domain_name>, \\n \\\"bulletin\\\": <bulletin_name>,\\n \\\"type\\\": auto | manual, \\n \\\"test_email\\\": <email_address> \\n },\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Request fields for post_domain_bulletin\"\n}\n[/block]\nThe following fields can be used in the **post_domain_bulletin** method:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field name\",\n \"h-1\": \"Obligation\",\n \"h-2\": \"Definition/Value\",\n \"0-0\": \"bulletin\",\n \"0-1\": \"Required\",\n \"0-2\": \"The name of the bulletin you want to view.\",\n \"1-0\": \"domain\",\n \"1-1\": \"Required\",\n \"1-2\": \"The name of the domain.\",\n \"2-0\": \"test_email\",\n \"2-1\": \"Optional\",\n \"2-2\": \"Send the bulletin to only the specified email address. If not specified, the bulletin is sent to all mailboxes in the domain.\",\n \"3-0\": \"type\",\n \"3-1\": \"Required\",\n \"3-2\": \"The bulletin type. Allowed values are:\\n\\n * **auto** — The bulletin is automatically sent to new users when their accounts are created.\\n\\n * **manual** — The bulletin is sent only when the **post_domain_bulletin** method is run.\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Response fields for post_domain_bulletin\"\n}\n[/block]\nThe following fields may be returned in response to the **post_domain_bulletin** method:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field name\",\n \"h-1\": \"Obligation\",\n \"h-2\": \"Description/Value\",\n \"0-0\": \"error\",\n \"0-1\": \"Returned if **success = false**\",\n \"0-2\": \"A text string that explains the error.\",\n \"1-0\": \"error_number\",\n \"1-1\": \"Returned if **success = false**\",\n \"1-2\": \"A number that represents the error.\",\n \"2-0\": \"success\",\n \"2-1\": \"Always returned\",\n \"2-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\"\n },\n \"cols\": 3,\n \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Examples for post_domain_bulletin\"\n}\n[/block]\n## Example 1\n\nSends a bulletin to just mrmanager:::at:::example.com.\n\n**Request** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"credentials\\\": {\\n \\\"user\\\": \\\"domain_admin@example.com\\\",\\n \\\"password\\\": \\\"sw0rdfish\\\"\\n },\\n \\\"domain\\\": \\\"example.com\\\",\\n \\\"bulletin\\\": \\\"Welcome Message\\\", \\n \\\"type\\\": \\\"autol\\\"\\n \\\"test_email\\\": \\\"mrmanager@example.com\\\"\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n**Response** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"success\\\": true\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n## Example 2\n\nSends a bulletin to all users in the domain example.com.\n\n**Request** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n credentials\\\": {\\n user\\\": \\\"domain_admin@example.com\\\",\\n password\\\": \\\"pencil75\\\"\\n },\\n \\\"domain\\\": \\\"example.com\\\",\\n \\\"bulletin\\\": \\\"Welcome Message\\\",\\n \\\"type\\\": \\\"auto\\\"\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n**Response** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"success\\\": true\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]","excerpt":"The **post_domain_bulletin** method sends a specified bulletin to all users in a domain.","slug":"post_domain_bulletin","type":"basic","title":"post_domain_bulletin"}
post_domain_bulletin
The **post_domain_bulletin** method sends a specified bulletin to all users in a domain.