You are here

Home » API reference » Simplenews 3.x

simplenews.schema.yml in Simplenews 3.x

Same filename and directory in other branches
  1. 8.2 config/schema/simplenews.schema.yml
  2. 8 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.         skip_verification:

  41.           type: boolean

  42.           label: Skip verification for anonymous users

  43.         tidy_unconfirmed:

  44.           type: integer

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

  46.         confirm_combined_subject:

  47.           type: label

  48.           label: Combined subscribe subject

  49.         confirm_combined_body:

  50.           type: text

  51.           label: Combined subscribe message

  52.         confirm_combined_body_unchanged:

  53.           type: text

  54.           label: Combined subscribe unchanged message

  55.         confirm_subscribe_page:

  56.           type: string

  57.           label: Confirmation subscribe redirect page

  58.         confirm_unsubscribe_page:

  59.           type: string

  60.           label: Confirmation unsubscribe redirect page

  61.         validate_subject:

  62.           type: label

  63.           label: Validate subject

  64.         validate_body:

  65.           type: text

  66.           label: Validate message

  67. 

  68.     mail:

  69.       type: mapping

  70.       label: Mail settings

  71.       mapping:

  72.         use_cron:

  73.           type: boolean

  74.           label: Use cron

  75.         textalt:

  76.           type: boolean

  77.           label: Generate plain-text alternative

  78.         throttle:

  79.           type: integer

  80.           label: Mails to send per cron run

  81.         spool_progress_expiration:

  82.           type: integer

  83.           label: Spool in progress expiration

  84.         spool_expire:

  85.           type: integer

  86.           label: Expiration of sent mails in spool

  87.         debug:

  88.           type: boolean

  89.           label: Debug

  90. 

  91. # Newsletter config entity schema.

  92. simplenews.newsletter.*:

  93.   type: config_entity

  94.   label: 'Newsletter'

  95.   mapping:

  96.     name:

  97.       type: label

  98.       label: 'Name'

  99.     id:

  100.       type: string

  101.       label: 'Machine-readable name'

  102.     description:

  103.       type: text

  104.       label: 'Description of the newsletter'

  105.     format:

  106.       type: string

  107.       label: 'HTML or plaintext newsletter indicator'

  108.     priority:

  109.       type: integer

  110.       label: 'Priority indicator'

  111.     receipt:

  112.       type: boolean

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

  114.     from_name:

  115.       type: label

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

  117.     subject:

  118.       type: label

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

  120.     from_address:

  121.       type: string

  122.       label: 'Email author address'

  123.     hyperlinks:

  124.       type: boolean

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

  126.     allowed_handlers:

  127.       type: sequence

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

  129.       sequence:

  130.         type: string

  131.         label: Allowed recipient handler

  132.     new_account:

  133.       type: string

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

  135.     access:

  136.       type: string

  137.       label: 'Controls access to subscribe and unsubscribe.'

  138.     weight:

  139.       type: integer

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

  141. 

  142. field.simplenews_subscription.settings:

  143.   type: mapping

  144.   label: 'Subscription settings'

  145.   mapping:

  146.     target_type:

  147.       type: string

  148.       label: 'Type of item to reference'

  149. 

  150. field.simplenews_subscription.instance_settings:

  151.   type: mapping

  152.   label: 'Subscription settings'

  153.   mapping:

  154.     handler:

  155.       type: string

  156.       label: 'Reference method'

  157.     handler_settings:

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

  159.       label: 'Reference method settings'

  160. 

  161. # Monitoring schema.

  162. monitoring.settings.simplenews_pending:

  163.   type: monitoring.settings_base

  164.   label: 'Simplenews pending sensor settings'

  165.   mapping: { }

  166. 

  167. # Simplenews issue field type schema.

  168. field.storage_settings.simplenews_issue:

  169.   type: field.storage_settings.entity_reference

  170.   label: 'Simplenews issue settings'

  171.   mapping: { }

  172. 

  173. field.field_settings.simplenews_issue:

  174.   type: field.field_settings.entity_reference

  175.   label: 'Simplenews issue settings'

  176. 

  177. field.value.simplenews_issue:

  178.   type: field.value.entity_reference

  179.   label: 'Default value'

  180.   mapping:

  181.     handler:

  182.       type: string

  183.       label: Handler

  184.     handler_settings:

  185.       type: mapping

  186.       label: Handler settings

  187.     status:

  188.       type: integer

  189.       label: Sent status

  190.     sent_count:

  191.       type: integer

  192.       label: Sent count

  193.     error_count:

  194.       type: integer

  195.       label: Error count

  196.     subscribers:

  197.       type: integer

  198.       label: Subscriber count

  199. 

  200. # Simplenews suscription field type schema.

  201. field.storage_settings.simplenews_subscription:

  202.   type: field.storage_settings.entity_reference

  203.   label: 'Simplenews subscription settings'

  204.   mapping: { }

  205. 

  206. field.field_settings.simplenews_subscription:

  207.   type: field.field_settings.entity_reference

  208.   label: 'Simplenews subscription settings'

  209. 

  210. field.value.simplenews_subscription:

  211.   type: field.value.entity_reference

  212.   label: 'Default value'

  213.   mapping: { }

  214. 

  215. # Block schema

  216. block.settings.simplenews_subscription_block:

  217.   type: block_settings

  218.   mapping:

  219.     newsletters:

  220.       type: sequence

  221.       label: Newsletters

  222.       sequence:

  223.         type: string

  224.         label: Newsletter ID

  225.     message:

  226.       type: label

  227.       label: Message

  228.     unique_id:

  229.       type: string

  230.       label: Unique ID

  231. 

  232. action.configuration.simplenews_send_action:

  233.   type: action_configuration_default

  234.   label: 'Send selected newsletter issue'

  235. 

  236. action.configuration.simplenews_stop_action:

  237.   type: action_configuration_default

  238.   label: 'Stop selected newsletter issue'