You are here

Home » API reference » Simplenews 8

simplenews.schema.yml in Simplenews 8

Same filename and directory in other branches
  1. 8.2 config/schema/simplenews.schema.yml
  2. 3.x config/schema/simplenews.schema.yml
config/schema/simplenews.schema.yml

File

config/schema/simplenews.schema.yml
View source 
  1. # Settings schema.

  2. simplenews.settings:

  3.   type: config_object

  4.   label: 'Simplenews settings'

  5.   mapping:

  6.     hash_expiration:

  7.       type: integer

  8.       label: Hash expiration

  9.     newsletter:

  10.       type: mapping

  11.       label: Newsletter settings

  12.       mapping:

  13.         format:

  14.           type: string

  15.           label: Default format for new newsletters

  16.         priority:

  17.           type: integer

  18.           label: Default priority for new newsletters

  19.         receipt:

  20.           type: boolean

  21.           label: Default require receipt setting for newsletters

  22.         from_address:

  23.           type: string

  24.           label: Default from email address

  25.         from_name:

  26.           type: label

  27.           label: Default from name

  28. 

  29.     subscriber:

  30.       type: mapping

  31.       mapping:

  32.         sync_fields:

  33.           type: boolean

  34.           label: Sync between account and subscriber fields

  35. 

  36.     subscription:

  37.       type: mapping

  38.       label: Subscription settings

  39.       mapping:

  40.         use_combined:

  41.           type: string

  42.           label: Combined setting

  43.         confirm_subscribe_subject:

  44.           type: label

  45.           label: Subscribe confirmation subject

  46.         confirm_subscribe_unsubscribed:

  47.           type: text

  48.           label: Subscribe confirmation message

  49.         confirm_subscribe_subscribed:

  50.           type: text

  51.           label: Already subscribed message

  52.         confirm_unsubscribe_subscribed:

  53.           type: text

  54.           label: Unsubscribe message

  55.         confirm_unsubscribe_unsubscribed:

  56.           type: text

  57.           label: Already Unsubscribe message

  58.         confirm_combined_subject:

  59.           type: label

  60.           label: Combined subscribe subject

  61.         confirm_combined_body:

  62.           type: text

  63.           label: Combined subscribe message

  64.         confirm_combined_body_unchanged:

  65.           type: text

  66.           label: Combined subscribe unchanged message

  67.         confirm_combined_line_subscribe_unsubscribed:

  68.           type: label

  69.           label: Combined subscribe message

  70.         confirm_combined_line_subscribe_subscribed:

  71.           type: label

  72.           label: Combined already subscribed message

  73.         confirm_combined_line_unsubscribe_subscribed:

  74.           type: label

  75.           label: Combined unsubscribe message

  76.         confirm_combined_line_unsubscribe_unsubscribed:

  77.           type: label

  78.           label: Combined already unsubscribed message

  79.         confirm_subscribe_page:

  80.           type: string

  81.           label: Confirmation subscribe redirect page

  82.         confirm_unsubscribe_page:

  83.           type: string

  84.           label: Confirmation unsubscribe redirect page

  85. 

  86.     mail:

  87.       type: mapping

  88.       label: Mail settings

  89.       mapping:

  90.         use_cron:

  91.           type: boolean

  92.           label: Use cron

  93.         throttle:

  94.           type: integer

  95.           label: Mails to send per cron run

  96.         spool_progress_expiration:

  97.           type: integer

  98.           label: Spool in progress expiration

  99.         spool_expire:

  100.           type: integer

  101.           label: Expiration of sent mails in spool

  102.         debug:

  103.           type: boolean

  104.           label: Debug

  105. 

  106. # Newsletter config entity schema.

  107. simplenews.newsletter.*:

  108.   type: config_entity

  109.   label: 'Newsletter'

  110.   mapping:

  111.     name:

  112.       type: label

  113.       label: 'Name'

  114.     id:

  115.       type: string

  116.       label: 'Machine-readable name'

  117.     description:

  118.       type: text

  119.       label: 'Description of the newsletter'

  120.     format:

  121.       type: string

  122.       label: 'HTML or plaintext newsletter indicator'

  123.     priority:

  124.       type: integer

  125.       label: 'Priority indicator'

  126.     receipt:

  127.       type: boolean

  128.       label: 'TRUE if a read receipt should be requested.'

  129.     from_name:

  130.       type: label

  131.       label: 'Name of the email author.'

  132.     subject:

  133.       type: label

  134.       label: 'Subject of newsletter email. May contain tokens.'

  135.     from_address:

  136.       type: string

  137.       label: 'Email author address'

  138.     hyperlinks:

  139.       type: boolean

  140.       label: 'Indicates if hyperlinks should be kept inline or extracted.'

  141.     new_account:

  142.       type: string

  143.       label: 'Indicates how to integrate with the register form.'

  144.     opt_inout:

  145.       type: string

  146.       label: 'Defines the Opt-In/out options.'

  147.     weight:

  148.       type: integer

  149.       label: 'Weight of this newsletter (used for sorting).'

  150. 

  151. field.simplenews_subscription.settings:

  152.   type: mapping

  153.   label: 'Subscription settings'

  154.   mapping:

  155.     target_type:

  156.       type: string

  157.       label: 'Type of item to reference'

  158. 

  159. field.simplenews_subscription.instance_settings:

  160.   type: mapping

  161.   label: 'Subscription settings'

  162.   mapping:

  163.     handler:

  164.       type: string

  165.       label: 'Reference method'

  166.     handler_settings:

  167.       type: entity_reference.[%parent.handler].handler_settings

  168.       label: 'Reference method settings'

  169. 

  170. # Monitoring schema.

  171. monitoring.settings.simplenews_pending:

  172.   type: monitoring.settings_base

  173.   label: 'Simplenews pending sensor settings'

  174.   mapping: { }

  175. 

  176. # Simplenews issue field type schema.

  177. field.storage_settings.simplenews_issue:

  178.   type: field.storage_settings.entity_reference

  179.   label: 'Simplenews issue settings'

  180.   mapping: { }

  181. 

  182. field.field_settings.simplenews_issue:

  183.   type: field.field_settings.entity_reference

  184.   label: 'Simplenews issue settings'

  185. 

  186. field.value.simplenews_issue:

  187.   type: field.value.entity_reference

  188.   label: 'Default value'

  189.   mapping:

  190.     handler:

  191.       type: string

  192.       label: Handler

  193.     handler_settings:

  194.       type: mapping

  195.       label: Handler settings

  196.     status:

  197.       type: integer

  198.       label: Sent status

  199.     sent_count:

  200.       type: integer

  201.       label: Sent count

  202.     subscribers:

  203.       type: integer

  204.       label: Subscriber count

  205. 

  206. # Simplenews suscription field type schema.

  207. field.storage_settings.simplenews_subscription:

  208.   type: field.storage_settings.entity_reference

  209.   label: 'Simplenews subscription settings'

  210.   mapping: { }

  211. 

  212. field.field_settings.simplenews_subscription:

  213.   type: field.field_settings.entity_reference

  214.   label: 'Simplenews subscription settings'

  215. 

  216. field.value.simplenews_subscription:

  217.   type: field.value.entity_reference

  218.   label: 'Default value'

  219.   mapping: { }

  220. 

  221. # Block schema

  222. block.settings.simplenews_subscription_block:

  223.   type: block_settings

  224.   mapping:

  225.     newsletters:

  226.       type: sequence

  227.       label: Newsletters

  228.       sequence:

  229.         type: string

  230.         label: Newsletter ID

  231.     message:

  232.       type: label

  233.       label: Message

  234.     unique_id:

  235.       type: string

  236.       label: Unique ID

  237. 

  238. action.configuration.simplenews_send_action:

  239.   type: action_configuration_default

  240.   label: 'Send selected newsletter issue'

  241. 

  242. action.configuration.simplenews_stop_action:

  243.   type: action_configuration_default

  244.   label: 'Stop selected newsletter issue'