You are here

Home » API reference » Simplenews 8.2

simplenews.schema.yml in Simplenews 8.2

Same filename and directory in other branches
  1. 8 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.         tidy_unconfirmed:

  41.           type: integer

  42.           label: Tidy unconfirmed subscriptions after a number of days

  43.         use_combined:

  44.           type: string

  45.           label: Combined setting

  46.         confirm_subscribe_subject:

  47.           type: label

  48.           label: Subscribe confirmation subject

  49.         confirm_subscribe_unsubscribed:

  50.           type: text

  51.           label: Subscribe confirmation message

  52.         confirm_subscribe_subscribed:

  53.           type: text

  54.           label: Already subscribed message

  55.         confirm_unsubscribe_subscribed:

  56.           type: text

  57.           label: Unsubscribe message

  58.         confirm_unsubscribe_unsubscribed:

  59.           type: text

  60.           label: Already Unsubscribe message

  61.         confirm_combined_subject:

  62.           type: label

  63.           label: Combined subscribe subject

  64.         confirm_combined_body:

  65.           type: text

  66.           label: Combined subscribe message

  67.         confirm_combined_body_unchanged:

  68.           type: text

  69.           label: Combined subscribe unchanged message

  70.         confirm_combined_line_subscribe_unsubscribed:

  71.           type: label

  72.           label: Combined subscribe message

  73.         confirm_combined_line_subscribe_subscribed:

  74.           type: label

  75.           label: Combined already subscribed message

  76.         confirm_combined_line_unsubscribe_subscribed:

  77.           type: label

  78.           label: Combined unsubscribe message

  79.         confirm_combined_line_unsubscribe_unsubscribed:

  80.           type: label

  81.           label: Combined already unsubscribed message

  82.         confirm_subscribe_page:

  83.           type: string

  84.           label: Confirmation subscribe redirect page

  85.         confirm_unsubscribe_page:

  86.           type: string

  87.           label: Confirmation unsubscribe redirect page

  88. 

  89.     mail:

  90.       type: mapping

  91.       label: Mail settings

  92.       mapping:

  93.         use_cron:

  94.           type: boolean

  95.           label: Use cron

  96.         throttle:

  97.           type: integer

  98.           label: Mails to send per cron run

  99.         spool_progress_expiration:

  100.           type: integer

  101.           label: Spool in progress expiration

  102.         spool_expire:

  103.           type: integer

  104.           label: Expiration of sent mails in spool

  105.         debug:

  106.           type: boolean

  107.           label: Debug

  108. 

  109. # Newsletter config entity schema.

  110. simplenews.newsletter.*:

  111.   type: config_entity

  112.   label: 'Newsletter'

  113.   mapping:

  114.     name:

  115.       type: label

  116.       label: 'Name'

  117.     id:

  118.       type: string

  119.       label: 'Machine-readable name'

  120.     description:

  121.       type: text

  122.       label: 'Description of the newsletter'

  123.     format:

  124.       type: string

  125.       label: 'HTML or plaintext newsletter indicator'

  126.     priority:

  127.       type: integer

  128.       label: 'Priority indicator'

  129.     receipt:

  130.       type: boolean

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

  132.     from_name:

  133.       type: label

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

  135.     subject:

  136.       type: label

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

  138.     from_address:

  139.       type: string

  140.       label: 'Email author address'

  141.     hyperlinks:

  142.       type: boolean

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

  144.     allowed_handlers:

  145.       type: sequence

  146.       label: 'Restricts which recipient handlers are allowed.'

  147.       sequence:

  148.         type: string

  149.         label: Allowed recipient handler

  150.     new_account:

  151.       type: string

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

  153.     opt_inout:

  154.       type: string

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

  156.     weight:

  157.       type: integer

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

  159. 

  160. field.simplenews_subscription.settings:

  161.   type: mapping

  162.   label: 'Subscription settings'

  163.   mapping:

  164.     target_type:

  165.       type: string

  166.       label: 'Type of item to reference'

  167. 

  168. field.simplenews_subscription.instance_settings:

  169.   type: mapping

  170.   label: 'Subscription settings'

  171.   mapping:

  172.     handler:

  173.       type: string

  174.       label: 'Reference method'

  175.     handler_settings:

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

  177.       label: 'Reference method settings'

  178. 

  179. # Monitoring schema.

  180. monitoring.settings.simplenews_pending:

  181.   type: monitoring.settings_base

  182.   label: 'Simplenews pending sensor settings'

  183.   mapping: { }

  184. 

  185. # Simplenews issue field type schema.

  186. field.storage_settings.simplenews_issue:

  187.   type: field.storage_settings.entity_reference

  188.   label: 'Simplenews issue settings'

  189.   mapping: { }

  190. 

  191. field.field_settings.simplenews_issue:

  192.   type: field.field_settings.entity_reference

  193.   label: 'Simplenews issue settings'

  194. 

  195. field.value.simplenews_issue:

  196.   type: field.value.entity_reference

  197.   label: 'Default value'

  198.   mapping:

  199.     handler:

  200.       type: string

  201.       label: Handler

  202.     handler_settings:

  203.       type: mapping

  204.       label: Handler settings

  205.     status:

  206.       type: integer

  207.       label: Sent status

  208.     sent_count:

  209.       type: integer

  210.       label: Sent count

  211.     error_count:

  212.       type: integer

  213.       label: Error count

  214.     subscribers:

  215.       type: integer

  216.       label: Subscriber count

  217. 

  218. # Simplenews suscription field type schema.

  219. field.storage_settings.simplenews_subscription:

  220.   type: field.storage_settings.entity_reference

  221.   label: 'Simplenews subscription settings'

  222.   mapping: { }

  223. 

  224. field.field_settings.simplenews_subscription:

  225.   type: field.field_settings.entity_reference

  226.   label: 'Simplenews subscription settings'

  227. 

  228. field.value.simplenews_subscription:

  229.   type: field.value.entity_reference

  230.   label: 'Default value'

  231.   mapping: { }

  232. 

  233. # Block schema

  234. block.settings.simplenews_subscription_block:

  235.   type: block_settings

  236.   mapping:

  237.     newsletters:

  238.       type: sequence

  239.       label: Newsletters

  240.       sequence:

  241.         type: string

  242.         label: Newsletter ID

  243.     message:

  244.       type: label

  245.       label: Message

  246.     unique_id:

  247.       type: string

  248.       label: Unique ID

  249. 

  250. action.configuration.simplenews_send_action:

  251.   type: action_configuration_default

  252.   label: 'Send selected newsletter issue'

  253. 

  254. action.configuration.simplenews_stop_action:

  255.   type: action_configuration_default

  256.   label: 'Stop selected newsletter issue'