{"_id":"56afdf01bc304a0d00ace1f6","githubsync":"","category":{"_id":"56ad4e1cd21f1b0d00fd2f97","pages":["56ad4e3f2a7860170013f71c","56ad512eb9ac5517006b696b","56aea6ac70944b0d00c748ac","56aead360c1cab0d009f65dd","56afdf01bc304a0d00ace1f6","56afe3db1486990d009c0f50","56afe6f1b34d210d003d9bbf","56afe729aef9a21700da0e4f","56b006d33c70b01700facf63"],"version":"569f9cf6650e1d1900f96b5e","__v":9,"project":"569f9cf6650e1d1900f96b5b","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-30T23:58:20.127Z","from_sync":false,"order":4,"slug":"company-methods","title":"Company methods"},"user":"5582e90181672a3900bb4fc7","project":"569f9cf6650e1d1900f96b5b","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"},"__v":14,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-01T22:41:05.000Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"To get a list of all current bulletins, use the [get_company](https://api-opensrs-email.readme.io/v1.0/docs/get_company?bypass=8272e34bb5) method.\"\n}\n[/block]\n## Syntax \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    <credentials object>, \\n    \\\"company\\\": <company_name>, \\n    \\\"bulletin\\\": <bulletin_name>, \\n    \\\"type\\\": auto | manual\\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 get_company_bulletin\"\n}\n[/block]\nThe following fields can be used in the **get_company_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\": \"company\",\n    \"1-1\": \"Required\",\n    \"1-2\": \"The name of the company.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"Required\",\n    \"2-2\": \"Specify 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_company_bulletin](https://api-opensrs-email.readme.io/v1.0/docs/post_company_bulletin-1?bypass=8272e34bb5) ADD LINK method is run.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for get_company_bulletin\"\n}\n[/block]\nThe following fields may be returned in response to the **get_company_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\": \"bulletin_text\",\n    \"0-1\": \"Returned if **success = true**\",\n    \"1-1\": \"Returned if **success = true**\",\n    \"2-1\": \"Returned if **success = true**\",\n    \"0-2\": \"The text of the bulletin.\",\n    \"1-0\": \"error\",\n    \"1-2\": \"A text string that explains the error.\",\n    \"2-0\": \"error_number\",\n    \"2-2\": \"A number that represents the error.\",\n    \"3-0\": \"success\",\n    \"3-1\": \"Always returned\",\n    \"3-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for get_company_bulletin\"\n}\n[/block]\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n    \\\"user\\\": \\\"company_admin:::at:::example.adm\\\",\\n    \\\"password\\\": \\\"sw0rdfish\\\"\\n  },\\n  \\\"company\\\": \\\"Example Corp\\\",\\n  \\\"bulletin\\\": \\\"Fridge\\\",\\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  \\\"bulletin_text\\\": \\\"From: Mister Manager <mrmanager@example.com>\\nSubject: Please empty the fridge!\\nContent-Type: text/plain; charset=us-ascii\\nContent-Disposition: inline\\nDear {'title'} {'name'},\\nPlease empty *all* your items from the kitchen refrigerator *every* Friday. I cannot stress how much of a priority this is.\\nM. Manager \\\" }\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **get_company_bulletin** method retrieves the text of a specified company- level bulletin.","slug":"get_company_bulletin","type":"basic","title":"get_company_bulletin"}

get_company_bulletin

The **get_company_bulletin** method retrieves the text of a specified company- level bulletin.

[block:callout] { "type": "info", "title": "Note:", "body": "To get a list of all current bulletins, use the [get_company](https://api-opensrs-email.readme.io/v1.0/docs/get_company?bypass=8272e34bb5) method." } [/block] ## Syntax [block:code] { "codes": [ { "code": "{\n <credentials object>, \n \"company\": <company_name>, \n \"bulletin\": <bulletin_name>, \n \"type\": auto | manual\n}\n", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for get_company_bulletin" } [/block] The following fields can be used in the **get_company_bulletin** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "bulletin", "0-1": "Required", "0-2": "The name of the bulletin you want to view.", "1-0": "company", "1-1": "Required", "1-2": "The name of the company.", "2-0": "type", "2-1": "Required", "2-2": "Specify 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_company_bulletin](https://api-opensrs-email.readme.io/v1.0/docs/post_company_bulletin-1?bypass=8272e34bb5) ADD LINK method is run." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for get_company_bulletin" } [/block] The following fields may be returned in response to the **get_company_bulletin** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "bulletin_text", "0-1": "Returned if **success = true**", "1-1": "Returned if **success = true**", "2-1": "Returned if **success = true**", "0-2": "The text of the bulletin.", "1-0": "error", "1-2": "A text string that explains the error.", "2-0": "error_number", "2-2": "A number that represents the error.", "3-0": "success", "3-1": "Always returned", "3-2": "Indicates whether the request was successful or not. Allowed values are **true** and **false**." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Examples for get_company_bulletin" } [/block] **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"company_admin@example.adm\",\n \"password\": \"sw0rdfish\"\n },\n \"company\": \"Example Corp\",\n \"bulletin\": \"Fridge\",\n \"type\": \"auto\"\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"bulletin_text\": \"From: Mister Manager <mrmanager@example.com>\nSubject: Please empty the fridge!\nContent-Type: text/plain; charset=us-ascii\nContent-Disposition: inline\nDear {'title'} {'name'},\nPlease empty *all* your items from the kitchen refrigerator *every* Friday. I cannot stress how much of a priority this is.\nM. Manager \" }", "language": "perl", "name": " " } ] } [/block]